POST Search Seller Affiliate Orders
Search Seller Affiliate Orders Shop Required scope: seller.affiliate_collaboration.read This API allows the partner to retrieve a list of affiliate orders (orders which are affiliate-commission eligible) generated by a seller, returning the order ID and the product ID. Using this, the partner can track their affiliate-conversions on behalf of a seller, using the order ID.
Version 202410
POST/affiliate_seller/202410/orders/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_token | string | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| page_size Required | int | The number of results to be returned per page. Default: 20Valid Range: [1-100] |
| shop_cipher Required | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Body
| Properties | Type | Description |
|---|---|---|
| create_time_lt | int | Filter orders to show only those that are created before the specified date and time. Unix timestamp.Refer to notes in create_time_ge for more usage information. Please note that we only support 3 montns' data at maximum for each single request |
| create_time_ge | int | Filter orders to show only those that are created on or after the specified date and time. Unix timestamp.Note:create_time_ge and create_time_lt together constitute the creation time filter condition.- If create_time_ge is filled but create_time_lt is empty, create_time_lt will default to the current time.- If create_time_lt is filled but create_time_ge is empty, create_time_ge will default to the earliest shop time.If both are not specified, data from the last three months will be queried by default. |
| program_id | string | Filter orders by the associated affiliate program which refer to your agency partner's campaign ID. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | Empty. No business logic error codes. |
Is this content helpful?Helpful
Not Helpful
PreviousNext