The stock line item object
A comprehensive list of the stock line item resource's attributes and relationships
A stock line item object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/stock_line_items
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The stock line item unique identifier |
links.self |
| The stock line item endpoint URL |
attributes._decrement_stock |
| Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress. |
attributes._release_stock |
| Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress. |
attributes._reserve_stock |
| Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress. |
attributes.bundle_code |
| The code of the associated bundle. |
attributes.created_at |
| Time at which the resource was created. |
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.quantity |
| The line item quantity. |
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.sku_code |
| The code of the associated SKU. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.line_item |
| The associated line item. |
relationships.shipment |
| The associated shipment. Optional for do not ship SKUs. |
relationships.sku |
| The associated SKU. |
relationships.stock_item |
| The associated stock item. Optional for do not track SKUs. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated