VariantProduct
A VariantProduct is a variant based implementation of Product. A variation could be based on one or more attributes such as color, size, volume, etc. The ref field will be the unique identifier for this Product within the specified Product Catalogue, as identified by the catalogue field.
The VariantProduct is an orchestrateable entity. Events for these should specify a parent entity of Product 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
Connections
CategoryConnection)
A connection to the associated Categories of this Product
| Argument | Type | Description |
|---|---|---|
createdOn |
DateRange
|
|
updatedOn |
DateRange
|
|
ref |
[String!]
|
The unique reference identifier for the Category |
type |
[String!]
|
|
workflowRef |
[String!]
|
|
workflowVersion |
[Int!]
|
|
status |
[String]
|
|
name |
[String!]
|
The name of the Category |
summary |
[String]
|
A short description of the Category |
catalogue |
ProductCatalogueKey
|
|
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 Product
String!)
Type of the VariantProduct, 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 VariantProduct.
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 Product. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
ProductCatalogue!)
The Product Catalogue in which this Product is managed
String!)
The name of the Product
String)
A short description of the Product (max 255 chars)
[Price])
A list of Prices for this Product
TaxType)
The tax information for this Product
StandardProduct)
The associated Standard Product for this Variant Product
String!)
The Global Trade Item Number (GTIN) for this Product