VTEX · Example Payload

Vtex Editcoupongroupconfiguration Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Editcoupongroupconfiguration 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": "Editcoupongroupconfiguration",
  "method": "PUT",
  "path": "/api/rnb/v2/pvt/coupon/group/{groupingKey}",
  "summary": "VTex Edit coupon batch configuration",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "utmSource": "source",
        "isArchived": false,
        "maxItemsPerClient": 0,
        "expirationIntervalPerUse": "00:00:00",
        "maxUsage": 4
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        "12130984756-bbbsqz5lxivwvx7",
        "12130984756-31xj4idmfbmh9am",
        "12130984756-pxpdsou99n3bmsn",
        "12130984756-juzl9asvq8z4sjn",
        "12130984756-gyo7a2v0s9v7s07"
      ]
    },
    {
      "status": "400",
      "contentType": "text/plain",
      "example": "It is not possible to edit an archived coupon group."
    }
  ]
}