VTEX · Example Payload

Vtex Getproductquery Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getproductquery 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": "GetProductQuery",
  "method": "GET",
  "path": "/api/catalog-seller-portal/products/{param}",
  "summary": "VTex Get Product by external ID,  SKU ID, SKU external ID or slug",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "189371",
        "status": "active",
        "name": "VTEX 10 Shirt",
        "brandId": "1",
        "brandName": "AOC",
        "categoryIds": [
          "732"
        ],
        "categoryNames": [
          "/Men/Acessories/"
        ],
        "specs": [
          {
            "name": "Color",
            "values": [
              "Black",
              "White"
            ]
          },
          {
            "name": "Size",
            "values": [
              "S",
              "M",
              "L"
            ]
          }
        ],
        "attributes": [
          {
            "name": "Fabric",
            "value": "Cotton"
          },
          {
            "name": "Gender",
            "value": "Feminine"
          }
        ],
        "slug": "/vtex-shirt",
        "images": [
          {
            "id": "vtex_logo.jpg",
            "url": "https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg",
            "alt": "VTEX"
          }
        ],
        "skus": [
          {
            "id": "182907",
            "name": "VTEX Shirt Black Size S",
            "externalId": "1909621862",
            "manufacturerCode": "1234567",
            "isActive": true,
            "weight": 12,
            "dimensions": {
              "width": 1.5,
              "height": 2.1,
              "length": 1.6
            },
            "RealWeight": 1.6,
            "RealDimensions": {
              "width": 1.5,
              "height": 2.1,
              "length": 1.6
            },
            "specs": [
              {
                "name": "Color",
                "value": "Black"
              },
              {
                "name": "Size",
                "value": "S"
              }
            ],
            "images": [
              "vtex_logo.jpg"
            ]
          },
          {
            "id": "182908",
            "name": "VTEX Shirt White Size L",
            "externalId": "1909621862",
            "manufacturerCode": "1234568",
            "isActive": true,
            "weight": 12,
            "dimensions": {
              "width": 1.5,
              "height": 2.1,
              "length": 1.6
            },
            "specs": [
              {
                "name": "Color",
                "value": "White"
              },
              {
                "name": "Size",
                "value": "L"
              }
            ],
            "images": [
              "vtex_logo.jpg"
            ]
          }
        ],
        "transportModal": "123",
        "taxCode": "100",
        "origin": "vtxleo7778",
        "createdAt": "2022-10-31T16:28:25.578067Z",
        "updatedAt": "2022-10-31T16:28:25.578067Z"
      }
    }
  ]
}

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