InventoryCatalogue
The InventoryCatalogue is a structure that supports a grouping of inventory position data. The ref field will be the unique identifier for this catalogue.
The InventoryCatalogue is an orchestrateable entity, and the parent type for all InventoryPosition and InventoryQuantity orchestration events.
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
Connections
InventoryPositionConnection)
A connection to associated Inventory Positions
| Argument | Type | Description |
|---|---|---|
createdOn |
DateRange
|
|
updatedOn |
DateRange
|
|
ref |
[String!]
|
The unique reference identifier for the Inventory Position |
type |
[String!]
|
|
workflowRef |
[String!]
|
|
workflowVersion |
[Int!]
|
|
status |
[String]
|
|
productRef |
[String!]
|
A reference identifying a Product. The referenced product may or may not exist within one or more Product Catalogues. This is a loosely coupled association, since Product and Inventory are separate domains. |
onHand |
[Int]
|
The calculated on hand quantity based on the associated quantities, and rules in the orchestration workflow |
locationRef |
[String]
|
A reference identifying the Location where this inventory exists. This is a loosely coupled association. |
catalogue |
InventoryCatalogueKey
|
|
first |
Int
|
Returns the first n elements from the list |
last |
Int
|
Returns the last n elements from the list |
before |
String
|
Returns the elements in the list that come before the specified global ID |
after |
String
|
Returns the elements in the list that come after the specified global ID |
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 Catalogue
String!)
Type of the InventoryCatalogue, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
String)
The current status of the InventoryCatalogue.
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 Catalogue. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
String!)
The name of the Inventory Catalogue
String)
A short description of the Inventory Catalogue
[String])
A list of Retailer references associated with this Inventory Catalogue