API Promotions & Taxes API
Consulte Promotions & Taxes API, do provedor vtex.local, versão 1.0: documentação, especificação OpenAPI 3.0.0 e referências para planejar a integração.
vtex.local · Versão 1.0
Conheça a plataforma
O que integrar com Promotions & Taxes API
Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.
> 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
Ficha técnica
Como funciona a integração
Versões, permissões, preços e limites podem mudar. Consulte a documentação da plataforma antes de implementar.
Do planejamento à produção
Checklist para integrar Promotions & Taxes API
- Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
- Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
- Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
- Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
- Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
- Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.