Get Shoppable Video Status

资料正文

§1 Path: /affiliate_creator/202509/videos/{video_id}/status

§2 Method: [GET]

§3 Function Description

Use this API to get shoppable video posting results.

§4 Common Parameters

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

Properties	Location	Type	Require	Sample	Properties description
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Path Parameters

Properties	Type	Require	Sample	Properties description
video_id	string	Y	7548431509997292816	The video id from [Publish Shoppable Video]

§6 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.

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_creator/202509/videos/7548431509997292816/status?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268

§8 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
^video	object		returned video info
^^id	string	7493990579714164574	Video id
^^post_status	string	FAIL	Video posting status, possible values:

SUCCESS
FAIL
PROCESSING | ^^post_time |int |1685548800 |Returned if the video has been successfully posted, i.e. posting_status = SUCCESS. Represented in seconds. |

§9 Response Sample

{"code":0,"data":{"video":{"id":"7493990579714164574","post_status":"FAIL","post_time":1685548800}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§10 Error Code

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

Code	Message
38007001	System Error
170001016	The video does not belong to the creator or the video is not photo post. Please check valid video status.