v50

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

Coupons

Generate coupons in bulk

Generates a massive amount of coupons.

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/coupons

Query parameters

quantityinteger required

Example:10

Number of coupons to create, which can be from 1 to 1000. For a single coupon (1), the code will be the couponCode value. For multiple coupons (more than 1), codes will be the couponCode value with a random suffix.

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

utmSourcestring required

UTM source code.

utmCampaignstring required

UTM campaign code.

couponCodestring required

Coupon code.

maxItemsPerClientinteger required

Maximum number of items a coupon can be applied to per client.

expirationIntervalPerUsestring required

Coupon expiration interval per use.

Example request

{
  "utmSource": "cupom3",
  "utmCampaign": "cupom3",
  "couponCode": "ctest",
  "maxItemsPerClient": 1,
  "expirationIntervalPerUse": "00:00:00"
}

Response

string[] required

Array with the generated coupon codes.