Skip to main content
Update customer address

Authorizations

X-API-Key
string
header
required

Path Parameters

customer_pk
string<uuid>
required
id
string
required

Body

application/json
first_name
string
Required string length: 1 - 255
last_name
string
Required string length: 1 - 255
company
string
default:""
Maximum string length: 255
phone
string
default:""
Maximum string length: 50
street_1
string
Required string length: 1 - 100
street_2
string
default:""
Maximum string length: 100
city
string
Required string length: 1 - 100
state_province
string
default:""

The full state/province name ("North Carolina"). Required for some countries.

Maximum string length: 255
postal_code
string
default:""

Postal/ZIP code. Required for some countries.

Maximum string length: 30
country_iso2
string

ISO 3166-1 alpha-2 country code ("US").

Required string length: 2
is_default_shipping
boolean
default:false
is_default_billing
boolean
default:false

Response

200 - application/json
id
string<uuid>
required
read-only
first_name
string
required
Required string length: 1 - 255
last_name
string
required
Required string length: 1 - 255
street_1
string
required
Required string length: 1 - 100
city
string
required
Required string length: 1 - 100
country_iso2
string
required

ISO 3166-1 alpha-2 country code ("US").

Required string length: 2
company
string
default:""
Maximum string length: 255
phone
string
default:""
Maximum string length: 50
street_2
string
default:""
Maximum string length: 100
state_province
string
default:""

The full state/province name ("North Carolina"). Required for some countries.

Maximum string length: 255
postal_code
string
default:""

Postal/ZIP code. Required for some countries.

Maximum string length: 30
is_default_shipping
boolean
default:false
is_default_billing
boolean
default:false