Cupons automáticos
Como a plataforma gera cupons sozinha a partir de regras e como administrá-las pela API.
Um cupom automático é um cupom que a plataforma gera e entrega sozinha depois que um cliente faz uma compra: "concluiu o primeiro pedido, ganha 10% na próxima". O lojista não cria cada código; ele cadastra uma regra (gatilho, desconto, validade) e, a cada pedido concluído que casar com a regra, nasce um código único para aquele cliente, enviado por e-mail. É diferente de gerar códigos descartáveis a partir de uma promoção, que é uma ação manual do lojista.
Como funciona
Gatilhos (trigger_type)
trigger_type | Gera o cupom quando | trigger_value |
|---|---|---|
order_completed | Qualquer pedido é concluído. | Ignorado |
first_order | É o primeiro pedido concluído do cliente. | Ignorado |
nth_order | O número de pedidos concluídos do cliente é exatamente N (contando o atual). | O N |
min_order_amount | O valor do pedido é igual ou maior que o mínimo. | Mínimo, em centavos |
manual | Nunca sozinho: existe para campanhas e jornadas de CRM que geram o código por conta própria. | Ignorado |
Regras de seller (com vendor_id) avaliam apenas a parte do pedido que é daquele seller (subtotal e contagem de pedidos dele), e o cupom gerado só desconta itens dele.
Ciclo de vida do cupom gerado
- Gerado com
max_usesusos e validade devalid_daysdias. Sesend_emailétrue, o cliente recebe o código por e-mail. - Usado no carrinho como qualquer cupom. O valor mínimo da regra (
min_order_amount) vira condição de subtotal. - Esgotado ao atingir
max_uses, ou expirado passada a validade. - Desativado se o pedido que o gerou for cancelado.
Conceitos importantes
O cupom não é preso ao cliente
O cupom é gravado com o cliente que o ganhou (user_id) e o checkout limita a 1 uso por cliente, mas quem tiver o código pode digitá-lo. Se isso importa para a campanha, use max_uses baixo e valid_days curto.
Status da regra
A regra nasce A (ativa). Só regras A são avaliadas. Na entrada você pode enviar active ou disabled (ou as letras A e D).
Endpoints
| Método e caminho | Para que serve | Auth | Página |
|---|---|---|---|
GET /api/v1/admin/auto-coupons | Lista as regras | admin | Consultar regras |
GET /api/v1/admin/auto-coupons/{id} | Detalha uma regra | admin | Consultar regras |
POST /api/v1/admin/auto-coupons | Cria uma regra | admin | Criar, alterar e excluir regra |
PUT /api/v1/admin/auto-coupons/{id} | Altera uma regra | admin | Criar, alterar e excluir regra |
DELETE /api/v1/admin/auto-coupons/{id} | Exclui uma regra e os cupons dela | admin | Criar, alterar e excluir regra |
GET /api/v1/admin/auto-coupons/coupons | Lista os cupons já gerados | admin | Cupons gerados |
POST /api/v1/admin/auto-coupons/validate | Confere um cupom gerado | admin | Cupons gerados |
Erros comuns
- Achar que a regra vale para pedidos antigos. O gatilho só roda quando um pedido muda para concluído depois que a regra existe.
- Misturar unidades.
discount_valueé em pontos-base parapercentagee em centavos parafixed;trigger_valuedemin_order_amounté em centavos. - Usar UUID no caminho. O
{id}aqui é um número inteiro; texto leva400 invalid rule ID. - Excluir a regra esperando invalidar os códigos já enviados. A exclusão apaga os registros da regra e dos cupons gerados, mas as promoções-espelho que o checkout aceita continuam ativas até expirar ou serem desativadas em Promoções.
- Status inválido. Uma palavra de status desconhecida com mais de uma letra vira
A(ativa), nunca é recusada. Envieactiveoudisabled. - Esperar
404ao alterar regra inexistente. OPUTresponde400comauto-coupon rule not found.