VTEX · Schema

GetPricesRequestObject

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
items object
UtmSource string Traffic source, which indicates where the traffic originated from according to the `utm_source` value in the URL that led to the order. If there is no value, use `null`.
UtmMedium string Medium that indicates what type of traffic the customer originated from, represented by the `utm_medium` value in the URL that led to the order. If there is no value, use `null`.
UtmCampaign string Campaign name, represented by the `utm_campaign` value in the URL that led to the order. If there is no value, use `null`.
UtmInternalCampaign string Internal campaign name, represented by the `utmi_cp` value in the URL that led to the order. If there is no value, use `null`.
salesChannel string Represents Checkout's sales channel.
email string Customer's email address. If there is no value, use an empty string.
View JSON Schema on GitHub

JSON Schema

vtex-getpricesrequestobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetPricesRequestObject",
  "title": "GetPricesRequestObject",
  "required": [
    "items",
    "salesChannel",
    "email"
  ],
  "type": "object",
  "properties": {
    "items": {
      "$ref": "#/components/schemas/items"
    },
    "UtmSource": {
      "type": "string",
      "example": "facebook",
      "description": "Traffic source, which indicates where the traffic originated from according to the `utm_source` value in the URL that led to the order. If there is no value, use `null`.",
      "nullable": true
    },
    "UtmMedium": {
      "type": "string",
      "example": "social",
      "description": "Medium that indicates what type of traffic the customer originated from, represented by the `utm_medium` value in the URL that led to the order. If there is no value, use `null`.",
      "nullable": true
    },
    "UtmCampaign": {
      "type": "string",
      "example": "summer",
      "description": "Campaign name, represented by the `utm_campaign` value in the URL that led to the order. If there is no value, use `null`."
    },
    "UtmInternalCampaign": {
      "type": "string",
      "example": "sale",
      "description": "Internal campaign name, represented by the `utmi_cp` value in the URL that led to the order. If there is no value, use `null`.",
      "nullable": true
    },
    "salesChannel": {
      "type": "string",
      "example": "1",
      "description": "Represents Checkout's sales channel."
    },
    "email": {
      "type": "string",
      "example": "customer@email.com",
      "description": "Customer's email address. If there is no value, use an empty string."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-getpricesrequestobject"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.