Skip to main content

POST Search Creator Affiliate Orders

Search Creator Affiliate Orders Creator Required scope: creator.affiliate_collaboration.read Search Creator Affiliate Orders This API allows the partner to retrieve a list of affiliate orders generated by a creator, returning the order ID and the product ID. Using this, the partner can track their affiliate-conversions on behalf of a creator, using the order ID. Version 202410

POST/affiliate_creator/202410/orders/search

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe creator access_token value from Get Access Token, when user_type = 1. Follow this guide to get creator access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
page_tokenstringAn 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 RequiredintThe number of results to be returned per page. Default: 20Valid Range: [1-100]

Body

PropertiesTypeDescription
create_time_geintFilter 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.
create_time_ltintFilter 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.

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific 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