VTEX · Example Payload

Vtex Getsession Example

CommerceE-CommerceRetailMarketplacePayments

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

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "GetSession",
  "method": "GET",
  "path": "/api/sessions",
  "summary": "VTex Get session",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "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"
            }
          }
        }
      }
    }
  ]
}