VTEX · Example Payload

Vtex Getgroupedcoupons Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getgroupedcoupons 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": "Getgroupedcoupons",
  "method": "GET",
  "path": "/api/rnb/v2/pvt/coupon",
  "summary": "VTex Get coupons",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "items": [
          {
            "grouping": {
              "key": "rewardsprogram",
              "amount": 1000
            },
            "configuration": {
              "lastModifiedUtc": "2022-04-20T20:07:03.5066878Z",
              "utmSource": "fb",
              "utmCampaign": "rewards",
              "isArchived": false,
              "maxItemsPerClient": 0,
              "expirationIntervalPerUse": "00:00:00",
              "maxUsage": 3,
              "groupingKey": "rewardsprogram"
            }
          }
        ],
        "pagination": {
          "page": 0,
          "pageSize": 10,
          "total": 10
        }
      }
    }
  ]
}