List all stores

How to fetch a collection of stores via API

To fetch a collection of stores, send a GET request to the /api/stores endpoint.

Request

GET https://yourdomain.commercelayer.io/api/stores

Example

Request

The following request fetches a collection of stores:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/stores/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of stores can be sorted by the following fields:

Attributes

• name

• code

• id

• created_at

• updated_at

• reference

• reference_origin

Relationships

• market

• stock_location

Filterable fields

The list of stores can be filtered by the following fields:

Attributes

• name

• code

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• market

• merchant

• stock_location

• events