stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202502/invoice/upload
#§2 Method: [POST]
#§3 Function Description
Upload the invoice document. Note: Applicable only for local sellers in the Brazil market.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| invoices | []object | N | The list of invoices to upload. | |
| ^package_id | string | Y | 1161235029d14122252 | The TikTok Shop package ID, retrieved from Search Package. |
| ^order_ids | []string | Y | 5361235029d14122252 | The list of TikTok Shop order IDs, retrieved from Get Order List. |
| ^file_type | string | Y | XML | The invoice file format. |
| Possible values: |
XML| ^file |string |Y |PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL |Base64 encoding of the invoice file to upload. Max file size: 1MB |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202502/invoice/upload?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"invoices":[{"package_id":"1161235029d14122252","order_ids":"5361235029d14122252","file_type":"XML","file":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL"}]}
§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 | |
| ^errors | []object | The list of errors that occurred. | |
| ^^code | int | 10007014 | The error code. |
| ^^message | string | The invoice already exists in the upload. Please try again later | The error message. |
| ^^detail | object | The details of the error. | |
| ^^^package_id | string | 1231231231231 | The package ID where the error occurred. |
| ^^^order_ids | []string | ["58747683456"] | The order IDs where errors occurred. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":10007014,"message":"The invoice already exists in the upload. Please try again later","detail":{"package_id":"1231231231231","order_ids":["58747683456"]}}]},"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 |
|---|---|
| 21001028 | The order is being processed. Try again later. |