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

{
  "$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": "[email protected]",
      "description": "Customer's email address. If there is no value, use an empty string."
    }
  }
}