Create

View as Markdown
Creates address information for an individual customer.

Authentication

x-api-keystring
API Key authentication via header

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
customerstring
public_idstring
labelany
first_namestring
last_namestring
company_nameany
addressstring
address2any
citystring
state_province_codestring
zip_postal_codestring
phonestring
faxany
country_codestring
livebooleanDefaults to true
createdstring
token_idany
store_public_idany

Errors

400
Bad Request Error
403
Forbidden Error