Reservation representation types in the platform.
The GraphQL schema provides Reservation representations but does not expose root Reservation queries or mutations.
Output types
Reservation
A Reservation holds inventory of an InventoryEntry for a Cart line item until the reservation expires or the Cart is ordered.
inventoryEntry | Reference to the related InventoryEntry used to manage the inventory. |
inventoryEntryRef | Reference to the related InventoryEntry used to manage the inventory. |
lineItemIdString | Unique identifier of the LineItem this Reservation is associated with. |
quantityLong | The quantity of inventory that is reserved. |
ownerRef | Reference to the owner of the Reservation. |
state | Current state of the Reservation. Can beCommitInProgress, Committed, Created, CreationInProgress, Expired, Released, UpdateInProgress, or Updated |
inventoryModeString | |
expiresAt | 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. |
idString | Unique identifier of the Reservation. |
versionLong | Current version of the Reservation. |
createdAt | Date and time (UTC) the Reservation was initially created. |
lastModifiedAt | Date and time (UTC) the Reservation was last updated. |
createdBy | IDs and references that created the Reservation. |
lastModifiedBy | IDs and references that last modified the Reservation. |
Reservation State
CommitInProgressCommittedCreatedCreationInProgressExpiredReleasedUpdateInProgressUpdated