InventoryQuantity
An InventoryQuantity is a specific count of a certain quantity type, condition, and storage area. The ref field will be the unique identifier for this quantity within the specified Inventory Catalogue, as identified by the catalogue field.
The InventoryQuantity is an orchestrateable entity. Events for these should specify a parent entity of Inventory Catalogue.
Backward Compatibility Note
With the introduction of Global Inventory, we have introduced new data structures to support this functionality. Existing orchestration enabled clients will have access to their existing product based data via the COMPATIBILITY:<retailerId> catalogue.
For more information, please refer to the Backward Compatibility Guide on Lingo
Implements
Fields
ID!)
ID of the object. For internal use, should not be used externally or by any business logic
DateTime)
Time of creation
DateTime)
Time of last update
String!)
The unique reference identifier for the Inventory Quantity
String!)
Type of the InventoryQuantity, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
The type field can be used to differentiate between Inventory Quantity workflows. Example types include LAST_ON_HAND, RESERVED, EXPECTED, and ADJUSTMENT.
String)
The current status of the InventoryQuantity.
By default, the initial value will be CREATED, however no other status values are enforced by the platform.
The status field is also used within ruleset selection during orchestration. For more info, see Orchestration
String!)
The reference used for workflow identification. This is defined by a combination of the entity name and the type, in the format [EntityName]::[Type]. For example, an Order of type CC will have the workflowRef "ORDER::CC".
Int!)
The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
[Attribute])
A list of attributes associated with this Inventory Quantity. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
Int)
The actual amount of this specific Quantity record
String)
The condition of the Inventory Quantity value. The platform does not enforce any values here. Examples could include NEW, USED, or DAMAGED
DateTime)
The date and time the quantity is expected to arrive
String)
A reference to the Storage Area where this inventory is kept
InventoryCatalogue)
The Inventory Catalogue in which this Quantity is managed
InventoryPosition)
The associated parent Inventory Position of which this Quantity applies