REST RPC APIAddresses

List

View as Markdown
Returns an array of all addresses available to the merchant.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

customerstringOptional

Customer ID (only available in API user scope)

livebooleanOptional

Address status: active (True) or inactive (False)

updated_startdateOptional

Addresses whose updated datetime is greater than or equal to the given datetime (yyyy-mm-ddThh:mm:ss)

updated_enddateOptional

Addresses whose updated datetime is less than or equal to the given datetime (yyyy-mm-ddThh:mm:ss)

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
updatedstring
token_idany
store_public_idany

Errors

403
Forbidden Error