List all stock reservations

How to fetch a collection of stock reservations via API

To fetch a collection of stock reservations, send a GET request to the /api/stock_reservations endpoint.

Request

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

Example

The following request fetches a collection of stock reservations:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/stock_reservations/' \
  -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 reservations can be sorted by the following fields:

Attributes

  • status

  • quantity

  • expires_at

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • line_item

  • stock_line_item

  • stock_transfer

  • stock_item

  • reserved_stock

Filterable fields

The list of stock reservations can be filtered by the following fields:

Attributes

  • status

  • quantity

  • expires_at

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • line_item

  • order

  • stock_line_item

  • stock_transfer

  • stock_item

  • reserved_stock

  • sku

Last updated