Update an Address

Updates the specified address for the current user.

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Path Parameters

id

string

required

The ID of the specified address.

Query Parameters

fields[address]

string

Specify the fields you would like returned in the response body. More information.

Body

application/vnd.api+json

address

object

Show child attributes

address.address1

string

required

Street address

address.city

string

required

City, town

address.country_iso

string

required

Country ISO (2-chars) or ISO3 (3-chars) code. List of all codes

address.firstname

string

required

address.lastname

string

required

address.address2

string

Additional address information, floor no etc

address.company

string

Company name

address.label

string

The internal name for this address (Work, Home)

address.phone

string

address.state_name

string

State/region/province 2 letter abbreviation

address.zipcode

string

Valid zipcode, will be validated against the selected Country

Response

200 - application/vnd.api+json

data

object

The Address model holds the customer details, such as name, address, and phone number.

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.address1

string

data.attributes.address2

string | null

data.attributes.city

string

data.attributes.company

string | null

Company name

data.attributes.country_iso3

string

Country ISO3 code

data.attributes.country_name

string

data.attributes.firstname

string

data.attributes.label

string | null

The internal name for this address (Work, Home)

data.attributes.lastname

string

data.attributes.phone

string | null

data.attributes.state_code

string | null

State abbreviation

data.attributes.state_name

string

data.attributes.zipcode

string

data.id

string

required

data.type

string

default:

address

required