# The stock location object

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

## Fields

| Field                                          | Type      | Description                                                                                                                                                                                         |
| ---------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                       | `string`  | `stock_locations`                                                                                                                                                                                   |
| **id**                                         | `string`  | The stock location unique identifier                                                                                                                                                                |
| links.**self**                                 | `string`  | The stock location endpoint URL                                                                                                                                                                     |
| attributes.**number**                          | `integer` | Unique identifier for the stock location (numeric).                                                                                                                                                 |
| attributes.**name**                            | `string`  | The stock location's internal name.                                                                                                                                                                 |
| attributes.**code**                            | `string`  | A string that you can use to identify the stock location (must be unique within the environment).                                                                                                   |
| attributes.**label\_format**                   | `string`  | The shipping label format for this stock location. Can be one of 'PDF', 'ZPL', 'EPL2', or 'PNG'.                                                                                                    |
| attributes.**suppress\_etd**                   | `boolean` | Flag it if you want to skip the electronic invoice creation when generating the customs info for this stock location shipments.                                                                     |
| 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.**address**                      | `object`  | The stock location's phisical address, used as the shipping addresses "from" address.                                                                                                               |
| relationships.**inventory\_stock\_locations**  | `array`   | The inventory stock locations associated to the stock location.                                                                                                                                     |
| relationships.**inventory\_return\_locations** | `array`   | The inventory return locations associated to the stock location.                                                                                                                                    |
| relationships.**stock\_items**                 | `array`   | The items stocked in this location.                                                                                                                                                                 |
| relationships.**stock\_transfers**             | `array`   | The stock transfers associated to the stock location.                                                                                                                                               |
| relationships.**stores**                       | `array`   | The associated stores.                                                                                                                                                                              |
| relationships.**attachments**                  | `array`   | The associated attachments.                                                                                                                                                                         |
| 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_locations/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.