REST RPC APIAddresses

Create

View as Markdown

Creates address information for an individual customer.

Storefront API Scope may authenticate with Trust Level Authentication (trust_level: recognized).

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Request

This endpoint expects an object.
customerstringRequired
Customer ID
address_typestringRequired

Customer address type (‘billing_address’ or ‘shipping_address’)

first_namestringRequired
Customer first name
last_namestringRequired
Customer last name
addressstringRequired
Customer primary address
citystringRequired
Customer city name
state_province_codestringRequired
Customer state or province
zip_postal_codestringRequired
Customer postal code
country_codestringRequired
Customer country code
phonestringRequired
Customer phone number
labelstringOptional
company_namestringOptional
Customer company name
address2stringOptional
Additional customer address
faxstringOptional
Customer fax number
token_idstringOptional
External merchant reference

Response

200
customerstringOptional
public_idstringOptional
labelstring or nullOptional
first_namestringOptional
last_namestringOptional
company_namestring or nullOptional
addressstringOptional
address2string or nullOptional
citystringOptional
state_province_codestringOptional
zip_postal_codestringOptional
phonestringOptional
faxstring or nullOptional
country_codestringOptional
livebooleanOptionalDefaults to true
createdstringOptional
token_idstring or nullOptional
store_public_idanyOptional

Errors

400
Bad Request Error
403
Forbidden Error