VTEX · Schema

CreateInteractionRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
startDate string
source string This attribute defines the entity responsible for the interaction. Possible values include `seller` or `channel`.
origin string This attribute defines where the interaction originated from. Possible values include `catalog`, `price` or `inventory`. Interactions are usually used to deal with a single type of process at a time.
context string This field informs Sent Offers about an offer's lifecycle. When the integration has been recently installed, and producst are being sent for the first time, the value should be `setup`. If it's an upd
View JSON Schema on GitHub

JSON Schema

vtex-createinteractionrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateInteractionRequest",
  "title": "CreateInteractionRequest",
  "required": [
    "startDate",
    "source",
    "origin",
    "context"
  ],
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "default": "2020-10-29"
    },
    "source": {
      "type": "string",
      "description": "This attribute defines the entity responsible for the interaction. Possible values include `seller` or `channel`.",
      "default": "seller"
    },
    "origin": {
      "type": "string",
      "description": "This attribute defines where the interaction originated from. Possible values include `catalog`, `price` or `inventory`. Interactions are usually used to deal with a single type of process at a time. However, there are situations in which data about catalog, price and inventory are added in the same interaction.",
      "default": "catalog"
    },
    "context": {
      "type": "string",
      "description": "This field informs Sent Offers about an offer's lifecycle. When the integration has been recently installed, and producst are being sent for the first time, the value should be `setup`. If it's an update log, when the interaction is already up and running, the value should be `ongoing`.",
      "default": "setup"
    }
  }
}

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