VTEX · Example Payload

Vtex Creategroupsofcoupons Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Creategroupsofcoupons 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": "Creategroupsofcoupons",
  "method": "POST",
  "path": "/api/rnb/v2/pvt/coupon/group",
  "summary": "VTex Create coupon batches",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": [
        {
          "couponConfiguration": {
            "utmSource": "fb",
            "utmCampaign": "blackfriday",
            "couponCode": "bf22",
            "expirationIntervalPerUse": "00:00:00",
            "maxItemsPerClient": 5,
            "maxUsage": 5
          },
          "quantity": "5"
        }
      ]
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        "bf22-Y0RGX5VRCQU5HRQ",
        "bf22-XZC6SP9WYR1OINC",
        "bf22-DOLD2FF2NNHUGZU",
        "bf22-1E5WFBGOS2MAY9T",
        "bf22-CXK6H29W9K1PI2B"
      ]
    },
    {
      "status": "400",
      "contentType": "text/plain",
      "example": "A list of multiple coupon configurations is required"
    }
  ]
}