stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/files/upload
#§2 Method: [POST]
#§3 Function Description
Upload non-image files, such as PDF or video to TikTok Shop. Use this API when you need to add videos to your product to improve the shopping experience, or submit certifications or reports to meet TikTok Shop requirements for listing restricted products. Note: You must store the response body to retrieve the ID or URL required to associate the file with a product during product creation or editing.
§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 | multipart/form-data | Allowed type: multipart/form-data |
§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 |
|---|---|---|---|---|
| data | file | Y | The local file to be uploaded. |
Note：
- Supported formats: PDF, MP4, MOV, MKV, WMV, WEBM, AVI, 3GP, FLV, MPEG
- Max PDF size: 20 MB
- Max video size: 100 MB
- Video aspect ratio: 9:16 to 16:9
Recommendations for product videos:
- Aspect ratio: 1:1
- Resolution: HD 720p or higher
- Duration: 20 - 60 seconds | name |string |Y |SNI.pdf |The name of the file, including the file extension (e.g.
certification.pdf)
Note:
- Do not use additional periods, except the one preceding the file extension.
- Do not begin the name with symbols.
- Do not include spaces. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/files/upload?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=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 | |
| ^id | string | v09e40f40000cfu0ovhc77ub7fl97k4w | The file ID generated by TikTok Shop. |
| Pass this value when creating or editing a product to associate the file with the product. | |||
| ^url | string | https://p-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe | |
| The URL to access and view the file. | |||
| ^name | string | SNI.PDF | The name of the file. |
| ^format | string | The format of the file. | |
| Possible values: PDF, MP4, MOV, MKV, WMV, WEBM, AVI, 3GP, FLV, MPEG |
§9 Response Sample
{"code":0,"data":{"id":"v09e40f40000cfu0ovhc77ub7fl97k4w","url":"https://p-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe\n","name":"SNI.PDF","format":"PDF"},"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 |
|---|---|
| 12019103 | Couldn't upload file, the file is empty. |
| 12019104 | The file name is empty. |
| 12019105 | Failed to process the file. The format or content is not supported. |
| 12019122 | The video ratio must be between 9:16 and 16:9. |
| 12038002 | Invalid upload file. Please ensure you are passing the correct file data. |
| 12038004 | Failed to process the image. The format or content is not supported. |
| 12038005 | The file size exceeds the maximum allowed size. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |