Categories
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
Created
Bad Request
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
OK
No content
Id of category to get products for
Include archived products
falseOK
OK
Wrapper for product children batch query
Category ids to request products for
Indicate whether archibed products shall also be included
OK
OK
Id of category to get product count for
Include archived products in count
falseOK
OK
Wrapper for product children batch query
Category ids to request products for
Indicate whether archibed products shall also be included
OK
OK
Alias of identifier type
Identifier value
OK
OK
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
OK
Id of category
Indicate if only uids of referenced to global list values shall be returned instead of the materialized values
falseOK
Not Found
Id of category
OK
No content
OK
No content
Define which categories to fetch data for and what data to fetch
Ids of categories to return
Defines which attribute values to return
1= All: Return all attribute values2= Scopes: Return values for scopes specified in request3= Aliases: Return values for attribute aliases specified in request4= ScopesAndAliases: Return values for attributes in specified scopes, plus values in the attributes specified by alias5= Uids: Return values for attribute uids specified in request
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
OK
Bad Request
Id 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
0= ProductAndVariant: Attributes are editable on both products and variants1= Product: Attributes are editable on products only2= Variant: Attributes are editable on variants only3= None: Attributes are not editable on any entity
Sort order of attribute on category
OK
No content
Bad Request
No content
Id of category the attribute is attached to
Uid of attached attribute
OK
No content
OK
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
0= ProductAndVariant: Attributes are editable on both products and variants1= Product: Attributes are editable on products only2= Variant: Attributes are editable on variants only3= None: Attributes are not editable on any entity
Sort order of attribute on category
OK
No content
OK
No content
Uid of enrichment insight to get for batch of categories
OK
OK
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
OK
No content
Uid of enrichment insight to toggle ignore for
Indicate whether to ignore the insight for the given enrichment insight and categories
OK
No content
OK
No content
Search model used for searching products or variants in PIM
Include archived items in result
OK
OK
Get paged result of categories matching certain criteria. Result mapped with headers and item results
Extended search model used for searching products or variants in PIM with support for paging and sorting
Include archived items in result
OK
OK
Last updated