POST Search CAP Affiliate Orders
Search CAP Affiliate Orders Asset Required scope: Search the list of affiliate orders of the specified date range from a MCN or known as CAP - Creator Agency partner Version 202603
POST/affiliate_partner/202603/cap_order/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The partner access_token value from Get Access Token, when user_type = 3. Follow this guide to get partner 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 | The next page token |
| page_size Required | int | The default is 20, it must be positive integer, the range is 1-100 |
| category_asset_cipher Required | string | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
Body
| Properties | Type | Description |
|---|---|---|
| order_id | string | Transaction main order ID |
| product_id | string | Unique identifier for Product |
| settle_status | int | Settlement Status of the order.Possible values:1. "CUSTOMER UNPAID", customer hasn't paid for the orders.2. "PENDING", customers can still return or get a refund for this order. The earnings shown are estimates and waiting for settlement.3. "SETTLED", your earnings have already settled to your account4. "INELIGIBLE", The order has been returned/refunded/canceled by the buyer, and no commission will be settled.5. "FROZEN", Possible fraud has been detected regarding the order. The commission will be unfrozen after the fraud is resolved. |
| create_time_ge | int | Filter orders to show only those that are created on or after the specified date and time. Unix timestamp.Please note that we only support 3 months' data at maximum for each single request.Note:create_time_ge and create_time_lt together constitute the creation time filter condition.create_time_ge and create_time_lt must be provided together. If both are not specified, data from the last three months will be queried by default. |
| create_time_lt | int | Unix timestamp representing the end of transactions time range one wants to request |
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 | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext