# The store object

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

## Fields

| Field                              | Type       | Description                                                                                                                                                                                         |
| ---------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                           | `string`   | `stores`                                                                                                                                                                                            |
| **id**                             | `string`   | The store unique identifier                                                                                                                                                                         |
| links.**self**                     | `string`   | The store endpoint URL                                                                                                                                                                              |
| attributes.**name**                | `string`   | The store's internal name.                                                                                                                                                                          |
| attributes.**code**                | `string`   | A string that you can use to identify the store (must be unique within the environment).                                                                                                            |
| attributes.**created\_at**         | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**         | `datetime` | 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.**market**           | `object`   | The associated market.                                                                                                                                                                              |
| relationships.**merchant**         | `object`   | The associated merchant.                                                                                                                                                                            |
| relationships.**stock\_location**  | `object`   | The associated stock location.                                                                                                                                                                      |
| relationships.**orders**           | `array`    | The associated orders.                                                                                                                                                                              |
| relationships.**payment\_methods** | `array`    | The associated payment methods.                                                                                                                                                                     |
| relationships.**events**           | `array`    | The associated events.                                                                                                                                                                              |
| relationships.**versions**         | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**    | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                      | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |