stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202309/packages/deliver
#§2 Method: [POST]
#§3 Function Description
Use this API to update the delivery status of a package from 'TTS' to 'DELIVERED'. Only sellers using SOF (Seller Own Fleet) or O2O (Store Pickup) are allowed to update the package status to 'DELIVERED' through this API. This API is available only in the SEA region.
§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 |
|---|---|---|---|---|
| packages | []object | Y | The return list of packages. | |
| ^id | string | Y | 11529598723402 | The package ID. |
| ^delivery_type | string | Y | DELIVERY_SUCCESS | Delivery status of the package. |
| Possible values for in-store pick up: |
DELIVERY_SUCCESS: The package has been successfully delivered. Possible values for SOF (Seller Own Fleet):DELIVERY_SUCCESS: The package has been successfully delivered.DELIVERY_FAILED: The package could not be delivered successfully.UPDATE_POD: Updates the attachment for a package that has already been delivered. | ^fail_delivery_reason |string |N |INVALID_ADDRESS |Delivery failure reasons.
When delivery_type = DELIVERY_FAILED, this field is required. For other delivery types, this field is not required.
Possible values:
INVALID_ADDRESS: The buyer shipping address is invalid.UNABLE_RECEIVE: The buyer is currently unable to receive the delivery.UNABLE_CONTACT_BUYER: Unable to contact the buyer.BUYER_REFUSED: The buyer has refused to receive the product.DELAY_DELIVERY: Delay in delivery.PACKAGE_LOST: The package is lost.PACKAGE_DAMAGE: The package is damaged.FORCE_MAJEURE: An unforeseeable event of force majeure has occurred.OTHER: Other reason. | ^file_type |string |N |IMG |Attachment type:IMGPDF| ^file_url |string |N |https://tiktok.shopcenter.cn/file/CWvBsBZ9mhbMiHtmbZecKshon6f?table=tblTW |Attachment URL. The seller can use the Upload Delivery File and Upload Delivery Image APIs to generate the URL. The attachment will be used by TikTok Shop to verify the package delivery. | ^verification_code |string |N |123456 |The verification code required for order pickup. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202309/packages/deliver?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"packages":[{"id":"11529598723402","delivery_type":"DELIVERY_SUCCESS","fail_delivery_reason":"INVALID_ADDRESS","file_type":"IMG","file_url":"https://tiktok.shopcenter.cn/file/CWvBsBZ9mhbMiHtmbZecKshon6f?table=tblTW","verification_code":"123456"}]}
§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 | Specific return information (returns multiple errors and reasons). | |
| ^^code | int | 10007014 | The failure reason code. |
| ^^message | string | order not in sof service | Fulfillment failure reason. |
| ^^detail | object | Error detail. | |
| ^^^package_id | string | 1231231231231 | Package ID. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":10007014,"message":"order not in sof service","detail":{"package_id":"1231231231231"}}]},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 21001011 | System process error, please try again later. |
| 21011028 | The package does not belong to the current shop. Please ensure you are providing the correct package ID and/or shop cipher. |
| 21042247 | The code you entered is incorrect. Please try again. |
| 21042248 | The maximum number of attempts has been reached. Please try again in 30 minutes. |
| 21042252 | Abnormal order status, failed to update delivery status, please try again later. |