VTEX · Example Payload

Vtex Get Facetsfacets Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Facetsfacets Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "get-facetsfacets",
  "method": "GET",
  "path": "/facets/{facets}",
  "summary": "VTex Get list of the possible facets for a given query",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "facets": [
          {
            "values": [
              {
                "id": "47",
                "quantity": 1,
                "name": "Clothing",
                "key": "category-2",
                "value": "clothing",
                "selected": false,
                "href": "shirt/blue/clothing?map=ft,color,category"
              }
            ],
            "type": "TEXT",
            "name": "Category",
            "hidden": false,
            "key": "category-2",
            "quantity": 1
          },
          {
            "values": [
              {
                "quantity": 1,
                "name": "",
                "key": "price",
                "selected": false,
                "range": {
                  "from": 45,
                  "to": 50
                }
              }
            ],
            "type": "PRICERANGE",
            "name": "Price",
            "hidden": false,
            "key": "price",
            "quantity": 1
          },
          {
            "values": [
              {
                "id": "2000045",
                "quantity": 1,
                "name": "New Offers!!",
                "key": "brand",
                "value": "new-offers--",
                "selected": false,
                "href": "shirt/blue/new-offers--?map=ft,color,brand"
              }
            ],
            "type": "TEXT",
            "name": "Brand",
            "hidden": false,
            "key": "brand",
            "quantity": 1
          },
          {
            "values": [
              {
                "id": "103",
                "quantity": 1,
                "name": "Blue",
                "key": "color",
                "value": "blue",
                "selected": true,
                "href": "shirt/blue/blue?map=ft,color,color"
              }
            ],
            "type": "TEXT",
            "name": "Color",
            "hidden": true,
            "key": "color",
            "quantity": 1
          },
          {
            "values": [
              {
                "id": "25",
                "quantity": 1,
                "name": "Apparel & Accessories",
                "key": "category-1",
                "value": "apparel---accessories",
                "selected": false,
                "href": "shirt/blue/apparel---accessories?map=ft,color,department"
              }
            ],
            "type": "TEXT",
            "name": "Department",
            "hidden": false,
            "key": "category-1",
            "quantity": 1
          },
          {
            "values": [
              {
                "id": "",
                "quantity": 1,
                "name": "Test",
                "key": "filter-test",
                "value": "test",
                "selected": false,
                "href": "shirt/blue/test?map=ft,color,filter-test"
              }
            ],
            "type": "TEXT",
            "name": "Filter Test",
            "hidden": false,
            "key": "filter-test",
            "quantity": 1
          },
          {
            "values": [
              {
                "id": "48",
                "quantity": 1,
                "name": "Tops",
                "key": "category-3",
                "value": "tops",
                "selected": false,
                "href": "shirt/blue/tops?map=ft,color,subcategory"
              }
            ],
            "type": "TEXT",
            "name": "Subcategory",
            "hidden": false,
            "key": "category-3",
            "quantity": 1
          }
        ],
        "sampling": false,
        "breadcrumb": [
          {
            "name": "shirt",
            "href": "/shirt?map=ft"
          },
          {
            "name": "Blue",
            "href": "/shirt/blue?map=ft,color"
          }
        ],
        "queryArgs": {
          "query": "shirt",
          "selectedFacets": [
            {
              "key": "color",
              "value": "blue"
            },
            {
              "key": "ft",
              "value": "shirt"
            }
          ]
        },
        "translated": false
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/vtex-get-facetsfacets-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.