v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-09-22312710.8 KB

Coupons

Create multiple coupons

Creates multiple coupons with different coupon codes. This endpoint has a throttling of 60 requests per minute.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Rates and Benefits	Promotions	Manage benefits and rates

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/api/rnb/pvt/multiple-coupons

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

quantityinteger required

Quantity of coupons created. The value must be a minimum of 1 and at maximum 1000. If the amount is 1, the coupon code will be the value of the couponCode parameter. If the value is greater than 1, the coupon code will receive a random suffix.

Example request

[
  {
    "quantity": 1,
    "couponConfiguration": {
      "utmSource": "coupon3",
      "utmCampaign": "xfbf1",
      "couponCode": "test",
      "maxItemsPerClient": 10,
      "expirationIntervalPerUse": "00:00:00",
      "maxUsage": 1
    }
  }
]

Response

string[] required

Array with the coupon codes that were created.

All 31 operations