stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202309/files/upload
#§2 Method: [POST]
#§3 Function Description
This API is used for the seller to upload the proof of delivery file for a package, and to generate the URL of the corresponding file. The generated URL is used for the Update Package Delivery Status API.
This API only supports uploading qualification files in PDF format. The file size can not exceed 10MB.
Note: Only sellers utilizing the SOF (Seller Own Fleet) capability can use this API.
§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 | multipart/form-data | Allowed type: multipart/form-data |
| category_asset_cipher | query | string | N | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
§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 | BWWCusFdYKa4W1wlphrbBWWCusFdYKaxtOawMj5ftPCQAAAABJRU5ErkJggg== | PDF file data to be uploaded to TikTok Shop. |
| Prerequisites： |
- Only
PDFfile format is supported. - Original file size must not exceed 10MB. | name |string |Y |XXX.pdf |The name of the uploaded file. The file name must include the file type. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202309/files/upload?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§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 | |
| ^url | string | https://maellane.bytedance.net/wsos_v2/oec_fulfillment_doc_tts/o | The URL returned from uploading the file that can be directly opened in a browser. |
| ^name | string | attachment_file.pdf | The name of the file. |
§9 Response Sample
{"code":0,"data":{"url":"https://maellane.bytedance.net/wsos_v2/oec_fulfillment_doc_tts/o","name":"attachment_file.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 |
|---|---|
| 12038002 | Invalid upload file. Please ensure you are passing the correct file data. |
| 12038004 | Invalid file type. Please ensure you are providing a PDF file. |
| 12038005 | Invalid file size. Please ensure your file is smaller than 10MB. |