UpdateCategoryInput
Input parameter for the updateCategory mutation. A category ref is unique within the bounds of the specified catalogue, which together makes up the unique identifier for the Category 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. 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 reference of the Category to be updated.
Max character limit: 100.
ProductCatalogueKey!)
The reference of the ProductCatalogue in which this Category resides.
String)
Type of the Category, 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 Category.
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 Category. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
String)
The name of the Category
String)
A short description of the Category
CategoryKey)
The reference to the parent of this Category, if any. The parent Category must be a part of the same ProductCatalogue (see catalogue field). The parent Category must already exist.
Max character limit: 36.
[CategoryKey])
List of child Category references, if any. Child categories must be a part of the same ProductCatalogue (see catalogue field). The child Category must already exist.