# The SKU object

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

## Fields

| Field                                   | Type       | Description                                                                                                                                                                                         |
| --------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                | `string`   | `skus`                                                                                                                                                                                              |
| **id**                                  | `string`   | The SKU unique identifier                                                                                                                                                                           |
| links.**self**                          | `string`   | The SKU endpoint URL                                                                                                                                                                                |
| attributes.**code**                     | `string`   | The SKU code, that uniquely identifies the SKU within the organization.                                                                                                                             |
| attributes.**name**                     | `string`   | The internal name of the SKU.                                                                                                                                                                       |
| attributes.**description**              | `string`   | An internal description of the SKU.                                                                                                                                                                 |
| attributes.**image\_url**               | `string`   | The URL of an image that represents the SKU.                                                                                                                                                        |
| attributes.**pieces\_per\_pack**        | `integer`  | The number of pieces that compose the SKU. This is useful to describe sets and bundles.                                                                                                             |
| attributes.**weight**                   | `float`    | The weight of the SKU. If present, it will be used to calculate the shipping rates.                                                                                                                 |
| attributes.**unit\_of\_weight**         | `string`   | The unit of weight. One of 'gr', 'oz', or 'lb'.                                                                                                                                                     |
| attributes.**hs\_tariff\_number**       | `string`   | The Harmonized System Code used by customs to identify the products shipped across international borders.                                                                                           |
| attributes.**do\_not\_ship**            | `boolean`  | Indicates if the SKU doesn't generate shipments.                                                                                                                                                    |
| attributes.**do\_not\_track**           | `boolean`  | Indicates if the SKU doesn't track the stock inventory.                                                                                                                                             |
| attributes.**inventory**                | `object`   | Aggregated information about the SKU's inventory. Returned only when retrieving a single SKU.                                                                                                       |
| attributes.**\_add\_tags**              | `string`   | Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.                                                              |
| attributes.**\_remove\_tags**           | `string`   | Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.                                                            |
| 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.**jwt\_custom\_claim**       | `object`   | The custom\_claim attached to the current JWT (if any).                                                                                                                                             |
| 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.**shipping\_category**    | `object`   | The associated shipping category.                                                                                                                                                                   |
| relationships.**prices**                | `array`    | The associated prices.                                                                                                                                                                              |
| relationships.**stock\_items**          | `array`    | The associated stock items.                                                                                                                                                                         |
| relationships.**stock\_reservations**   | `array`    | The associated stock reservations.                                                                                                                                                                  |
| relationships.**delivery\_lead\_times** | `array`    | The associated delivery lead times.                                                                                                                                                                 |
| relationships.**sku\_options**          | `array`    | The list of SKU options available for the SKU.                                                                                                                                                      |
| relationships.**sku\_list\_items**      | `array`    | The associated SKU list items.                                                                                                                                                                      |
| relationships.**sku\_lists**            | `array`    | The associated SKU lists.                                                                                                                                                                           |
| relationships.**attachments**           | `array`    | The associated attachments.                                                                                                                                                                         |
| relationships.**links**                 | `array`    | The associated links.                                                                                                                                                                               |
| relationships.**events**                | `array`    | The associated events.                                                                                                                                                                              |
| relationships.**tags**                  | `array`    | The associated tags. Cannot be passed by sales channels.                                                                                                                                            |
| relationships.**versions**              | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**jwt\_customer**         | `object`   | The customer associated to the JWT.                                                                                                                                                                 |
| relationships.**jwt\_markets**          | `array`    | The markets associated to the JWT.                                                                                                                                                                  |
| relationships.**jwt\_stock\_locations** | `array`    | The stock locations associated to the JWT.                                                                                                                                                          |
| relationships.**event\_stores**         | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                           | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |
