REST RPC APIAddresses

Retrieve

View as Markdown

Retrieves 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.

Path parameters

address_idstringRequired
Unique address ID

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

403
Forbidden Error
404
Not Found Error