VTEX · Example Payload

Vtex Getcmspage Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getcmspage 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

Raw ↑
{
  "operationId": "GetCMSpage",
  "method": "GET",
  "path": "/_v/cms/api/{projectId}/{content-type}/{document-id}",
  "summary": "VTex Get CMS page",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "ad2fd81d-a53c-4281-8d01-a4fc2f274db3",
        "name": "Home",
        "type": "home",
        "status": "published",
        "versionId": "e3867e2c-7082-4fe6-83ed-c473242b6970",
        "versionStatus": "publishing",
        "sections": [
          {
            "id": "1651804180614",
            "name": "Alert",
            "data": {
              "dismissible": true,
              "icon": "Bell",
              "text": "alert text",
              "linkText": "alert link",
              "actionLink": "link.url.com"
            }
          },
          {
            "id": "1647286556072",
            "name": "Hero",
            "data": {
              "imageSrc": "https://storeframework.vtexassets.com/assets/vtex.file-manager-graphql/images/299f7d32-bb6a-40fd-82a0-4af5573ba572___17239443c00c1e894cff10ca05018058.jpg",
              "title": "New Products Available",
              "subtitle": "At FastStore you can shop the best tech of 2022. Enjoy and get 10% off on your first purchase.",
              "linkText": "See all",
              "link": "/office",
              "imageAlt": "hero image"
            }
          },
          {
            "id": "1649293076336",
            "name": "ProductShelf",
            "data": {
              "first": 5,
              "after": "0",
              "sort": "score_desc",
              "selectedFacets": [
                {
                  "key": "productClusterIds",
                  "value": "140"
                }
              ],
              "title": "Most Wanted!"
            }
          },
          {
            "id": "1649293548351",
            "name": "ProductTiles",
            "data": {
              "first": 3,
              "after": "0",
              "sort": "score_desc",
              "selectedFacets": [
                {
                  "key": "productClusterIds",
                  "value": "141"
                }
              ],
              "title": "Just Arrived"
            }
          },
          {
            "id": "1647286735093",
            "name": "BannerText",
            "data": {
              "title": "Receive our news and promotions in advance.",
              "caption": "Enjoy and get 10% off on your first purchase!!",
              "actionPath": "/office",
              "actionLabel": "See all"
            }
          },
          {
            "id": "1649293131632",
            "name": "ProductShelf",
            "data": {
              "first": 5,
              "after": "0",
              "sort": "score_desc",
              "selectedFacets": [
                {
                  "key": "productClusterIds",
                  "value": "142"
                }
              ],
              "title": "Deals & Promotions"
            }
          }
        ]
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "code": "NotFound",
        "message": "storeframework.myvtex.com.br not found",
        "source": "Vtex.Kube.Router.WebApi",
        "requestId": "b49522afa7c94b76885450f652be7bfc"
      }
    }
  ]
}

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

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