Category List Input

Input representation of the request to get a list of categories.

This example shows a sample request to get a list of categories with eligible promotions.

NameTypeDescriptionRequired or OptionalAvailable Version
additional​ContextDataContext Data Input[]Additional nodes that are added to the custom or default context definition. The maximum number of supported nodes is 10.Optional60.0
catalog​IdStringID of the catalog.Required60.0
context​DefinitionStringAPI name of the custom context definition that’s sent for context creation. If this property isn’t specified, then the default context definition is used.Optional60.0
context​MappingStringDefault context mapping of the context definition. If a context mapping is specified, then the API checks whether the mapping belongs to the specified context definition to process the details for hydration.Optional60.0
correlation​IdStringUnique identifier value that’s attached to the requests and messages, and accepts references to a particular transaction or event chain.Optional60.0
customFieldsString[]List of additional custom fields to include in the response.Optional60.0
depthIntegerSpecifies the levels of subcategories to retrieve beneath the parent category. This parameter only applies when parentCategoryId is provided.Optional61.0
enableQualificationBooleanIndicates whether to enable qualification rules for the products (true) or not (false). The default value is true.Optional60.0
filterFilter InputFilters records based on supported criteria. The supported property is isQualified.Optional62.0
parent​CategoryIdStringID of the parent category whose subcategories you want to retrieve. If not specified, only root-level categories from the catalog are returned.Optional61.0
qualification​ProcedureStringAPI name of the custom qualification procedure that’s used for the product qualification process. If this property isn’t specified, then the default qualification procedure is executed.Optional60.0
usePromotionsBooleanIndicates whether to fetch eligible promotions from Global Promotion Management (GPM) for the requested category and its products (true) or not (false). If Promotion feature is enabled in the org and this property isn’t specified, then the default value is true. If the Promotion feature isn’t enabled, the default value is false.Optional66.0
user​ContextUser Context InputUser context details. For example, account ID or contact ID.Optional60.0

The supported operators are:

  • eq
  • in
  • contains—This value isn’t applicable if the Use Indexed Data For Product Listing and Search toggle from the Product Discovery Settings page from Setup is enabled.