Skip to main content

Fetch Promotion Products

This API is used to retrieve all promotional products launched by Thinla Affiliate. You can use this API to obtain detailed information about promotional products, including commission rates, product prices, and whether they have ShortLinks.

/api/affiliate/promotion/products​

Method: GET​

Parameters​

  • current
    Current Page: Specifies which page of data to retrieve.

  • size
    Records per Page: Specifies the number of records to be returned per page.

  • country
    The promotion country. The country consist by 2 letter like "US", "CN"

  • minDuration Minimum duration of the promotion period, in milliseconds. For example, to retrieve promotional products with a minimum promotion period of at least one week, you would pass 10006060247.

  • platformType One of shopee, shopify, thinla, shenlan and shoplazza

  • productName Search by product name.

  • promotionStatus Promotion Status. One of Participating, End

  • promotionType Promotion type. The parameter will impact sort of records. One of HighestCommission, TopPerforming

Response​

{
  "data": {
    "current": 0,
    "pages": 0,
    "records": [
      {
        "active": false,
        "archivedId": "string",
        "categories": "string",
        "categoryId": "string",
        "commission": "string",
        "commissionRate": "string",
        "country": "string",
        "createTime": "2024-04-16T09:51:43.618Z",
        "creator": "string",
        "currencyCode": "string",
        "currencySymbol": "string",
        "deleted": false,
        "discountCode": "string",
        "editTime": "2024-04-16T09:51:43.618Z",
        "editor": "string",
        "id": "string",
        "imageUrl": "string",
        "influencerIds": "string",
        "isArchived": false,
        "isExpired": false,
        "isHidden": false,
        "isUnableToPromote": false,
        "marketingInformation": "string",
        "medias": "string",
        "periodEndTime": "2024-04-16T09:51:43.618Z",
        "periodStartTime": "2024-04-16T09:51:43.618Z",
        "platformType": {
          "code": "string",
          "value": "string"
        },
        "price": "string",
        "productLink": "string",
        "productName": "string",
        "sales": 0,
        "shopName": "string",
        "shortLinks": "string",
        "sortNumber": 0,
        "tags": "string",
        "totalCommissionRate": "string"
      }
    ],
    "size": 0,
    "total": 0
  },
  "message": "string",
  "params": [
    {}
  ],
  "requestId": "string",
  "status": 0
}