Product API Configuration Options

Configuration options for product API behavior and feature flags, such as list and search.

JSON example

{
  "filterByAssortment": true,
  "includeCategoryHierarchies": true
}

Properties

Name Type Description Required or Optional Available Version
filterByAssortment Boolean When true, resolves assortment IDs and filters products by assortments. When false or not set, calls the Configure, Price, Quote (CPQ) API directly without assortment filtering. Optional 68.0
includeCategoryHierarchies Boolean When true, enriches the response with category hierarchies for all product categories. Each hierarchy contains the complete path from root to leaf with breadcrumb and depth. Currently supported only in the product list API. Optional 68.0