Promotions & Taxes API v2
Check the Promotions onboarding guide for a journey-based overview of the Promotions documentation available in the Developer Portal.
The Promotions & Taxes API allows you to manage and retrieve all coupons from your VTEX store.
Common parameters in the documentation
| Parameter name | Description |
|---|---|
{{accountName}} |
Store account name. |
{{environment}} |
The environment that will be called. |
{{X-VTEX-API-AppKey}} |
Located in the headers of the requests, user authentication key. |
{{X-VTEX-API-AppToken}} |
Located in the headers of the requests, authentication password. |
Endpoints
Coupons
| Summary | Method | Path |
|---|---|---|
| Get coupons | GET | /api/rnb/v2/pvt/coupon |
| Get archived coupons | GET | /api/rnb/v2/pvt/coupon/group/archived |
| Get coupon batch information | GET | /api/rnb/v2/pvt/coupon/group/{groupingKey} |
| Edit coupon batch configuration | PUT | /api/rnb/v2/pvt/coupon/group/{groupingKey} |
| Get coupon batch codes | GET | /api/rnb/v2/pvt/coupon/group/{groupingKey}/codes |
| Archive a coupon batch | PUT | /api/rnb/v2/pvt/coupon/group/{groupingKey}/archive |
| Create coupon batches | POST | /api/rnb/v2/pvt/coupon/group |
| Unarchive a coupon batch | PUT | /api/rnb/v2/pvt/coupon/group/{groupingKey}/unarchive |
| Get usage count for a single coupon | GET | /api/rnb/v2/pvt/coupon/usage-count/{couponCode} |
| Get usage count for a coupon batch | GET | /api/rnb/v2/pvt/coupon/usage-count/group/{groupingKey} |