Promotions & Taxes API
Check the new Promotions onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey.
The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store.
Index
Promotions and taxes
GETGet all promotionsGETGet all taxesGETSearch promotion by nameGETGet promotion or tax by IDPOSTCreate or Update promotion or taxPOSTCreate Multiple SKU promotionPUTUpdate Multiple SKU promotionPOSTArchive promotion or taxPOSTUnarchive promotion or taxGETList archived promotionsGETList archived taxesPOSTSeller opt-in or opt-out
Coupons
POSTCreate multiple couponsPOSTCreate or update couponGETGet coupon by coupon codeGETGet archived coupon by coupon codePOSTArchive coupon by coupon codeGETGet all couponsPOSTGenerate coupons in bulkGETGet coupon usagePOSTUnarchive coupon by coupon code
Prices (Legacy - v1)
GETGet Price by SKU IDDELETEDelete Price by SKU IDGETGet all paged pricesPOSTGet Price by contextGETGet Price by SKU ID and trade policyPOSTSave Price
Bundles
Campaign Audiences
GETGet campaign audience configurationGETGet all campaign audiencesPOSTCreate campaign audience
Notifications
POSTUsage notification
Common parameters in the documentation
| Parameter name | Description |
|---|---|
{{accountName}} |
Name of the VTEX account. Used as part of the URL. |
{{environment}} |
Name of the VTEX account. Used as part of the URL. |
{{X-VTEX-API-AppKey}} |
Unique identifier of the API key. |
{{X-VTEX-API-AppToken}} |
Secret token of the API key. |
Endpoints
Promotions and taxes
| Summary | Method | Path |
|---|---|---|
| Get all promotions | GET | /api/rnb/pvt/benefits/calculatorconfiguration |
| Search promotion by name | GET | /api/rnb/pvt/benefits/calculatorconfiguration/search |
| Get all taxes | GET | /api/rnb/pvt/taxes/calculatorconfiguration |
| Get promotion or tax by ID | GET | /api/rnb/pvt/calculatorconfiguration/{idCalculatorConfiguration} |
| Seller opt-in or opt-out | POST | /api/rnb/pvt/calculatorconfiguration/{promotionId}/seller-opt |
| Create or update promotion or tax | POST | /api/rnb/pvt/calculatorconfiguration |
| Create multiple SKU promotion | POST | /api/rnb/pvt/import/calculatorConfiguration |
| Update multiple SKU promotion | PUT | /api/rnb/pvt/import/calculatorConfiguration/{promotionId} |
| Archive promotion or tax | POST | /api/rnb/pvt/archive/calculatorConfiguration/{idCalculatorConfiguration} |
| Unarchive promotion or tax | POST | /api/rnb/pvt/unarchive/calculatorConfiguration/{idCalculatorConfiguration} |
| List archived promotions | GET | /api/rnb/pvt/archive/benefits/calculatorConfiguration |
| List archived taxes | GET | /api/rnb/pvt/archive/taxes/calculatorConfiguration |
Coupons
| Summary | Method | Path |
|---|---|---|
| Create multiple coupons | POST | /api/rnb/pvt/multiple-coupons |
| Create or update coupon | POST | /api/rnb/pvt/coupon |
| Get all coupons | GET | /api/rnb/pvt/coupon |
| Get coupon by coupon code | GET | /api/rnb/pvt/coupon/{couponCode} |
| Get archived coupon by coupon code | GET | /api/rnb/pvt/archive/coupon/{couponCode} |
| Archive coupon by coupon code | POST | /api/rnb/pvt/archive/coupon/{couponCode} |
| Generate coupons in bulk | POST | /api/rnb/pvt/coupons |
| Get coupon usage | GET | /api/rnb/pvt/coupon/usage/{couponCode} |
| Unarchive coupon by coupon code | POST | /api/rnb/pvt/unarchive/coupon/{couponCode} |
Campaign Audiences
| Summary | Method | Path |
|---|---|---|
| Get campaign audience configuration | GET | /api/rnb/pvt/campaignConfiguration/{campaignId} |
| Get all campaign audiences | GET | /api/rnb/pvt/campaignConfiguration |
| Create campaign audience | POST | /api/rnb/pvt/campaignConfiguration |
Bundles
| Summary | Method | Path |
|---|---|---|
| Calculate discounts and taxes bundles | POST | /pub/bundles |
Prices (Legacy - v1)
| Summary | Method | Path |
|---|---|---|
| Get price by SKU ID | GET | /price-sheet/{skuId} |
| Delete price by SKU ID | DELETE | /price-sheet/{skuId} |
| Get all paged prices | GET | /price-sheet/all/{page}/{pageSize} |
| Get price by context | POST | /price-sheet/context |
| Get price by SKU ID and trade policy | GET | /price-sheet/{skuId}/{tradePolicy} |
| Save price | POST | /price-sheet |