Categories are used to create hierarchical structures within a catalogue.Categories serves as a means for structuring products in meaningful classifications
Categories are used to organize products within catalogues. Categories can be nested in a hierarchy structure of any depth. The catalogue data model defines attributes which can hold data for each category. Attributes can be attached to categories in the master catalogue to define a structure of attributes available to products depending on their category placement in the master catalogue.
OK
No more than 5000 categories can be requested at a time. If no limit is provided, the default limit of 1000 will be used
Number of categories to return
1000Only get categories with id larger than this id
OK
Use to get a map from an identifier to the internal id of a category in the system. Identifiers are based on attribute values that hold references to external systems. Thus, the identifier can be the id of the category in an external system. You can then use this map to know which category id to update or delete based on the id of the corresponding category in the external system
Alias of identifier type
OK
Use to get a map from an identifier to the internal id of a category in the system. Identifiers are based on attribute values that hold references to external systems. Thus, the identifier can be the id of the category in an external system. You can then use this map to know which category id to update or delete based on the id of the corresponding category in the external system
Alias of identifier type
Identifier value
OK
Id of category
Indicate if only uids of referenced to global list values shall be returned instead of the materialized values
falseId of category to attach attribute to
Uid of attribute to attach
Represents where attributes added to categories are editable on entities placed in that category
Sort order of attribute on category
No content
Id of category the attribute is attached to
Uid of attached attribute
Represents where attributes added to categories are editable on entities placed in that category
Sort order of attribute on category
OK
No content
#Available from v.3.5.0
Id of category
Uid of enrichment insight to toggle ignore for
Indicate whether to ignore the insight for the given enrichment insight and category
OK
No content
A maximum of 5000 categories can be created in one request
Model for creating a new category
Uid of catalogue to add category to
Id of parent id to place category underneath (set as null, of category shall be at root level of catalogue)
Sort order of category compared to other categories at the same level i the catalogue
Set if products for this category is found by search query set on category
Workflow state to set on the category
Id of category to update
Model representing a category update
Set to update sort order of category compared to other categories at the same level in the catalogue (set as null if you do not want to update this)
Workflow state to set on the category
OK
No content
Wrapper for product children batch query
Category ids to request products for
Indicate whether archibed products shall also be included
OK
Use to get a map from an identifier to the internal id of a category in the system. Identifiers are based on attribute values that hold references to external systems. Thus, the identifier can be the id of the category in an external system. You can then use this map to know which category id to update or delete based on the id of the corresponding category in the external system
Provide an identifier alias along with an array of identifiers to get the internal entity ids matching those identifiers
The alias of the identifier
Array of identifiers to return internal ids for
OK
Id of category
OK
No content
No more than 5000 categories can be requested at a time.
Define which categories to fetch data for and what data to fetch
Ids of categories to return
Defines which attribute values to return
If IncludeValues is Scopes, define which scopes to return values for here
If IncludeValues is Aliases, define aliases of the attributes to include values for
If IncludeValues is Uids, define uids of the attributes to include values for
Only return values for specific languages
Only return values for specific dimension segments
Indicate if only uids of referenced to global list values shall be returned instead of the materialized values
Get attribute values back in time
#Available from v.3.5.0
Uid of enrichment insight to toggle ignore for
Indicate whether to ignore the insight for the given enrichment insight and categories
OK
No content
Extended search model used for searching products or variants in PIM with support for paging and sorting
Include archived items in result
OK