aYOUne
← Affiliate API

ProductBanners

Singular: ProductBanner — Base URL: https://affiliate-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65e07d7d11cb6213d99d0647",
    "type": "1",
    "title": "Vergib einen Titel",
    "background_color": "#FFFFFF",
    "description_background_color": "#FFFFFF",
    "description_background_opacity": 1,
    "border_color": "#000000",
    "border_radius": 0,
    "show_border": 0,
    "font_color": "#000000",
    "button_color": "#FF0000",
    "button_txt": "zum Produkt",
    "font_size": 10,
    "font_type": "Arial",
    "width": 350,
    "height": 300,
    "moneysign": "€",
    "product": "-,-",
    "override": 1,
    "locale": "de_DE",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:50:05.786Z",
    "updatedAt": "2024-02-29T12:50:05.786Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://affiliate-api.ayoune.app/productbanners/65e07d7d11cb6213d99d0647",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "debugId": "6a62dbf5138b05b510db261d",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PRODUCTBANNER",
        "href": "https://api.ayoune.app/affiliate/productbanners/65e07d7d11cb6213d99d0647/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PRODUCTBANNER",
        "href": "https://api.ayoune.app/affiliate/productbanners/65e07d7d11cb6213d99d0647/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.5.1",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2384",
      "reset": "1784867314",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 85.144499,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /productbanners List with filters/pagination affiliate.productbanners.view
GET /productbanners/:id Single record affiliate.productbanners.view
POST /productbanners Create new record affiliate.productbanners.new
PUT /productbanners Update record affiliate.productbanners.edit
DELETE /productbanners/:id Delete record affiliate.productbanners.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.affiliate.productBanners.find().limit(10).exec();

// Single record
const one = await ay.affiliate.productBanners.findById('OBJECT_ID').exec();

// Create
const created = await ay.affiliate.productBanners.create({ name: 'Foo' });

See also