VTEX · Example Payload

Vtex Get Allcollections Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Allcollections 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": "GET-AllCollections",
  "method": "GET",
  "path": "/api/catalog_system/pvt/collection/search",
  "summary": "VTex Get all collections",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "paging": {
          "page": 1,
          "perPage": 11,
          "total": 11,
          "pages": 1,
          "limit": 3000
        },
        "items": [
          {
            "id": 149,
            "name": "Varej\u00e3o",
            "searchable": true,
            "highlight": true,
            "dateFrom": "2020-02-14T11:26:00",
            "dateTo": "2070-02-14T11:26:00",
            "totalSku": 2,
            "totalProducts": 1,
            "type": "Hybrid",
            "lastModifiedBy": null
          },
          {
            "id": 150,
            "name": "Varej\u00e3o",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2017-09-27T10:47:00",
            "dateTo": "2027-09-27T10:47:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 151,
            "name": "asdfghj",
            "searchable": true,
            "highlight": true,
            "dateFrom": "2020-05-20T11:50:00",
            "dateTo": "2070-05-20T11:50:00",
            "totalSku": 5,
            "totalProducts": 5,
            "type": "Hybrid",
            "lastModifiedBy": null
          },
          {
            "id": 152,
            "name": "George",
            "searchable": true,
            "highlight": true,
            "dateFrom": "2020-05-21T16:26:00",
            "dateTo": "2070-05-31T23:59:00",
            "totalSku": 2,
            "totalProducts": 1,
            "type": "Hybrid",
            "lastModifiedBy": null
          },
          {
            "id": 153,
            "name": "Test",
            "searchable": true,
            "highlight": false,
            "dateFrom": "2017-09-27T10:47:00",
            "dateTo": "2017-09-27T10:47:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 154,
            "name": "J\u00falia",
            "searchable": true,
            "highlight": true,
            "dateFrom": "2021-01-21T19:30:00",
            "dateTo": "2070-01-21T19:30:00",
            "totalSku": 2,
            "totalProducts": 2,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 155,
            "name": "aaa",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2021-02-08T16:19:00",
            "dateTo": "2021-02-08T16:19:00",
            "totalSku": 3,
            "totalProducts": 3,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 156,
            "name": "All",
            "searchable": true,
            "highlight": false,
            "dateFrom": "2010-01-01T00:00:00",
            "dateTo": "2070-01-01T00:00:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Automatic",
            "lastModifiedBy": null
          },
          {
            "id": 157,
            "name": "Inverno",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2021-07-12T16:00:00",
            "dateTo": "2021-09-23T16:00:00",
            "totalSku": 2,
            "totalProducts": 2,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 158,
            "name": "Cole\u00e7\u00e3o halloween",
            "searchable": false,
            "highlight": false,
            "dateFrom": "2021-10-22T17:56:00",
            "dateTo": "2070-10-22T17:56:00",
            "totalSku": 2,
            "totalProducts": 2,
            "type": "Manual",
            "lastModifiedBy": null
          },
          {
            "id": 159,
            "name": "Winter",
            "searchable": true,
            "highlight": false,
            "dateFrom": "2021-09-27T10:47:00",
            "dateTo": "2027-09-27T10:47:00",
            "totalSku": 0,
            "totalProducts": 0,
            "type": "Manual",
            "lastModifiedBy": null
          }
        ]
      }
    }
  ]
}

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-get-allcollections-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.