Endpoints Reference
Customer Address
Create a new customer address
POST
/v1/{siteEnv}/{siteId}/customers/{customer_external_id}/addresses
PATH PARAMETERS
siteEnv
string
*Example: live
siteId
string
*Example: bobs-store
customer_external_id
string
*Platform ID of Customer
BODY PARAMETERS
body
Address
Address
title
string
Example: Mr
first_name
string
Example: Bob
last_name
string
Example: Jones
company
string
Example: Tom Jones Climbing Ltd
address_line1
string
Example: Example Industrial Estate
address_line2
string
Example: North Country
city
string
Example: Cityland
region_code
string
Example: CA
postal_code
string
Example: 12345
country_code
string
Example: US
Two letter country code as defined by ISO 3166-2
phone
string
Example: +44 (0) 123456789
is_default_shipping
boolean
is_default_billing
boolean
RESPONSES
201
Successful Address
AddressWithId
title
string
Example: Mr
first_name
string
Example: Bob
last_name
string
Example: Jones
company
string
Example: Tom Jones Climbing Ltd
address_line1
string
Example: Example Industrial Estate
address_line2
string
Example: North Country
city
string
Example: Cityland
region_code
string
Example: CA
postal_code
string
Example: 12345
country_code
string
Example: US
Two letter country code as defined by ISO 3166-2
phone
string
Example: +44 (0) 123456789
customer_address_external_id
string
eCommerce platform ID for the Customer Address
401
Auth Failure
500
System Exception