Skip to main content
POST
Create address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is the account token returned from the Login endpoint.

Body

application/json
firstName
string
required
lastName
string
required
addressLine1
string
required
city
string
required
postcode
string
required
country
string
required

ISO country code

addressLine2
string | null
state
string | null
phone
string | null

Must be a valid phone number for the given country

defaultAddress
boolean

Set this address as the customer's default

Response

Success

id
string<uuid>

Unique identifier for the address

firstName
string
lastName
string
addressLine1
string
addressLine2
string | null
city
string
state
string | null

State/county value

county
string | null

Alias of state

postcode
string
countryName
string

Full country name

country
string

ISO country code

type
string | null

Address type

defaultAddress
boolean
deliveryInstructions
string | null
phone
string | null