List all stock locations
How to fetch a collection of stock locations via API
To fetch a collection of stock locations, send a GET
request to the /api/stock_locations
endpoint.
Request
GET https://yourdomain.commercelayer.io/api/stock_locations
Example
The following request fetches a collection of stock locations:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/stock_locations/' \
-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 stock locations can be sorted by the following fields:
Attributes
name
code
label_format
suppress_etd
id
created_at
updated_at
reference
reference_origin
Relationships
address
Filterable fields
The list of stock locations can be filtered by the following fields:
Attributes
name
code
label_format
suppress_etd
id
created_at
updated_at
reference
reference_origin
metadata
Relationships
address
inventory_stock_locations
inventory_return_locations
stock_items
stock_transfers
stores
attachments
Last updated