The SKU object
A comprehensive list of the SKU resource's attributes and relationships
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 |
|
|
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.created_at |
| Time at which the resource was created. |
attributes.description |
| An internal description of the SKU. |
attributes.do_not_ship |
| Indicates if the SKU doesn't generate shipments. |
attributes.do_not_track |
| Indicates if the SKU doesn't track the stock inventory. |
attributes.hs_tariff_number |
| The Harmonized System Code used by customs to identify the products shipped across international borders. |
attributes.image_url |
| The URL of an image that represents the SKU. |
attributes.inventory |
| Aggregated information about the SKU's inventory. Returned only when retrieving a single SKU. |
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. |
attributes.name |
| The internal name of the SKU. |
attributes.pieces_per_pack |
| The number of pieces that compose the SKU. This is useful to describe sets and bundles. |
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.unit_of_weight |
| The unit of weight. One of 'gr', 'oz', or 'lb'. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.weight |
| The weight of the SKU. If present, it will be used to calculate the shipping rates. |
relationships.attachments |
| The associated attachments. |
relationships.delivery_lead_times |
| The associated delivery lead times. |
relationships.events |
| The associated events. |
relationships.jwt_customer |
| The customer associated to the JWT. |
relationships.jwt_markets |
| The markets associated to the JWT. |
relationships.jwt_stock_locations |
| The stock locations associated to the JWT. |
relationships.links |
| The associated links. |
relationships.prices |
| The associated prices. |
relationships.shipping_category |
| The associated shipping category. |
relationships.sku_options |
| The list of SKU options available for the SKU. |
relationships.stock_items |
| The associated stock items. |
relationships.stock_reservations |
| The associated stock reservations. |
relationships.tags |
| The associated tags. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated