API archive entry · source-reported
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 ### 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
Plan the first integration safely
The access fields below come from the connected directory. Their likely implementation impact is explained without assuming provider-specific behavior.
Authentication
OAuth is reported. Confirm flows, scopes, consent, token lifetime, and refresh rules.
Transport
HTTPS is not confirmed. Do not send credentials or production data until secure transport is verified.
Browser access
CORS is unknown. Treat direct browser access as unconfirmed and test before choosing a client-only architecture.
First-request sequence
- Identify the current base URL, version, and endpoint for the use case.
- Confirm how credentials are issued and where they may be stored.
- Test success, invalid input, throttling, unavailable data, and timeouts.
- Record response fields, pagination, caching, and error shapes.
- Add monitoring, retries with backoff, and an appropriate fallback.
Questions to resolve before production
Pricing and quotas
Confirm current plans, free-tier limits, overages, and request ceilings.
Endpoint coverage
Check that the operations and response fields match the intended workload.
Reliability
Look for uptime history, a status page, support routes, and service commitments.
Data and privacy
Review retention, licensing, regional processing, and compliance requirements.
Versioning
Confirm the active version, change policy, deprecation window, and migration guidance.
Developer experience
Validate SDKs, examples, error formats, pagination, and test environments.
Source reference
This page separates source-reported facts from questions that need live provider verification.