stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /logistics/202510/seller_templates
#§2 Method: [GET]
#§3 Function Description
get seller's available shipping template and return the reason why the template is not available,this api is now only available for JP and UK market
§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 |
|---|---|---|---|---|
| product_attribute | object | N | Attribute of the product,including dimension and weight | |
| ^weight | object | N | The weight of product | |
| ^^weight | string | N | 10 | The weight of product |
| ^^unit | int | N | 1 | 1:gram |
| 2:pound | ||||
| 3:ounce | ||||
| 4:kilogram | ||||
| ^dimension | object | N | The dimension of the product | |
| ^^length | string | N | 10 | The length of the product |
| ^^width | string | N | 10 | The width of the product |
| ^^height | string | N | 10 | The height of the product |
| ^^unit | int | N | 1 | 1: centimeter |
| 2:inch | ||||
| 3:foot | ||||
| 4:millimeter | ||||
| 5:meter |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/logistics/202510/seller_templates?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§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 | |
| ^templates | []object | All the seller's template | |
| ^^template_is_available | bool | false | Whether the template is available |
| ^^template | object | Template details, including the template_name and other messages | |
| ^^^template_name | string | test template | The template name |
| ^^^template_id | string | 1234566 | The template_id |
| ^^^is_default | bool | false | Is default template or not |
| ^^^template_party | int | 1 | 1 for shipping by platform template |
| 2 for shipping by seller template | |||
| ^^service_unreachable_reason | []object | If service_unreachable_reason is not empty, it will contain a "reason" why this template is not usable. | |
| If service_unreachable_reason is empty, then template is usable | |||
| ^^^service_id | string | 23241 | Id of the service |
| ^^^filter_reason | []object | Contains the reason why this template is not usable | |
| ^^^^filter_type | string | 9 | 1 for length filter |
2 for width filter 3 for height filter 4 for weight filter 9 for service mode filter 11 for service filter | ^^^^reason |string |Ship by seller is banned |Detailed reason for unreachable |
§9 Response Sample
{"code":0,"data":{"templates":[{"template_is_available":false,"template":{"template_name":"test template","template_id":"1234566","is_default":false,"template_party":1},"service_unreachable_reason":[{"service_id":"23241","filter_reason":[{"filter_type":"9","reason":"Ship by seller is banned"}]}]}]},"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 |
|---|
