stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202309/packages/ship
#§2 Method: [POST]
#§3 Function Description
Use this API to batch ship packages by providing multiple package IDs. This API is available for TikTok shipping orders as well as seller shipping orders.
TikTok Shipping: Schedule a package handover time for TikTok Shipping carriers to pickup a package from the Seller.Seller Shipping: Seller arranges their own shipping, and upload atracking_numberandshipping_provider_id. Package ID can be obtained from Get Order Detail.In-store Pickup: Confirms shipment and notifies the buyer that the order is ready for pickup.
§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 | Input list of packages you would like to batch ship. | |
| ^id | string | Y | 12321312312431 | Package ID. |
| ^handover_method | string | N | PICKUP | Possible values: |
PICKUP: A shipping provider will pickup the package(s) from the seller's pickup address.DROP_OFF: The seller will need to drop off the package(s) at a designated location. | ^pickup_slot |object |N | |Package pickup time slot. | ^^start_time |int |N |1623812664 |The start date and time of the package pickup time slot. Unix timestamp. | ^^end_time |int |N |1623812664 |The end date and time of the package pickup time slot. Unix timestamp. | ^self_shipment |object |N | |Only needed for seller shipping packages. Check thedelivery_optionfield in Get Package Detail to see how to differentiate between TikTok shipping and seller shipping. Use theshipping_provider_idretrieved from the Get Shipping Providers API and upload the corresponding tracking number. | ^^tracking_number |string |Y |JX12345 |For packages with theSEND_BY_SELLERdelivery option type (seller shipping), you must provide the package's tracking number. | ^^shipping_provider_id |string |Y |6617675021119438849 |For packages with theSEND_BY_SELLERdelivery option type (seller shipping), you must provide the shipping provider information. Please use the Get Shipping Providers API to obtain theshipping_provider_id. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202309/packages/ship?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"packages":[{"id":"12321312312431","handover_method":"PICKUP","pickup_slot":{"start_time":1623812664,"end_time":1623812664},"self_shipment":{"tracking_number":"JX12345","shipping_provider_id":"6617675021119438849"}}]}
§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 | Return list of possible errors during package batch shipment attempt. | |
| ^^code | int | 10007014 | The failure reason code. |
| ^^message | string | package in freeze status | The failure reason message. |
| ^^detail | object | Error detail. | |
| ^^^package_id | string | 123123123123131 | Package ID. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":10007014,"message":"package in freeze status","detail":{"package_id":"123123123123131"}}]},"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. |
| 11006013 | Failed to ship package. Products under the Phones & Tablets category cannot be shipped together with other items in the same package. Please split the order. |
| 11006014 | Failed to ship package. If you are shipping multiple products under the Phones & Tablets category, they must be shipped in individual packages. Please split the order to continue. |
| 11021009 | No available shipping services for this request. Please modify the package weight or check the recipient address. If the error persists, please contact the platform for assistance. |
| 11021010 | The shipment failed due to an invalid postal code. Please ask the buyer to edit the address. If the address cannot be changed, you may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021011 | Fail to ship package because the product name is invalid. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021012 | illegal address |
| 11021013 | The shipment failed because the delivery address is too long. Please ask the buyer to shorten the address. If the address cannot be changed, you may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021014 | product oversize |
| 11021015 | Fail to ship package because the package is overweight. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021016 | Fail to ship package because the weight of the SKU exceeds the allowed limit. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021017 | Fail to ship package because the SKU dimensions exceed the allowed limits. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021018 | Fail to ship package because the number of items in the package exceeds the allowed limit. |
| 11021019 | Fail to ship package because the package dimensions exceed the allowed limits. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021020 | Fail to ship package because the package's circumference exceeds the allowed limit. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021021 | Fail to ship package because the SKU name is invalid. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021022 | Fail to ship package because the longest dimension of the package exceeds the allowed limit. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021023 | Fail to ship package because the buyer and/or seller addresses are invalid. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021024 | Fail to ship package because the buyer recipient address is invalid. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11021025 | Fail to ship package because the seller shipping address is invalid. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 11028006 | This tracking number cannot be matched to any carrier, please check the tracking number and upload again. |
| 21001003 | System timeout. If the error persists, please contact the platform for assistance. |
| 21001011 | System process error, please try again later. |
| 21001028 | The order is being processed. Try again later. |
| 21004006 | Failed to ship. Please ensure an invoice is uploaded before shipping. |
| 21008044 | SellerFulfillUnitInReverseCannotOperate |
| 21011001 | Package not found. If the error persists, please contact the platform for assistance. |
| 21011003 | fulfill_unit action not allowed |
| 21011007 | Package item has after-sale request, please process the after-sale request first. |
| 21011008 | Package is not complete. If the error persists, please contact the platform for assistance. |
| 21011020 | These orders are already shipped. |
| 21011022 | Invalid tracking number or provider ID. Please double check and try again. |
| 21011025 | Duplicate tracking number. |
| 21011027 | Package has already been delivered. |
| 21011028 | The package does not belong to the current shop. Please ensure you are providing the correct package ID and/or shop cipher. |
| 21011040 | Package has already been shipped. |
| 21011041 | Cannot complete the operation when order is cancelled. |
| 21011053 | Fail to ship package because the shipment time is outside of the pick-up time slot. |
| 21011054 | No available shipping services for this request due to missing pick-up time slot. Please contact customer service for assistance. |
| 21014009 | Failed to ship. You may cancel the order without penalty by selecting the following reason: Unable to deliver to buyer address. |
| 21042227 | For pop 4pl（cross-border），the return warehouse for the shipping location has not been configured. |
| 21042251 | Abnormal order status, item cannot be shipped. |