VTEX · Example Payload

Vtex Post Event Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Event 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

{
  "operationId": "post-event",
  "method": "POST",
  "path": "/event",
  "summary": "VTex Save events",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "Session Ping",
      "example": {
        "session": "zZlNhqz1vFJP6iPG5Oqtt",
        "anonymous": "Om1TNluGvgmSgU5OOTvkkd",
        "url": "https://example.com/search/?query=zapatilha",
        "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:83.0) Gecko/20100101 Firefox/83.0",
        "type": "search.query",
        "text": "zapatilha",
        "misspelled": true,
        "match": 392,
        "operator": "and"
      }
    },
    {
      "contentType": "application/json",
      "name": "Page Cart",
      "example": {
        "session": "zZlNhqz1vFJP6iPG5Oqtt",
        "anonymous": "Om1TNluGvgmSgU5OOTvkkd",
        "products": [
          {
            "productId": "ABC123",
            "quantity": 2
          },
          {
            "productId": "XYZ789",
            "quantity": 1
          }
        ],
        "type": "page.cart"
      }
    },
    {
      "contentType": "application/json",
      "name": "Empty Cart",
      "example": {
        "session": "zZlNhqz1vFJP6iPG5Oqtt",
        "anonymous": "Om1TNluGvgmSgU5OOTvkkd",
        "products": [],
        "type": "page.empty_cart"
      }
    },
    {
      "contentType": "application/json",
      "name": "Page Confirmation",
      "example": {
        "session": "zZlNhqz1vFJP6iPG5Oqtt",
        "anonymous": "Om1TNluGvgmSgU5OOTvkkd",
        "products": [
          {
            "productId": "ABC123",
            "price": 9.99,
            "quantity": 3
          },
          {
            "productId": "XYZ789",
            "price": 5.99,
            "quantity": 2
          }
        ],
        "order": "123ABC",
        "type": "page.confirmation"
      }
    },
    {
      "contentType": "application/json",
      "name": "Search Click",
      "example": {
        "type": "search.click",
        "productId": "12345",
        "position": 1,
        "url": "https://example.com/s?q=pneu&sort=score_desc&page=0",
        "text": "pneu",
        "agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
        "anonymous": "1ce47e50-3f10-4556-95d3-57d4881c03a4",
        "session": "51a53ce3-096d-4740-a6d0-3cf86085ba13"
      }
    },
    {
      "contentType": "application/json",
      "name": "Search Query",
      "example": {
        "session": "zZlNhqz1vFJP6iPG5Oqtt",
        "anonymous": "Om1TNluGvgmSgU5OOTvkkd",
        "url": "https://example.com/search/?query=zapatilha",
        "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:83.0) Gecko/20100101 Firefox/83.0",
        "type": "search.query",
        "text": "zapatilha",
        "misspelled": true,
        "match": 392,
        "operator": "and"
      }
    }
  ],
  "responseExamples": []
}

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-post-event-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.

GitHub Google LinkedIn

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