# The stock reservation object

A stock reservation object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/stock_reservations` endpoint.

## Fields

| Field                               | Type      | Description                                                                                                                                                                                         |
| ----------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                            | `string`  | `stock_reservations`                                                                                                                                                                                |
| **id**                              | `string`  | The stock reservation unique identifier                                                                                                                                                             |
| links.**self**                      | `string`  | The stock reservation endpoint URL                                                                                                                                                                  |
| attributes.**status**               | `string`  | The stock reservation status. One of 'draft' (default), or 'pending'.                                                                                                                               |
| attributes.**quantity**             | `integer` | The stock reservation quantity.                                                                                                                                                                     |
| attributes.**expires\_at**          | `string`  | The expiration date/time of this stock reservation.                                                                                                                                                 |
| attributes.**\_pending**            | `boolean` | Send this attribute if you want to mark this stock reservation as pending.                                                                                                                          |
| attributes.**created\_at**          | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**          | `string`  | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**            | `string`  | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin**    | `string`  | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**             | `object`  | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**line\_item**        | `object`  | The associated line item.                                                                                                                                                                           |
| relationships.**order**             | `object`  | The associated order.                                                                                                                                                                               |
| relationships.**stock\_line\_item** | `object`  | The associated stock line item.                                                                                                                                                                     |
| relationships.**stock\_transfer**   | `object`  | The associated stock transfer.                                                                                                                                                                      |
| relationships.**stock\_item**       | `object`  | The associated stock item.                                                                                                                                                                          |
| relationships.**reserved\_stock**   | `object`  | The associated reserved stock.                                                                                                                                                                      |
| relationships.**sku**               | `object`  | The associated SKU.                                                                                                                                                                                 |
| relationships.**event\_stores**     | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                       | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/stock_reservations/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.