API reference
Search
K
Links
Comment on page

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

Request
Response
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'
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "stock_reservations",
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde"
},
"attributes": {
"status": "draft",
"quantity": 4,
"expires_at": "2018-01-02T12:00:00.000Z",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/relationships/line_item",
"related": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/line_item"
}
},
"order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/order"
}
},
"stock_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/relationships/stock_item",
"related": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/stock_item"
}
},
"reserved_stock": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/relationships/reserved_stock",
"related": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/reserved_stock"
}
},
"sku": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/relationships/sku",
"related": "https://yourdomain.commercelayer.io/api/stock_reservations/xYZkjABcde/sku"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 stock_reservations (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/stock_reservations?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/stock_reservations?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/stock_reservations?page[number]=14&page[size]=10"
}
}
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:
  • status
  • quantity
  • expires_at
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

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_item
  • reserved_stock
  • sku