VTEX · Example Payload

Vtex Create Product Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Create Product Example is an example object payload from VTEX, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titlerequestresponse

Example Payload

{
  "title": "VTEX Create Product - Example Request and Response",
  "request": {
    "method": "POST",
    "url": "https://{accountName}.vtexcommercestable.com.br/api/catalog/pvt/product",
    "headers": {
      "X-VTEX-API-AppKey": "{your-app-key}",
      "X-VTEX-API-AppToken": "{your-app-token}",
      "Accept": "application/json",
      "Content-Type": "application/json"
    },
    "body": {
      "Name": "Lightweight Running Shoe",
      "CategoryId": 42,
      "BrandId": 7,
      "RefId": "SHOE-RUN-001",
      "Title": "Lightweight Running Shoe - Best for Marathon Training",
      "LinkId": "lightweight-running-shoe",
      "Description": "<p>Our best-in-class running shoe designed for marathon runners and daily joggers alike. Features advanced cushioning and breathable mesh upper.</p>",
      "DescriptionShort": "Lightweight marathon running shoe with advanced cushioning",
      "Keywords": "running shoe, marathon, lightweight, sport",
      "IsVisible": true,
      "IsActive": true,
      "ShowWithoutStock": false,
      "Score": 5
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "Id": 9876543,
      "Name": "Lightweight Running Shoe",
      "DepartmentId": 12,
      "CategoryId": 42,
      "BrandId": 7,
      "BrandName": "SpeedRun",
      "LinkId": "lightweight-running-shoe",
      "RefId": "SHOE-RUN-001",
      "IsVisible": true,
      "Description": "<p>Our best-in-class running shoe designed for marathon runners and daily joggers alike.</p>",
      "DescriptionShort": "Lightweight marathon running shoe with advanced cushioning",
      "ReleaseDate": "2026-05-03T00:00:00",
      "KeyWords": "running shoe, marathon, lightweight, sport",
      "Title": "Lightweight Running Shoe - Best for Marathon Training",
      "IsActive": true,
      "TaxCode": "",
      "MetaTagDescription": "",
      "ShowWithoutStock": false,
      "Score": 5
    }
  }
}

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-create-product-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.