v2.shop.get_warehouse_detail
GET /api/v2/shop/get_warehouse_detail
For given shop id and region, return warehouse info including warehouse id, address id and location id, return all warehouse with once call.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop/get_warehouse_detail
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| warehouse_type | int32 | False | 1 | Type of warehouse. Applicable values: - 1: Pickup Warehouse - 2: Return Warehouse Default value is 1 (Pickup Warehouse) |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | warehouse.error_not_in_whitelist | The error key if there's error. |
| message | string | Your shop is not in multi-warehouse whitelist. | Messages about the error and it's cause if there're errors. It will be just return the updated information if there's no error. |
| request_id | string | 16488d76e337c606s5504f26 | The identifier for an API request for error tracking. |
| response | object[] | ||
| warehouse_id | int64 | 6 | Warehouse address identifier. It should be unique for every warehouse address |
| warehouse_name | string | warehouse1 | The warehouse name filled in when creating the warehouse address |
| warehouse_type | int32 | 1 | Type of warehouse. Applicable values: - 1: Pickup Warehouse - 2: Return Warehouse |
| location_id | string | IDZ | Location identifier for stocks. Different location_ids represent that your addresses are in different item stocks |
| address_id | int64 | 118454205 | Identity of address |
| region | string | ID | Region of your warehouse address |
| state | string | ACEH | State of your warehouse address |
| city | string | KAB. ACEH UTARA | City of your warehouse address |
| address | string | Parque Sagrada Família | Detail address of your warehouse address |
| zipcode | string | 24379 | Zipcode of your warehouse address |
| district | string | Mato Grosso | Distinct of your warehouse address |
| town | string | Av Maria H A dos Santos | Town of your warehouse address |
| state_code | string | 12345 | State code of your warehouse address |
| holiday_mode_state | int32 | 0 | The holiday mode state of your address. 0: not in holiday mode 1: holiday mode active 2: holiday mode is turning of 3: holiday mode is turning on |