VTEX · Example Payload

Vtex Getsegment Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getsegment 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

{
  "operationId": "GetSegment",
  "method": "GET",
  "path": "/api/segments",
  "summary": "VTex Get segment",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "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": "en-US",
        "channelPrivacy": "public"
      }
    }
  ]
}