stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202309/orders/{order_id}/shipping_services/query
#§2 Method: [POST]
#§3 Function Description
Use this API ( for US ) to query the list of available shipping services when specifying packages' size or weight. Use this API ( for JP ) to query the list of available shipping services when specifying packages' size or weight.The shipping fee and delivery time is an estimate only and is based on the package dimensions and weight you provided. Options listed may differ if you change the package attributes at the time of shipping.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| order_id | string | Y | 32132124331234 | TikTok Shop order ID |
§6 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. |
§7 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| order_line_item_ids | []string | N | ["32132124331234"] | Order line item ID list |
| weight | object | N | The weight of the scheduled package. | |
| ^value | string | Y | 0.4 | The weight of the scheduled package. |
| ^unit | string | Y | GRAM | The unit of measurement is used to measure the weight. |
- GRAM
- POUND | dimension |object |N | |The dimensions of the scheduled package. | ^length |string |Y |0.3 |The length of the package. The length, width, height must be passed together. | ^width |string |Y |0.2 |The width of the package. The length, width, height must be passed together. | ^height |string |Y |CM |The height of the package. The length, width, height must be passed together. | ^unit |string |Y |INCH |The unit of measurement is used to measure the length.
- CM
- INCH | order_line_list |[]object |N | |This new parameter is completely backward compatible with the previous oder_line_items_ids field and in addition this supports bundle order splitting, use the sub items accordingly | ^order_line_id |string |N |57632132124331234 |The corresponding order line ID. | ^sub_item_id |string |N |57632132124331234 |The sub-order-line ID inside a bundle product.
- Required for bundle products.
- Not required for non-bundle products. |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202309/orders/32132124331234/shipping_services/query?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"order_line_item_ids":["32132124331234"],"weight":{"value":"0.4","unit":"GRAM"},"dimension":{"length":"0.3","width":"0.2","height":"CM","unit":"INCH"},"order_line_list":[{"order_line_id":"57632132124331234","sub_item_id":"57632132124331234"}]}
§9 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 | |
| ^order_id | string | 28823355942588 | TikTok Shop order ID |
| ^order_line_id | []string | ["32132124331234"] | Line item ID list |
| ^weight | object | The weight of the scheduled package. | |
| ^^value | string | 1.2 | The weight of the scheduled package. |
| ^^unit | string | GRAM | The unit of measurement is used to measure the weight. |
- GRAM
- POUND | ^shipping_services |[]object | |Shipping services info. | ^^id |string |288233559123860015 |Shipping service ID | ^^name |string |UPS-first class |Shipping service Name | ^^price |string |5 |Estimated total price for this Shipping services | ^^currency |string |USD |Currency of the price | ^^earliest_delivery_days |int |3 |The minimum estimated duration required for parcel delivery.US only. | ^^latest_delivery_days |int |5 |The maximum estimated duration required for parcel delivery.US only. | ^^is_default |bool |false |Whether it is the default shipping service | ^^shipping_provider_name |string |UPS |The name of shipping provider.US only. | ^^shipping_provider_id |string |288233559123860012 |The ID of shipping provider.US only. | ^^shipping_fee |string |3 |Shipping fee | ^^shipping_app_service_fee |string |1 |Shipping surcharge paid to the ERPs | ^^signature_fee |string |1 |Signature service fee | ^dimension |object | |The dimension of the scheduled package. | ^^length |string |0.3 |The length of the package. The length, width, height must be passed together. | ^^width |string |0.2 |The width of the package. The length, width, height must be passed together. | ^^height |string |0.04 |The height of the package. The length, width, height must be passed together. | ^^unit |string |INCH |The unit of measurement is used to measure the length.
- CM
- INCH |
§10 Response Sample
{"code":0,"data":{"order_id":"28823355942588","order_line_id":["32132124331234"],"weight":{"value":"1.2","unit":"GRAM"},"shipping_services":[{"id":"288233559123860015","name":"UPS-first class","price":"5","currency":"USD","earliest_delivery_days":3,"latest_delivery_days":5,"is_default":false,"shipping_provider_name":"UPS","shipping_provider_id":"288233559123860012","shipping_fee":"3","shipping_app_service_fee":"1","signature_fee":"1"}],"dimension":{"length":"0.3","width":"0.2","height":"0.04","unit":"INCH"}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§11 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 10006402 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 21001001 | Invalid parameters. Please ensure you are passing the correct request parameter(s). |
| 21011001 | Package not found. If the error persists, please contact the platform for assistance. |
| 21011006 | These orders are already shipped. |
| 21011029 | order does not belong to fulfill unit |
| 21011037 | There are no available shipping services for this request. Please modify the package weight, or double check the recipient address. If after multiple retries you continue to experience this error, please contact the platform for assistance. |
| 21011048 | There are multiple packages that can be shipped, please specify the order line that needs to be shipped. |
