VTEX · Schema

GetById

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string
name	string
description	string
instructions	string
formatted_address	string
address	object
isActive	boolean
warehouseId	string
businessHours	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetById",
  "title": "GetById",
  "required": [
    "id",
    "name",
    "description",
    "instructions",
    "formatted_address",
    "address",
    "isActive",
    "warehouseId",
    "businessHours"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "instructions": {
      "type": "string"
    },
    "formatted_address": {
      "type": "string"
    },
    "address": {
      "title": "Address4",
      "required": [
        "postalCode",
        "country",
        "city",
        "state",
        "neighborhood",
        "street",
        "number",
        "complement",
        "location"
      ],
      "type": "object",
      "properties": {
        "postalCode": {
          "type": "string"
        },
        "country": {
          "title": "Country",
          "required": [
            "acronym",
            "name"
          ],
          "type": "object",
          "properties": {
            "acronym": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "example": {
            "acronym": "BRA",
            "name": "Brazil"
          }
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "neighborhood": {
          "type": "string"
        },
        "street": {
          "type": "string"
        },
        "number": {
          "type": "string"
        },
        "complement": {
          "type": "string"
        },
        "location": {
          "title": "Location5",
          "required": [
            "latitude",
            "longitude"
          ],
          "type": "object",
          "properties": {
            "latitude": {
              "type": "number"
            },
            "longitude": {
              "type": "number"
            }
          },
          "example": {
            "latitude": -22.974477767944336,
            "longitude": -43.18672561645508
          }
        }
      },
      "example": {
        "postalCode": "22220070",
        "country": {
          "acronym": "BRA",
          "name": "Brazil"
        },
        "city": "Rio de Janeiro",
        "state": "RJ",
        "neighborhood": "Catete",
        "street": "Rua Artur Bernardes",
        "number": "",
        "complement": "",
        "location": {
          "latitude": -22.92860984802246,
          "longitude": -22.92860984802246
        }
      }
    },
    "isActive": {
      "type": "boolean"
    },
    "warehouseId": {
      "type": "string",
      "nullable": true
    },
    "businessHours": {
      "type": "array",
      "items": {
        "title": "BusinessHour",
        "required": [
          "dayOfWeek",
          "openingTime",
          "closingTime"
        ],
        "type": "object",
        "properties": {
          "dayOfWeek": {
            "type": "integer",
            "format": "int32"
          },
          "openingTime": {
            "type": "string"
          },
          "closingTime": {
            "type": "string"
          }
        },
        "example": {
          "dayOfWeek": 1,
          "openingTime": "08:00:00",
          "closingTime": "20:00:00"
        }
      },
      "description": ""
    }
  },
  "example": {
    "id": "12345",
    "name": "Loja Barra da Tijuca",
    "description": "Loja Barra da Tijuca",
    "instructions": "Loja Barra da Tijuca",
    "formatted_address": "undefined",
    "address": {
      "postalCode": "22220070",
      "country": {
        "acronym": "BRA",
        "name": "Brazil"
      },
      "city": "Rio de Janeiro",
      "state": "RJ",
      "neighborhood": "Catete",
      "street": "Rua Artur Bernardes",
      "number": "",
      "complement": "",
      "location": {
        "latitude": -22.92860984802246,
        "longitude": -22.92860984802246
      }
    },
    "isActive": true,
    "warehouseId": null,
    "businessHours": [
      {
        "dayOfWeek": 0,
        "openingTime": "11:00:00",
        "closingTime": "21:00:00"
      }
    ]
  }
}

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-getbyid"

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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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