Stock items
A stock item keeps the available inventory of an SKU in a given stock location. When you create a line item, the associated SKU must be available in one of the market's stock locations. When you place an order, the stock item quantities get decremented. When an order is cancelled, or a return is approved, the stock item quantities get incremented.
A stock item object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The stock item unique identifier |
links.self |
| The stock item endpoint URL |
attributes.sku_code |
| The code of the associated sku. |
attributes.quantity |
| The stock item quantity. |
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.stock_location |
| The associated stock location. |
relationships.sku |
| The associated stock sku. |
meta.mode |
| The resource environment (can be one of |
