Skip to main content
PATCH
Update a shipping address

Request

Path parameters

Updating the core address fields (address, city, state, or country) re-runs address validation against the shipping provider, which requires the address to also carry an email and latitude/longitude. Updating only contact fields such as name or phone skips that step.

Successful response

Error responses

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Path Parameters

addressId
string
required

Body

application/json
name
string
required
Example:

"Jane Smith"

phone
string
required
Example:

"+2348099887766"

email
string<email>
Example:

"jane@example.com"

address
string
Example:

"12 Marina Road"

city
string
Example:

"Lagos"

state
string
Example:

"Lagos"

zipCode
string
Example:

"100001"

country
string
Example:

"Nigeria"

latitude
number
Example:

6.5244

longitude
number
Example:

3.3792

landmark
string
isDefault
boolean
Example:

false

Response

Address updated.

The response is of type object.