stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202603/videos
#§2 Method: [POST]
#§3 Function Description
Use this API to post the shoppable video.
§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 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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| video_info | object | Y | Video information | |
| ^file_id | string | Y | v12d00gd0024d3nfqr7og65 | Video file_id from [Upload Shoppable Video File] |
| ^title | string | Y | Sample video title | The video caption. |
| The maximum length is 2200 in UTF-16 runes. | ||||
| If not specified, the ticket post will not have any captions. | ||||
| ^cover_uri | string | N | v12d00gd0024d3nfqr7og65oooiuuyy | Video cover image URI, which is returned after uploading the image via the Upload Shoppable Photo File API. |
| ^cover_timestamp_ms | int | N | 1000 | The input parameter is a timestamp, which specifies a particular moment in the video. The frame at that timestamp will be used as the video cover. If cover_uri and cover_timestamp_ms are both not provided, the cover will default to the first frame of the uploaded video. Only one of cover_uri or cover_timestamp_ms can be provided. If both parameters are passed, cover_uri will take precedence. |
| ^music_id | string | N | 717294069642063456 | The music ID for the video BGM. If not provided, no music will be associated with the video. The music ID must be obtained via Search Music Library. |
| product_link_info | object | Y | Product link information | |
| ^product_id | string | Y | 17294069642063424 | Use product_id to bind the product with the video. |
| The product_id from [Get Shop Products] or [Get Showcase Products] | ||||
| ^title | string | Y | Sample product anchor title | The title to be shown on the product anchor. Anchor title should be shorter than 30 characters. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202603/videos?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"video_info":{"file_id":"v12d00gd0024d3nfqr7og65","title":"Sample video title","cover_uri":"v12d00gd0024d3nfqr7og65oooiuuyy","cover_timestamp_ms":1000,"music_id":"717294069642063456"},"product_link_info":{"product_id":"17294069642063424","title":"Sample product anchor title"}}
§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 | Published video information | |
| ^^id | string | 7548431509997292816 | The video id, use this id to query video publish status. |
§9 Response Sample
{"code":0,"data":{"video":{"id":"7548431509997292816"}},"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 |
|---|---|
| 16011007 | Product link title should be no longer than 30 characters. |
| 16011009 | Product link title contains offensive language. |
| 16011069 | Product link title contains punctuation or emoji. |
| 38007001 | System Error |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 170001002 | Creator TikTok Shop permission check failed. |
| 170001003 | Creator Tiktok Shop permission temporarily banned. |
| 170001004 | Creator TikTok Shop permission is permanently banned. |
| 170001005 | Creator terms of service not signed. Please contact TikTok for more details. |
| 170001006 | GKA terms not signed. Please try again after signing GKA term. |
| 170001007 | Creator did not sign the EU data share agreement. |
| 170001008 | Creator Age verification failed. Please verify age first. |
| 170001009 | The product belongs to unsupported category. |
| 170001010 | The commission plan gets failed or rejected. |
| 170001011 | The product doesn't exist. |
| 170001012 | The product is not available. |
| 170001013 | Showcase SPU exceeds limit. |
| 170001014 | Blocked by spam check. |
| 170001015 | Blocked by TikTok Shop risk control. |
| 170001018 | Get creator pay account error. Please verify the pay account first. |
| 170001020 | You have exceeded the frequency to post EC short videos. Please take a rest. |
| 170001024 | cover_timestamp_ms must be a non-negative integer within the video duration. |
| 170001025 | cover_timestamp_ms exceeds the video duration. |
| 170001030 | Creator account banned. Please contact TikTok agent for your account. |
| 170001031 | Creator forbidden to post content. |
| 170001040 | Please use valid video file id to post TikTok Shop short video. |
| 170001050 | Getting errors during video posting workflow. Please try again or contact TikTok. |
| 170001060 | Posting quota exceeded: the creator is under violation control, resulting in a reduced posting limit. |
| 170001061 | Posting quota exceeded: creator is in the newbie period. |
| 170001062 | Posting quota exceeded: platform-level posting limit reached. |
| 170001063 | The product you added only supports auction sales and cannot be used in shoppable videos or Carousels. |