Skip to main content

Fetch Orders

This API is used to retrieve the list of orders made by customers through Shortlinks generated by affiliate user.

/api/affiliate/order/orders​

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.

  • itemId
    Product item id

  • orderStatus Order Status. One of UNPAID, PENDING, PAID, COMPLETED, CANCELLED

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

  • productName Search by product name.

  • purchaseTimeStart Purchase start time, the format is 'yyyy-MM-dd HH:mm:ss'

  • purchaseTimeEnd Purchase end time, the format is 'yyyy-MM-dd HH:mm:ss'

Response​

{
  "data": {
    "current": 0,
    "pages": 0,
    "records": [
      {
        "actualAmount": "string",
        "buyerType": {
          "code": "string"
        },
        "clickTime": "2024-04-16T10:45:00.086Z",
        "completeTime": "2024-04-16T10:45:00.086Z",
        "conversionId": 0,
        "createTime": "2024-04-16T10:45:00.086Z",
        "creator": "string",
        "currencyCode": "string",
        "currencySymbol": "string",
        "deleted": false,
        "displayName": "string",
        "editTime": "2024-04-16T10:45:00.086Z",
        "editor": "string",
        "id": "string",
        "influencerCommission": 0,
        "influencerId": "string",
        "itemId": "string",
        "itemName": "string",
        "itemPrice": "string",
        "itemSellerCommission": "string",
        "itemSellerCommissionRate": "string",
        "itemShopeeCommissionCapped": "string",
        "itemShopeeCommissionRate": "string",
        "itemTotalCommission": "string",
        "mcnId": "string",
        "modelId": 0,
        "orderId": "string",
        "orderStatus": {
          "code": "string"
        },
        "platformType": {
          "code": "string",
          "value": "string"
        },
        "productName": "string",
        "purchaseTime": "2024-04-16T10:45:00.086Z",
        "qty": 0,
        "rebateStatus": {
          "code": "string",
          "value": "string"
        },
        "referrer": "string",
        "usdInfluencerCommission": 0,
        "userId": "string"
      }
    ],
    "size": 0,
    "total": 0
  },
  "message": "string",
  "params": [
    {}
  ],
  "requestId": "string",
  "status": 0
}