CreateCategoryInput
Input parameter for the createCategory mutation. A category ref should be unique within the bounds of the specified catalogue, which together makes up the unique identifier for the Category record.
The following default values will be set on creation:
-
status=CREATED -
workflowRef=PRODUCT_CATALOGUE::<product_catalogue.type> -
workflowVersion=<Workflow.majorVersion>.<Workflow.minorVersion>.
After data persistence, an orchestration event will be fired providing the opportunity to perform business logic within a workflow.
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 identifier used to identify an single Category within a ProductCatalogue. The ref must be unique within a ProductCatalogue.
Max character limit: 100.
ProductCatalogueKey!)
The reference of the ProductCatalogue in which this Category will reside. The ProductCatalogue must already exist.
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.
[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.