Skip to main content

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

NameTypeSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

NameTypeRequiredSampleDescription
warehouse_typeint32False1Type of warehouse. Applicable values: - 1: Pickup Warehouse - 2: Return Warehouse Default value is 1 (Pickup Warehouse)

Response Parameters

NameTypeSampleDescription
errorstringwarehouse.error_not_in_whitelistThe error key if there's error.
messagestringYour 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_idstring16488d76e337c606s5504f26The identifier for an API request for error tracking.
responseobject[]
warehouse_idint646Warehouse address identifier. It should be unique for every warehouse address
warehouse_namestringwarehouse1The warehouse name filled in when creating the warehouse address
warehouse_typeint321Type of warehouse. Applicable values: - 1: Pickup Warehouse - 2: Return Warehouse
location_idstringIDZLocation identifier for stocks. Different location_ids represent that your addresses are in different item stocks
address_idint64118454205Identity of address
regionstringIDRegion of your warehouse address
statestringACEHState of your warehouse address
citystringKAB. ACEH UTARACity of your warehouse address
addressstringParque Sagrada FamíliaDetail address of your warehouse address
zipcodestring24379Zipcode of your warehouse address
districtstringMato GrossoDistinct of your warehouse address
townstringAv Maria H A dos SantosTown of your warehouse address
state_codestring12345State code of your warehouse address
holiday_mode_stateint320The 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