List

Returns an array of all addresses available to the merchant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔐

Authentication

✔️ Application API Scope

✔️ Storefront API Scope (including with trust_level: recognized)

Note: Application API Scope with Bulk Operations permission is required to list addresses for more than one customer.

Response Body Definitions

NameTypeDescriptionExample
customerstringCustomer ID"00026001"
public_idstringAddress ID"c4cd7f86ccc411e8ada3bc764e101db1"
labelstring
first_namestringCustomer first name"Nathan"
last_namestringCustomer last name"Torres"
company_namestringCustomer company name"Torres Tower Construction LLC"
addressstringCustomer primary address"75 Broad St Fl 23"
address2stringAdditional customer address"123 Broadway"
citystringCustomer city name"New York"
state_province_codestringCustomer state or province"NY"
zip_postal_codestringCustomer postal code"10004-2487"
phonestringCustomer phone number"3154055372"
faxstringCustomer fax number"3839191337"
country_codestringCustomer country code"US"
livebooleanWhether the Address object is considered liveTrue
createdstringDate time the Address object was created"2018-10-10 14:43:32"
updatedstringDate time the Address object was last modified"2025-03-13 04:43:32"
token_idstring
store_public_idstring
Query Params
string

Customer ID (only available in API user scope)

boolean

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

date

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

date

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json