v2.logistics.update_address

POST /api/v2/logistics/update_address

Use this API to update the address of a shop.

Endpoint URL

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

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
address_id	int64	True	123456	Unique identifier for the address. You can get the address_id via v2.logistics.get_address_list.
region	string	False	Brazil	The region of the address. Note: Do not allow to update the region of the address.
state	string	False	SP	The state of the address.
city	string	False	São Paulo	The city of the address.
district	string	False	Pinheiros	The district of the address.
town	string	False	Rua dos Pinheiros	The town of the address.
address	string	False	123 Rua dos Pinheiros Apt 45	The detailed address description of the address.
zipcode	string	False	05422-001	The zipcode of the address.
name	string	False	Carlos Silva	Recipient’s name at this address.
phone	string	False	+55-11-91234-5678	Contact phone number for the recipient.
geo_info	string	False		Geolocation information for the address. Type: JSON string Note: 1) To clear existing geo info, pass "" or {}. 2) To keep existing geo info, do not include this field. 3) The JSON may include optional fields: - formattedAddress (string): full formatted address. - region (object) – contains latitude and longitude as floats. - user_verified (boolean) – whether the geolocation is verified by the user. - user_adjusted (boolean) – whether the geolocation was adjusted by the user.

Response Parameters

Name	Type	Sample	Description
error	string	NOT_ALLOW_TO_EDIT_ADDRESS_REGION	Indicate error type if hit error. Empty if no error happened.
message	string	The param is invalid. not allow to edit address region.	Indicate error details if hit error. Empty if no error happened.
request_id	string	6745b892295d750abf83a29430510400	The identifier for an API request for error tracking.