Category Details Input
Input representation of the request to get category details.
This example shows a sample request to get category details with eligible promotions.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
additionalContextData | Context Data Input | Additional nodes that are added to the custom or default context definition. The maximum number of supported nodes is 10. | Optional | 60.0 |
catalogId | String | ID of the catalog. If the catalog ID is specified, then the API returns the list of offers from the catalog with the pricing details related to the catalog. | Optional | 60.0 |
contextDefinition | String | API 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. | Optional | 60.0 |
contextMapping | String | Default 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. | Optional | 60.0 |
customFields | String[] | List of category fields to retrieve in the response. | Optional | 60.0 |
correlationId | String | Unique identifier value that’s attached to the requests and messages, and accepts references to a particular transaction or event chain. | Optional | 60.0 |
enableQualification | Boolean | Indicates whether to enable qualification rules for the categories ( true ) or not ( false ). The default value is true. The Qualification Procedure toggle from the Product Discovery Settings page from Setup overrides this property. For example, if the Qualification Procedure toggle is disabled, then setting the enableQualification property to true has no effect and the qualificationContext property in the API response isn’t returned. | Optional | 60.0 |
filter | Filter Input | Filters records based on supported criteria. The supported property is name. The supported operators are eq; in; contains; gt—Specifies a greater than criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only; lt—Specifies a less than criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only; gte—Specifies a greater than or equal to criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only; or lte—Specifies a less than or equal to criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only. If multiple criteria are specified, then the resultant criteria are combined by using the and operator. | Optional | 60.0 |
qualificationProcedure | String | API name of the custom qualification procedure that’s used for the qualification process. If this property isn’t specified, then the default qualification procedure is executed. | Optional | 60.0 |
userContext | User Context Input | User context details. For example, account ID or contact ID. | Optional | 60.0 |
usePromotions | Boolean | Indicates 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. | Optional | 66.0 |