v2.logistics.get_address_list

GET /api/v2/logistics/get_address_list

For integrated logistics channel, use this call to get pickup address for pickup mode order.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/logistics/get_address_list

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

No Request Parameters Set.

Response Parameters

Name	Type	Sample	Description
request_id	string	675015f4f59943a39f2f69c22da431f8	The identifier for an API request for error tracking.
error	string	error_auth	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid access_token.	Indicate error details if hit error. Empty if no error happened.
response	object		Detail informations you are querying.
show_pickup_address	boolean	false	Show pickup address or not.
address_list	object[]		The address list of you shop
address_id	int64	1173	The identity of address.
region	string		The region of specify address.
state	string		The state of specify address.
city	string		The city of specify address.
address	string		The address description of specify address.
zipcode	string		The zipcode of specify address.
district	string		The district of specify address.
town	string		The town of specify address.
address_type	string[]	["DEFAULT_ADDRESS","PICK_UP_ADDRESS"]	The flag of shop address.Available values: DEFAULT_ADDRESS, PICK_UP_ADDRESS, RETURN_ADDRESS, INBOUND_PICKUP_ADDRESS.