Configuring the order of facets (dimensions) in refinements lists

You can configure your refinements list to begin with any group of facets (dimensions) in any order. Your configuration applies to the navigation section of the search response (/gsadmin/v1/search response).

To specify a display order for selected facets in your application, follow these steps:

  1. Use one of the following endpoints to export configuration of the Guided Navigation catalog, in JSON format or in ZIP format: 

    GET /gsadmin/v1/app_name/facets/default (JSON format)

    or 

    GET /gsadmin/v1/app_name/facets/default .zip (ZIP format)

    The default configuration of the Guided Navigation content item is returned: 

    { 
  "ecr:type": "content-item", 
  "contentItem": {
    "@type": "GuidedNavigation", 
    "@name": "Global Facet Order", 
    "showAll": true,
	  	"navigation": [] 
  }, 
  "triggers": [
    {
      "exactLocation": false
    }
  ], 
  "priority": 10 
}

    Note

    When the navigation attribute is empty as shown above, none of the facets in the refinements list are explicitly ordered. Instead, all the facets appear in an order determined by the system.

    For information about the attributes in this configuration, see #s0102attributesoftheguidednavigationc01.

  2. In the navigation attribute, include a RefinementMenu element for each facet that you want to include among the explicitly ordered facets. Arrange the RefinementMenu elements in the order in which you want the corresponding facets to appear in the refinements list.

    For example, if you want the four following facets to appear in the order Category, Price Range, Brand, and Color, modify the navigation[] attribute as follows: 

     "navigation": [
   { 
     "@type": "RefinementMenu", 
     "dimensionName ": "product.category" 
   }, 
			  
			 { 
      "@type" : "RefinementMenu", 
      "dimensionName": "product.priceRange" 
    }, 
    { 
      "@type": "RefinementMenu", 
      "dimensionName": "product.brand" 
    }, 
			 { 
      "@type": "RefinementMenu", 
      "dimensionName": "product.color" 
    } 
  ]

  3. Use one of the following endpoints to import configuration of the Guided Navigation content item, in JSON format or in ZIP format: 

     PUT /gsadmin/v1/app_name/facets/default (JSON format)

    or 

     PUT /gsadmin/v1/app_name/facets/default .zip (ZIP format)

    Note

    If the GuidedNavigation content item does not exist, you must use the POST method to create it. You cannot, however, use POST to update an existing content item.

  4. View the changes in your Preview environment to verify that they are correct.

  5. Publish your catalog to promote your changes to your production environment.

The following table summarized that attributes of the GuidedNavigation content item.

Attribute

Value

@type

Required. Must be set to GuidedNavigation

@name

Optional. A name for this rule that is displayed in tools.

showAll

Optional. True (the default) causes all facets applicable to the shopper's current navigation state to be displayed in refinement lists, after the facets explicitly ordered by the navigation attribute. The facets not included in the navigation attribute are ordered by the system.

False limits the facets included in the refinements list to those included in the navigation attribute.

navigation

Required. A list of facet objects. Each facet object has:

In the refinements list, the facets appear in the order in which the facet objects are listed in the navigation attribute.

triggers

Not applicable. Do not modify default.

priority

Not applicable. Do not modify default.

Copyright © Legal Notices