VTEX · Schema

Attachment

Object containing information about SKU attachments.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Id integer Attachment ID.
Name string Attachment Name.
Keys array Attachment Keys.
Fields array Array containing Attachment fields.
IsActive boolean Defines if the Attachment is active or not.
IsRequired boolean Defines if the Attachment is required or not.
View JSON Schema on GitHub

JSON Schema

vtex-attachment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Attachment",
  "title": "Attachment",
  "required": [
    "Id",
    "Name",
    "Keys",
    "Fields",
    "IsActive",
    "IsRequired"
  ],
  "type": "object",
  "description": "Object containing information about SKU attachments.",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "Attachment ID."
    },
    "Name": {
      "type": "string",
      "description": "Attachment Name."
    },
    "Keys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Attachment Keys."
    },
    "Fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Field"
      },
      "description": "Array containing Attachment fields."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the Attachment is active or not."
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Defines if the Attachment is required or not."
    }
  },
  "example": {
    "Id": 3,
    "Name": "Mensagem",
    "Keys": [
      "nome;20",
      "foto;40"
    ],
    "Fields": [
      {
        "FieldName": "nome",
        "MaxCaracters": "20",
        "DomainValues": "Adalberto,Pedro,Jo\u00e3o"
      },
      {
        "FieldName": "foto",
        "MaxCaracters": "40",
        "DomainValues": null
      }
    ],
    "IsActive": true,
    "IsRequired": false
  }
}

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-attachment"
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.