stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /logistics/202309/warehouses/{warehouse_id}/delivery_options
#§2 Method: [GET]
#§3 Function Description
This API is used to obtain a list of delivery options available through the seller's designated warehouse.
§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 |
|---|---|---|---|---|
| warehouse_id | string | Y | 6966568648651605766 | The warehouse 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. |
| scope | string | N | PRODUCT | Specify the scope of delivery options to retrieve. |
WAREHOUSE: Returns all delivery options currently active for the warehouse. By default, orders will be shipped based on these options.PRODUCT: Returns the delivery options that can be assigned directly to a product. Use this if you want to enable custom delivery options for a product, overriding the default warehouse options. Onlydelivery_options.idanddelivery_options.namewill be included in the response when this is specified. Default:WAREHOUSE|
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/logistics/202309/warehouses/6966568648651605766/delivery_options?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&scope=PRODUCT
§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 | |
| ^delivery_options | []object | List of deliver options available through the seller's warehouse, and the respective carriers and attribute restrictions depending on the commodity. | |
| ^^id | string | 6955034615128000261 | Delivery option ID. |
| ^^name | string | LSV-TTS-STD | Delivery option name. |
| ^^type | string | STANDARD | Delivery option type. This is an enumerated type with values: |
- STANDARD
- EXPRESS
- ECONOMY
- SEND_BY_SELLER | ^^description |string |LSV-TTS-STD S |Delivery option description. | ^^dimension_limit |object | |The length, width, and height restrictions of the delivery option. | ^^^max_height |int |100 |Maximum height limit. | ^^^max_length |int |100 |Maximum length limit. | ^^^max_width |int |100 |Maximum width limit. | ^^^unit |string |INCH |The unit of measurement for the dimensions, with possible values:
- CM
- INCH | ^^weight_limit |object | |The weight restrictions of this delivery option. | ^^^max_weight |int |100 |Maximum weight limit. | ^^^min_weight |int |100 |Minimum weight limit. | ^^^unit |string |GRAM |The unit of measurement for the weight, with possible values:
- GRAM
- POUND | ^^platform |[]string |["TOKOPEDIA","TIKTOK_SHOP"] |The platform on which the delivery option is available Possible values:
- TIKTOK_SHOP
- TOKOPEDIA |
§9 Response Sample
{"code":0,"data":{"delivery_options":[{"id":"6955034615128000261","name":"LSV-TTS-STD","type":"STANDARD","description":"LSV-TTS-STD S","dimension_limit":{"max_height":100,"max_length":100,"max_width":100,"unit":"INCH"},"weight_limit":{"max_weight":100,"min_weight":100,"unit":"GRAM"},"platform":["TOKOPEDIA","TIKTOK_SHOP"]}]},"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. |
