{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetSessionResponse",
"title": "GetSessionResponse",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Session ID."
},
"namespaces": {
"type": "object",
"description": "Object with namespaces, each containing a set of information about the session.",
"properties": {
"account": {
"type": "object",
"description": "Account information related to the session.",
"properties": {
"id": {
"type": "object",
"description": "VTEX account ID.",
"properties": {
"value": {
"type": "string",
"description": "Value of the VTEX account ID."
},
"keepAlive": {
"type": "boolean",
"description": "Determines whether or not the connection should be kept alive."
}
}
},
"accountName": {
"type": "object",
"description": "VTEX account name.",
"properties": {
"value": {
"type": "string",
"description": "Value of the VTEX account name."
}
}
}
}
},
"store": {
"type": "object",
"description": "Store information related to the session.",
"properties": {
"channel": {
"type": "object",
"description": "[Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID.",
"properties": {
"value": {
"type": "string",
"description": "Value of the [Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID."
}
}
},
"countryCode": {
"type": "object",
"description": "Country code.",
"properties": {
"value": {
"type": "string",
"description": "Value of the country code."
}
}
},
"cultureInfo": {
"type": "object",
"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.",
"properties": {
"value": {
"type": "string",
"description": "Value of the `cultureInfo` property."
}
}
},
"currencyCode": {
"type": "object",
"description": "Currency code.",
"properties": {
"value": {
"type": "string",
"description": "Value of the currency code."
}
}
},
"currencySymbol": {
"type": "object",
"description": "Currency symbol.",
"properties": {
"value": {
"type": "string",
"description": "Value of the currency symbol."
}
}
},
"channelPrivacy": {
"type": "object",
"description": "Defines whether or not the channel is private.",
"properties": {
"value": {
"type": "string",
"description": "Value containing the channel's privacy option."
}
}
}
}
},
"public": {
"type": "object",
"description": "Public and editable information related to the session.",
"additionalProperties": {
"type": "object",
"description": "Custom property.",
"properties": {
"value": {
"type": "string",
"description": "Value of the custom property."
}
}
}
},
"checkout": {
"type": "object",
"description": "Checkout information related to the session.",
"properties": {
"regionId": {
"type": "object",
"description": "ID of the session's region.",
"properties": {
"value": {
"type": "string",
"description": "Value of the Region ID."
}
}
}
}
}
}
}
},
"example": {
"id": "26d2cb6c-213e-4936-9e2a-1d1e299ec33b",
"namespaces": {
"account": {
"id": {
"value": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
"keepAlive": true
},
"accountName": {
"value": "apiexamples"
}
},
"store": {
"channel": {
"value": "1"
},
"countryCode": {
"value": "BRA"
},
"cultureInfo": {
"value": "en-US"
},
"currencyCode": {
"value": "BRL"
},
"currencySymbol": {
"value": "R$"
},
"channelPrivacy": {
"value": "public"
}
},
"public": {
"variable1": {
"value": "value1"
},
"variable2": {
"value": "value2"
}
},
"checkout": {
"regionId": {
"value": "v2.1BB18CE648B5111D0933734ED83EC783"
}
}
}
}
}