POST Create Compass Offline Export Task
Create Compass Offline Export Task Shop Required scope: seller.affiliate_collaboration.read Create an asynchronous offline export task for the specified doc_type and plan_type within a given time window. Returns a task_id for subsequent status query and file download. Version 202603
POST/affiliate_seller/202603/compass/offline_task
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. |
| 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 |
|---|---|---|
| module_type | string | Allowed values: CREATOR, BASE. |
| window_type | string | Time window type. Allowed values: PAST_24H, PAST_7_DAYS, PAST_30_DAYS. |
| end_day | int | End date in the local timezone of the specified region, formatted as YYYYMMDD. - id：UTC+7 - my：UTC+8 - sg：UTC+8 - vn：UTC+7 - th：UTC+7 - ph：UTC+8 - sa：UTC+3 - us：UTC-8 - mx：UTC-6 - br：UTC-3 - jp：UTC+9 - gb：UTC+0 - ie：UTC+0 - es：UTC+1 - de：UTC+1 - fr：UTC+1 - it：UTC+1 - pl：UTC+1 - nl：UTC+1 - be：UTC+1 - cz：UTC+1 - at：UTC+1 - gr：UTC+2 - pt：UTC+0 - hu：UTC+1 |
| plan_type | string | Plan type. Allowed values: ALL, TARGET, OPEN, PARTNER. |
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