Get Compass Task List｜快工助手

资料正文

§1 Path: /affiliate_seller/202603/compass/offline_tasks

§2 Method: [GET]

§3 Function Description

Retrieve the list of export tasks created via Open API for the authorized seller (last 7 days). Supports pagination and returns task status, file_name and timestamps.

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties	Location	Type	Require	Sample	Properties description
shop_cipher	query	string	Y	GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3	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
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Query Parameters

Properties	Type	Require	Sample	Properties description
app_key	string	Y	38abcd	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Y	5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Y	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
doc_type	string	Y	VIDEO	Allowed values: CREATOR, BASE.

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202603/compass/offline_tasks?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&doc_type=VIDEO

§7 Response Parameters

Properties	Type	Sample	Properties description
code	int	0	The success or failure status code returned in API response.
message	string	Success	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	202203070749000101890810281E8C70B7	Request log
data	object		Specific return information
^tasks	[]object		The list of the task
^^module_type	string	BASE	Allowed values: CREATOR, BASE.
^^id	string	1234	The id of the task
^^file_name	string	Transaction_Analysis_Core_Metrics_20240301-20240331	the name of the final download file.
^^status	string	RUNNING	The status of the task.

RUNNING
SUCCEEDED
FAILED |

§8 Response Sample

{"code":0,"data":{"tasks":[{"module_type":"BASE","id":"1234","file_name":"Transaction_Analysis_Core_Metrics_20240301-20240331","status":"RUNNING"}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§9 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code	Message