v2.first_mile.get_transit_warehouse_list

GET /api/v2/first_mile/get_transit_warehouse_list

Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/first_mile/get_transit_warehouse_list

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

Name	Type	Required	Sample	Description
region	string	False	CN	Use this field to specify the region you want to ship parcel. Available value: CN.
shipment_method	string	False	pickup	Use this field to specify the shipment method you want to ship parcel. Available value: pickup, dropoff, self_deliver, courier_delivery. Note: Only when shipment_method = dropoff, the API response will include warehouses where warehouse_type = 1 (vendor warehouse).

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error type if hit error. Empty if no error happened.
request_id	string		The identifier for an API request for error tracking.
response	object
transit_warehouse_list	object[]
warehouse_id	string	ECP03	The identity of transit warehouse.
warehouse_name_en	string	Shopee Quanzhou Transit Warehouse	The name of transit warehouse in English.
warehouse_name_cn	string	Shopee泉州仓	The name of transit warehouse in Chinese.
warehouse_type	int32	0	Warehouse type: 0 = normal warehouse 1 = vendor warehouse Note: Only when shipment_method = dropoff, the API response will include warehouses where warehouse_type = 1 (vendor warehouse).