UpdateVariantProductInput
Input parameter for the updateVariantProduct mutation. A variant product ref is unique within the bounds of the specified catalogue, which together makes up the unique identifier for the VariantProduct record.
During an update mutation, the following fields behave in an "UPSERT" or UPDATE / INSERT manner:
-
attributes-nameis the unique key for the Attributetypeandvalue. If an associated Attribute with a matchingnamealready exists, then thetypeandvaluefields will be updated, else it will be inserted. -
prices-typeandcurrencyare the unique key for the Pricevalue. If an associated Price with a matchingnameandtypealready exists, then thevaluefield will be updated, else it will be inserted. 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 theCOMPATIBILITY:<retailerId>catalogue.
For more information, please refer to the Backward Compatibility Guide on Lingo
Input Fields
String!)
The unique reference identifier for the Product.
Max character limit: 100.
ProductCatalogueKey!)
The Product Catalogue in which this Product is managed
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.
Max character limit: 50.
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
Max character limit: 50.
[AttributeInput])
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.
ProductKey)
Associated base 'Product' of this variant
String)
The Global Trade Item Number (GTIN) for this Product.
Max character limit: 20.
String)
The name of the Product
String)
A short description of the Product (max 255 chars)
[CategoryKey])
A list of references to the Category's to which this Product relates. Product categories must be a part of the same ProductCatalogue (see catalogue field). The Category must already exist.
[PriceInput])
A list of Prices for this Product
TaxTypeInput)
The tax information for this Product