> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/stock_line_items/object.md).

# The stock line item object

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

## Fields

| Field                                | Type      | Description                                                                                                                                                                                         |
| ------------------------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                             | `string`  | `stock_line_items`                                                                                                                                                                                  |
| **id**                               | `string`  | The stock line item unique identifier                                                                                                                                                               |
| links.**self**                       | `string`  | The stock line item endpoint URL                                                                                                                                                                    |
| attributes.**sku\_code**             | `string`  | The code of the associated SKU.                                                                                                                                                                     |
| attributes.**bundle\_code**          | `string`  | The code of the associated bundle.                                                                                                                                                                  |
| attributes.**quantity**              | `integer` | The line item quantity.                                                                                                                                                                             |
| attributes.**\_reserve\_stock**      | `boolean` | Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.                  |
| attributes.**\_release\_stock**      | `boolean` | Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.      |
| attributes.**\_decrement\_stock**    | `boolean` | Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.        |
| attributes.**name**                  | `string`  | The internal name of the associated line item.                                                                                                                                                      |
| attributes.**image\_url**            | `string`  | The image\_url of the associated line item.                                                                                                                                                         |
| 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.**shipment**           | `object`  | The associated shipment. Optional for do not ship SKUs.                                                                                                                                             |
| relationships.**line\_item**         | `object`  | The associated line item.                                                                                                                                                                           |
| relationships.**stock\_item**        | `object`  | The associated stock item. Optional for do not track SKUs.                                                                                                                                          |
| relationships.**sku**                | `object`  | The associated SKU.                                                                                                                                                                                 |
| relationships.**stock\_reservation** | `object`  | The associated stock reservation.                                                                                                                                                                   |
| relationships.**event\_stores**      | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                        | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.