VTEX · Schema

Index

Index information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
name string Index name.
acronym string Data entity name.
isGlobal boolean Defines whether the index is global (`true`) or not (`false`).
multiple boolean Determines whether the values need to be unique. If `false`, values must be unique.
fields string Comma-separated fields of the index.
View JSON Schema on GitHub

JSON Schema

vtex-index-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Index",
  "title": "Index",
  "type": "object",
  "description": "Index information.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Index name."
    },
    "acronym": {
      "type": "string",
      "description": "Data entity name."
    },
    "isGlobal": {
      "type": "boolean",
      "description": "Defines whether the index is global (`true`) or not (`false`).",
      "deprecated": true
    },
    "multiple": {
      "type": "boolean",
      "description": "Determines whether the values need to be unique. If `false`, values must be unique."
    },
    "fields": {
      "type": "string",
      "description": "Comma-separated fields of the index."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-index"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.