Skip to main content

InventoryResult

Result of an inventory reconciliation or reservation attempt.

type InventoryResult {
  success: Boolean!
  expiresAt: DateTime
  errorDetails: InventoryErrorDetails
}

Fields​

success ● Boolean!​

True if the operation completed successfully (even if quantities were adjusted). False if the operation failed and no valid result could be produced.

expiresAt ● DateTime​

Expiration date/time of the active reservation. Only set if a reservation exists.

errorDetails ● InventoryErrorDetails​

Optional structured details about the error. Null if success is true.

Example​

{
  "expiresAt": "2024-05-03T11:52:33Z",
  "errorDetails": {}
}