stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /logistics/202309/warehouses
#§2 Method: [GET]
#§3 Function Description
This API retrieves all warehouse information associated with the seller. Warehouse information includes name, status, address, and other details.
§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 Sample
Query
https://open-api.tiktokglobalshop.com/logistics/202309/warehouses?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§7 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 | |
| ^warehouses | []object | All the warehouses associated with the seller. | |
| ^^id | string | 7000714532876273410 | The warehouse ID, a unique and immutable primary key, used for all warehouse logistics. |
| ^^entity_id | string | 7395366865142499073 | The warehouse entity ID, used to associate physical information of a warehouse, different warehouses may be associated with the same entity. |
| ^^name | string | Guangzhou | Warehouse name. This name is not unique across the TikTok Shop system. |
| ^^effect_status | string | ENABLED | Possible values: |
- ENABLED: All products in stock are available for sale.
- DISABLED: All products in stock are unavailable for sale.
- RESTRICTED: The warehouse is either on "holiday mode" or "order limit mode." All products in stock are unavailable for sale. -Holiday mode: When the seller cannot fulfill an order from a warehouse, the seller can turn on holiday mode for the warehouse in seller center.
- Order limit mode: When the seller violates TikTok Shop policies, TikTok Shop will limit the order volume that can be fulfilled by a warehouse. | ^^type |string |SALES_WAREHOUSE |Possible values:
- SALES_WAREHOUSE: Warehouse for shipping products.
- RETURN_WAREHOUSE: Warehouse for receiving returned products. You can have the same warehouse for both shipping and receiving returns, but they will have different warehouse IDs with the same address. | ^^sub_type |string |DOMESTIC_WAREHOUSE |Possible values:
- DOMESTIC_WAREHOUSE: The warehouse is in the same country as the target market and the seller.
- CB_OVERSEA_WAREHOUSE: For cross-border sellers, a local warehouse in the target market.
- CB_DIRECT_SHIPPING_WAREHOUSE: For cross-border sellers, a warehouse in the seller's base country, e.g., Mainland China or Hong Kong. | ^^is_default |bool |true |The default warehouse. If a product is listed with no designated warehouse, the default warehouse will be used. | ^^address |object | |Warehouse address. | ^^^region |string |China |Warehouse region. | ^^^state |string |GuangDong |Warehouse state or province. | ^^^city |string |GuanZhou |Warehouse city. | ^^^distict |string |HuaDu |Warehouse district. | ^^^town |string |town |Warehouse town. | ^^^contact_person |string |Lee |Warehouse contact person name. | ^^^first_name |string |新一 |Kanji first name Applicable only for the JP market. | ^^^last_name |string |工藤 |Kanji last name Applicable only for the JP market. | ^^^first_name_local_script |string |くどう |Hiragana or Katakana first name Applicable only for the JP market. | ^^^last_name_local_script |string |しんいち |Hiragana or Katakana last name Applicable only for the JP market. | ^^^postal_code |string |510000 |Warehouse address postal code (also known as zip code) | ^^^full_address |string |South Sea 11 floor |The combined warehouse address, including the street address and other address information such as apartment number, building, floor..etc (optional) | ^^^region_code |string |CN |Warehouse region code. | ^^^phone_number |string |188****2234 |Warehouse phone number. | ^^^address_line1 |string |Bairro/Distrito |The first line of the warehouse address, like street name and street number. Note:
- For Brazilian market, this represents the neighborhood or district.
- For the JP market, this represents the district (Chome), block (Banchi), building number (Go). | ^^^address_line2 |string |Caminho Trinta e Três |The second line of the warehouse address, like flat, apartment, or suit. Note: For the Brazilian market, this represents the street name. | ^^^address_line3 |string |3 |This represents the street number. If it's
s/n, it means null. Note: Available only in the Brazilian market. | ^^^address_line4 |string |11 floor |This represents supplement information, like flat, apartment, or suit (optional). Note: Available only in the Brazilian market. | ^^^geolocation |object | |The geographical location of the address. | ^^^^latitude |string |45.41634 |The latitude of the address. | ^^^^longitude |string |-75.6868 |The longitude of the address. |
§8 Response Sample
{"code":0,"data":{"warehouses":[{"id":"7000714532876273410","entity_id":"7395366865142499073","name":"Guangzhou","effect_status":"ENABLED","type":"SALES_WAREHOUSE","sub_type":"DOMESTIC_WAREHOUSE","is_default":true,"address":{"region":"China","state":"GuangDong","city":"GuanZhou","distict":"HuaDu","town":"town","contact_person":"Lee","first_name":"新一","last_name":"工藤","first_name_local_script":"くどう","last_name_local_script":"しんいち","postal_code":"510000","full_address":"South Sea 11 floor","region_code":"CN","phone_number":"188****2234","address_line1":"Bairro/Distrito","address_line2":"Caminho Trinta e Três","address_line3":"3","address_line4":"11 floor","geolocation":{"latitude":"45.41634","longitude":"-75.6868"}}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 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. |