Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-1915251.8 MB
Facets

Search by store facets

Retrieves products by store facets. The result order is descending, from the highest product ID to the lowest.

get/api/catalog_system/pub/facets/search/{term}

Path parameters

termstring required
Example:2

Term used for the facet's search. You can search for as much term as you want. The term can be: categoryId, brandId, specificationId.

Query parameters

mapstring required
Example:c

Mapping of the term. It can be c for a category, b for a brand, or specificationFilter_{specificationId} for a specification. You need to include a map for each term you are searching for in the same term's order.

Headers

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required
Example:application/json

Describes the type of the content being sent.

Response

OK

SpecificationFiltersobject required

Object with general information of specifications.

Example response

{
  "Departments": [
    {
      "Quantity": 2,
      "Position": null,
      "Name": "Beers Beers Mesmo",
      "Link": "/Beers-Beers-Mesmo/1?map=c,b",
      "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b",
      "Map": "c",
      "Value": "Beers-Beers-Mesmo"
    },
    {
      "Quantity": 2,
      "Position": null,
      "Name": "Merch Integration Category ||",
      "Link": "/Merch-Integration-Category-||/1?map=c,b",
      "LinkEncoded": "/Merch-Integration-Category-%7C%7C/1?map=c,b",
      "Map": "c",
      "Value": "Merch-Integration-Category-||"
    }
  ],
  "Brands": [
    {
      "Quantity": 2,
      "Position": null,
      "Name": "Merch XP",
      "Link": "/1/1234600/1/Merch-XP?map=c,c,b,b",
      "LinkEncoded": "/1/1234600/1/Merch-XP?map=c,c,b,b",
      "Map": "b",
      "Value": "Merch-XP"
    },
    {
      "Quantity": 2,
      "Position": null,
      "Name": "Zé",
      "Link": "/1/1234600/1/Ze?map=c,c,b,b",
      "LinkEncoded": "/1/1234600/1/Ze?map=c,c,b,b",
      "Map": "b",
      "Value": "Ze"
    }
  ],
  "SpecificationFilters": {},
  "CategoriesTrees": [
    {
      "Id": 1,
      "Quantity": 4,
      "Position": null,
      "Name": "Beers Beers Mesmo",
      "Link": "/Beers-Beers-Mesmo/1?map=c,b",
      "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b",
      "Map": "c",
      "Value": "Beers-Beers-Mesmo",
      "Children": [
        {
          "Id": 2,
          "Quantity": 1,
          "Position": null,
          "Name": "Lager Beers",
          "Link": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b",
          "LinkEncoded": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b",
          "Map": "c",
          "Value": "Lager-Beers",
          "Children": []
        }
      ]
    },
    {
      "Id": 1234571,
      "Quantity": 2,
      "Position": null,
      "Name": "Jogos",
      "Link": "/Jogos/1?map=c,b",
      "LinkEncoded": "/Jogos/1?map=c,b",
      "Map": "c",
      "Value": "Jogos",
      "Children": []
    }
  ],
  "PriceRanges": [],
  "Summary": {
    "Departments": {
      "DisplayedItems": 8,
      "TotalItems": 8
    },
    "CategoriesTrees": {
      "DisplayedItems": 13,
      "TotalItems": 13
    },
    "Brands": {
      "DisplayedItems": 10,
      "TotalItems": 10
    },
    "PriceRanges": {
      "DisplayedItems": 0,
      "TotalItems": 0
    },
    "SpecificationFilters": {}
  }
}