VTEX · Schema

Segment

Object containing information about the segment.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
campaigns	string	Campaigns associated with the session.
channel	string	[Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID.
priceTables	string	Price tables associated with the session.
regionId	string	ID of the session's region.
utm_campaign	string	UTM campaign code.
utm_source	string	UTM source code.
utmi_campaign	string	UTMI campaign code.
currencyCode	string	Currency code.
currencySymbol	string	Currency symbol.
countryCode	string	Country code.
cultureInfo	string	Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read [this documentation](https://
channelPrivacy	string	Defines whether or not the channel is private.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Segment",
  "title": "Segment",
  "type": "object",
  "description": "Object containing information about the segment.",
  "properties": {
    "campaigns": {
      "type": "string",
      "description": "Campaigns associated with the session."
    },
    "channel": {
      "type": "string",
      "description": "[Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID."
    },
    "priceTables": {
      "type": "string",
      "description": "Price tables associated with the session."
    },
    "regionId": {
      "type": "string",
      "description": "ID of the session's region."
    },
    "utm_campaign": {
      "type": "string",
      "description": "UTM campaign code."
    },
    "utm_source": {
      "type": "string",
      "description": "UTM source code."
    },
    "utmi_campaign": {
      "type": "string",
      "description": "UTMI campaign code."
    },
    "currencyCode": {
      "type": "string",
      "description": "Currency code."
    },
    "currencySymbol": {
      "type": "string",
      "description": "Currency symbol."
    },
    "countryCode": {
      "type": "string",
      "description": "Country code."
    },
    "cultureInfo": {
      "type": "string",
      "description": "Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read [this documentation](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-7.0#culture-names-and-identifiers) for more details."
    },
    "channelPrivacy": {
      "type": "string",
      "description": "Defines whether or not the channel is private."
    }
  },
  "example": {
    "campaigns": null,
    "channel": "1",
    "priceTables": null,
    "regionId": "v2.1BB18CE648B5111D0933734ED83EC783",
    "utm_campaign": null,
    "utm_source": null,
    "utmi_campaign": null,
    "currencyCode": "BRL",
    "currencySymbol": "R$",
    "countryCode": "BRA",
    "cultureInfo": "pt-BR",
    "channelPrivacy": "public"
  }
}