SKUs describe specific product variations that are being sold. A unique code identifies each SKU, which can be either the EAN code, the UPC, or any other code format. The SKU name, description, and image URL are best suited for internal usage (Commerce Layer is not a CMS).
A SKU object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field | Type | Description |
type |
|
|
id |
| The SKU unique identifier |
links.self |
| The SKU endpoint URL |
attributes.code |
| The SKU code, that uniquely identifies the SKU within the organization. |
attributes.name |
| The internal name of the SKU. |
attributes.description |
| An internal description of the SKU. |
attributes.image_url |
| The URL of an image that represents the SKU. |
attributes.pieces_per_pack |
| The number of pieces that compose the SKU. This is useful to describe sets and bundles. |
attributes.weight |
| The weight of the SKU. If present, it will be used to calculate the shipping rates. |
attributes.unit_of_weight |
| Can be one of 'gr', or 'oz' |
attributes.hs_tariff_number |
| The Harmonized System Code used by customs to identify the products shipped across international borders. |
attributes.inventory |
| Aggregated information about the SKU's inventory. Returned only when retrieving a single SKU. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| 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 |
| The SKU's shipping category |
relationships.prices |
| The list of prices associated with the SKU. |
relationships.stock_items |
| The list of stock items associated with the SKU. |
relationships.delivery_lead_times |
| The list of delivery lead times associated with the SKU. |
relationships.sku_options |
| The list of SKU options available for the SKU. |
relationships.attachments |
| The associated attachments. |
meta.mode |
| The resource environment (can be one of |