Skip to main content
POST
Add an address to the address book, or replace the one with that id

Authorizations

x-cms-token
string
header
required

CMS session JWT from /api/v1/cms/session/login. Customer account operations require an email-verified session; signed offer links accept an anonymous store session.

Body

application/json
name
string
required
Required string length: 1 - 200
line1
string
required
Required string length: 1 - 200
line2
string | null
required
Maximum string length: 200
city
string
required
Required string length: 1 - 100
region
string
required
Maximum string length: 100
postalCode
string
required
Required string length: 1 - 20
country
string
required
Required string length: 1 - 100
id
string | null
Maximum string length: 64
isDefault
boolean
default:false

Response

Successful response

addressId
string
required