Dynamic Grouping API - Bloomreach Commerce Experience Cloud - The Headless Digital Experience Platform Built for Commerce

Dynamic Grouping API

Dynamic Grouping is supported on the Search and Category APIs. For more information on Dynamic Grouping, read the Feature Overview.

 

Sample request

http://core.dxpapi.com/api/v1/core/?account_id=abcd&q=dress&groupby=gender&group_limit=3&start=0&rows=10

 

Parameters

Name

Description

groupby

Specifies that this is a grouping request.

 

Any single-valued, indexed, non-numeric attribute can be used as a value, and only one value can be used (that is, you can only group by a single attribute).

group_limit

Specifies the number of products to be returned in each group.

 

Default value is 1 (returns 1 product per group).

start

Specifies the starting point for groups.

rows

Specifies the number of groups to be returned.

 

Sample response

{
   "group_response": {
      "gender": {
         "matches": 4,
         "groups": [{
            "groupValue": "Mens",
            "doclist": {
               "numFound": 2,
               "start": 0,
               "docs": [
            {
               "pid": "1",
            },
            {
               "pid": "2",
            },
            ]
      }
   }
   {
      "groupValue": "Womens",
      "doclist": {
         "numFound": 2,
         "start": 0,
         "docs": [
         {
            "pid": "3",
         },
         {
            "pid": "4",
         }
         ]
      }
   }
   ]
   }
   },
   "facet_counts": {
      "facet_ranges": {},
      "facet_fields": {},
   },
   "category_map": {},
   "metadata": {}
}
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?