POST
/
api-commerceIdentity
/
user
/
{userId}
/
address
/
{addressId}
/
unset

Authorizations

x-api-key
string
header
required

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

userId
string
required

User ID

addressId
string
required

Address ID

Response

200 - application/json
address1
string
required

Primary address

city
string
required

Address city

country
string
required

Address country

email
string
required

Email address

isDefault
boolean
required

true: This is the default address<br />false: This is an additional address

isValidated
boolean
required

true: Address has been validated<br />false: Address has not been validated

state
string
required

Address state

zipCode
string
required

Address zip code

address2
string

Second address line

address3
string

Third address line

attention
string

Address recipient

company
string

Company name

kind
string

Address type

name
object
phone
object

Telephone number and type associated with address