VTEX

Promotions & Taxes API

> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

> 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

Coupons

POST Create multiple coupons
POST Create coupon
GET Get coupon by coupon code
GET Get archived coupon by coupon code
POST Archive coupon by coupon code
POST Update coupon
GET Get all coupons
POST Coupon Massive Generation
GET Get coupon usage
POST Unarchive coupon by coupon code

Promotions and Taxes

GET Get All Promotions
GET Get All Taxes
GET Get Promotion or Tax By ID
POST Create or Update Promotion or Tax
POST Create Multiple SKU Promotion
PUT Update Multiple SKU Promotion
POST Archive Promotion or Tax
POST Unarchive Promotion or Tax
GET List archived Promotions
GET List archived Taxes

Campaign Audiences

GET Get campaign audience configuration
POST Create campaign audience

Endpoints 31

Promotions and Taxes

  • GETList Archived Promotions/api/rnb/pvt/archive/benefits/calculatorConfigurationLists all archived promotions.
  • POSTArchive Promotion or Tax/api/rnb/pvt/archive/calculatorConfiguration/:idCalculatorConfigurationArchives a Promotion or Tax by its ID.
  • GETList Archived Taxes/api/rnb/pvt/archive/taxes/calculatorConfigurationLists all archived taxes.
  • GETGet All Promotions/api/rnb/pvt/benefits/calculatorconfigurationRetrieves all promotions from an account. > 📘 Onboarding guide > > Check the new Promotions onboarding guide. We created this guide to improve the onboarding…
  • POSTCreate or Update Promotion or Tax/api/rnb/pvt/calculatorconfigurationCreates or updates a specific Promotion by its Promotion ID or a specific Tax by its Tax ID.
  • GETGet Promotion or Tax by ID/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfigurationRetrieves a specific promotion by its Promotion ID or a specific tax by its Tax ID.
  • POSTCreate Multiple SKU Promotion/api/rnb/pvt/import/calculatorConfigurationCreates a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect. > ⚠️ > > The limit of SKUs…
  • PUTUpdate Multiple SKU Promotion/api/rnb/pvt/import/calculatorConfiguration/:promotionIdUpdates information from a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect. > ⚠️ > >…
  • GETGet All Taxes/api/rnb/pvt/taxes/calculatorconfigurationRetrieves all taxes from an account.
  • POSTUnarchive Promotion or Tax/api/rnb/pvt/unarchive/calculatorConfiguration/:idCalculatorConfigurationUnarchives a Promotion or Tax by its ID.

Coupons

  • GETGet archived coupon by coupon code/api/rnb/pvt/archive/coupon/:couponCodeRetrieves a specific archived coupon by its coupon code.
  • POSTArchive coupon by coupon code/api/rnb/pvt/archive/coupon/:couponCodeArchives a specifc coupon by its coupon code.
  • GETGet all coupons/api/rnb/pvt/coupon> Check the new Promotions onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation…
  • POSTUpdate coupon/api/rnb/pvt/couponUpdates information of a specific coupon.
  • POSTCreate coupon/api/rnb/pvt/coupon/Creates a single new coupon.
  • GETGet coupon usage/api/rnb/pvt/coupon/usage/:couponCodeRetrieves information about the coupon usage.
  • GETGet coupon by coupon code/api/rnb/pvt/coupon/:couponCodeRetrieves a specific coupon by its coupon code.
  • POSTCoupon Massive Generation/api/rnb/pvt/coupons?quantity=10Generates a massive amount of coupons
  • POSTCreate multiple coupons/api/rnb/pvt/multiple-couponsCreates multiple coupons with different coupon codes. This endpoint has a throttling of 60 requests per minute.
  • POSTUnarchive coupon by coupon code/api/rnb/pvt/unarchive/coupon/:couponCodeUnarchives a specifc coupon by its coupon code.

Campaign Audiences

  • GETGet all campaign audiences/api/rnb/pvt/campaignConfigurationRetrieves a list of all campaign audiences and their respective configurations.
  • POSTCreate campaign audience/api/rnb/pvt/campaignConfigurationCreates a new campaign audience.
  • GETGet campaign audience configuration/api/rnb/pvt/campaignConfiguration/:campaignIdRetrieves a specific campaign audience configuration by its ID. This API uses the campaign ID, not the campaign name.

Notifications

  • POSTUsage notificationhttp://example.com/.exampleParameterValue.com.br/api/rnb/api/rnb/pub/notificationsUsage notification

Bundles

  • POSTCalculate discounts and taxes (Bundles)http://example.com/.vtexcommercestable.com.br/api/rnb/pub/bundlesCalculate discounts and taxes

Prices (Legacy - v1)

  • POSTSave Pricehttps://rnb.vtexcommercestable.com.br/api/pricing/pvt/price-sheet?an={{accountName}}Save price. > If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API > If you are still using…
  • GETGet all paged priceshttps://rnb.vtexcommercestable.com.br/api/pricing/pvt/price-sheet/all/:page/:pageSize?an={{accountName}}Get all paged prices. > If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API > If you are…
  • POSTGet Price by contexthttps://rnb.vtexcommercestable.com.br/api/pricing/pvt/price-sheet/context?an={{accountName}}Get price by context. > If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API > If you are…
  • GETGet Price by SKU IDhttps://rnb.vtexcommercestable.com.br/api/pricing/pvt/price-sheet/:skuId?an={{accountName}}Price by SKU ID > If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API
  • DELETEDelete Price by SKU Idhttps://rnb.exampleParameterValue.com.br/api/pricing/pvt/price-sheet/:skuId?an={{accountName}}Delete all prices from an SKU. > If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API > If…
  • GETGet Price by SKU ID and Trade Policyhttps://rnb.vtexcommercestable.com.br/api/pricing/pvt/price-sheet/:skuId/:tradePolicy?an={{accountName}}Retrieve price by SKU ID and Trade Policy. > If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2…

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
31 operations on 27 pathsPOST 15GET 14PUT 1DELETE 1
Main resources
Coupons 10Promotions and Taxes 10Prices (Legacy - v1) 6Campaign Audiences 3Bundles 1Notifications 1
Response formats
application/json promotion tax
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Promotions & Taxes API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Promotions & Taxes API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List Archived Promotions” (GET /api/rnb/pvt/archive/benefits/calculatorConfiguration), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Promotions & Taxes API?

> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the… It is listed under Other and has 31 endpoints.

Who publishes the Promotions & Taxes API?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Promotions & Taxes API?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Promotions & Taxes API?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Promotions & Taxes API have?

31 operations on 27 paths (15 POST, 14 GET, 1 PUT, 1 DELETE). The largest groups are Coupons, Promotions and Taxes, Prices (Legacy - v1), Campaign Audiences.

Is forking the Promotions & Taxes API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.