VTEX · Example Payload

Vtex Scrolldocuments Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Scrolldocuments 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": "Scrolldocuments",
  "method": "GET",
  "path": "/api/dataentities/{dataEntityName}/scroll",
  "summary": "VTex Scroll documents",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "b818cbda-e489-11e6-94f4-0ac138d2d42e",
          "accountId": "14af940d-9300-4279-9355-61d44c2ff879",
          "accountName": "apiexamples",
          "dataEntityId": "Newsletter"
        }
      ]
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "Message": "Operation not found for this token: 'X'"
      }
    }
  ]
}

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-scrolldocuments-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.