Comment on page
The stock reservation object
A comprehensive list of the stock reservation resource's attributes and relationships
A stock reservation object is returned as part of the response body of each successful list, retrieve, create or update API call to the
/api/stock_reservations endpoint.Field | Type | Description |
|---|---|---|
type | string | stock_reservations |
id | string | The stock reservation unique identifier |
links.self | string | The stock reservation endpoint URL |
attributes.status | string | The stock reservation status, one of 'draft' or 'pending'. |
attributes.quantity | integer | The stock reservation quantity. |
attributes.expires_at | datetime | The expiration date/time of this stock reservation. |
attributes._pending | boolean | Send this attribute if you want to mark this stock reservation as pending. |
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.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.line_item | object | The associated line item. |
relationships.order | object | The associated order. |
relationships.stock_item | object | The associated stock item. |
relationships.reserved_stock | object | The associated reserved stock. |
relationships.sku | object | The associated SKU. |
meta.mode | string | The resource environment (can be one of test or live) |
Last modified 1mo ago