List all addresses
How to fetch a collection of addresses via API
To fetch a collection of addresses, send a GET
request to the /api/addresses
endpoint.
Request
GET https://yourdomain.commercelayer.io/api/addresses
Example
The following request fetches a collection of addresses:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/addresses/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of addresses can be sorted by the following fields:
Attributes
city
state_code
country_code
id
created_at
updated_at
reference
reference_origin
Filterable fields
The list of addresses can be filtered by the following fields:
Attributes
business
first_name
last_name
company
line_1
line_2
city
zip_code
state_code
country_code
phone
email
notes
lat
lng
billing_info
id
created_at
updated_at
reference
reference_origin
metadata
Relationships
events
tags
Last updated