POST

https://{customerDomain}.fabric.zone

/
api-commerceIdentity
/
user
/
{userId}
/
address

Authorizations

x-api-key
string
headerrequired

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

Body

application/json

Request body for creating a user's address

address1
string
required

Primary address

city
string
required

Address city

state
string
required

Address state

country
string
required

Address country

zipCode
string
required

Address zip code

attention
string

Address recipient

address2
string

Second address line

address3
string

Third address line

company
string

Company name

kind
string

Address type

phone
object

Telephone number and type associated with address

name
object
email
string

Email address

Response

200 - application/json
attention
string

Address recipient

address1
string
required

Primary address

address2
string

Second address line

address3
string

Third address line

city
string
required

Address city

state
string
required

Address state

country
string
required

Address country

zipCode
string
required

Address zip code

company
string

Company name

kind
string

Address type

phone
object

Telephone number and type associated with address

name
object
email
string
required

Email address

isValidated
boolean
required

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

isDefault
boolean
required

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