Update Address

Beta
PATCH/v1/sales/addresses/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an address.

idstring

Address ID.

nameoptional string

Display name of the address.

phoneoptional stringnullable

Phone number associated with the address. Send null to clear.

emailoptional stringnullable

Email address associated with the address. Send null to clear.

is_drop_shipoptional boolean

Whether the address is a drop ship location.

street_line_1optional string

First line of the street address.

street_line_2optional stringnullable

Second line of the street address. Send null to clear.

localityoptional string

City or locality.

stateoptional string

State or administrative area.

postal_codeoptional string

Postal or ZIP code.

countryoptional string

Two-letter country code.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Address