POST Get Eligible Shipping Service
Get Eligible Shipping Service Shop Required scope: seller.fulfillment.basic 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. Version 202309
POST/fulfillment/202309/orders/{order_id}/shipping_services/query
Request
Path
| Properties | Type | Description |
|---|---|---|
| order_id Required | string | TikTok Shop order ID |
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| shop_cipher Required | string | 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 |
Body
| Properties | Type | Description |
|---|---|---|
| order_line_item_ids | []string | Order line item ID list |
| weight | object | The weight of the scheduled package. |
| dimension | object | The dimensions of the scheduled package. |
| order_line_list | []object | 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 |
Example
CurlGoNode.jsJavaEnable word wrap
1curl-X POST \
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
1{
Error Code
View common error codes
| 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. |
Is this content helpful?Helpful
Not Helpful
PreviousNext