Reservations

Reservations temporarily reserve available quantity for customers when they add a Line Item to a Cart.

For a comprehensive overview of reservations, including how to configure and use them, see the Reservations section in the Inventory overview.

Representations

A Reservation represents a quantity of inventory that is reserved.

`id` String	Unique identifier of the Reservation.
`version` Int	Current version of the Reservation.
`expiresAt` DateTime	Date and time (UTC) the Reservation will no longer be valid. It can take a few minutes after expiry for the `state` to be updated to `Expired` and the stock to be released.
`inventoryEntry` InventoryEntryReference	Reference to the related InventoryEntry used to manage the inventory.
`quantity` Int	The quantity of inventory that is reserved.
`owner` Reference	Reference to the owner of the Reservation.
`lineItemId` String	Unique identifier of the LineItem this Reservation is associated with.
`state` ReservationState	Current state of the Reservation.
`createdAt` DateTime	Date and time (UTC) the Reservation was initially created.
`createdBy` CreatedBy	IDs and references that created the Reservation.
`lastModifiedAt` DateTime	Date and time (UTC) the Reservation was last updated.
`lastModifiedBy` LastModifiedBy	IDs and references that last modified the Reservation.

Status of the Reservation.

Created: The availableQuantity of the item has been reduced by the reserved quantity, but the quantityOnStock remains unchanged.
Updated: The reservation has been updated. If the quantity of an item changed, the availableQuantity is increased or decreased accordingly, while the quantityOnStock remains unchanged.
Released: The reserved quantity of the item has been released. The availableQuantity is increased accordingly.
Expired: The reservation has expired and the availableQuantity is increased accordingly. Reservation expirations are eventually consistent, meaning it can take a few minutes for the status to update after expiration.
Committed: The quantity of the item has been allocated for fulfillment. The quantityOnStock has been reduced by the reserved quantity.

`id` String	Unique identifier of the referenced Reservation.
`typeId` ReferenceTypeId	`reservation` Type of referenced resource.
`obj` Reservation	Contains the representation of the expanded Reservation. Only present in responses to requests with Reference Expansion for Reservations.