Aplicação e remoção de cupons de desconto no carrinho.
Cupons — API Pública v1
Aplicação e remoção de cupons de desconto em um carrinho.
Base URL
https://{sua-loja}/api/v1/public/
Identificação do cliente
Envie o header
Authorization: Bearer {access_token}obtido no Login (SSO) quando o cupom depender de regras por cliente (ex.: primeira compra, grupo de clientes).
POST /order/{uuid}/coupons/
POST /order/{uuid}/coupons/Aplica um cupom ao carrinho.
Body
{ "code": "BEMVINDO10" }| Campo | Tipo | Descrição |
|---|---|---|
code | string | Código do cupom. Comparação sem distinção de maiúsculas. |
Resposta 200 OK
200 OKO objeto completo do carrinho (ver Carrinho), com o cupom em coupons[] e os totais recalculados em totalizers. Em caso de erro o carrinho volta inalterado e messages traz o motivo:
| Mensagem | Causa |
|---|---|
Insira um cupom válido. | code ausente ou vazio. |
Você já possui o limite máximo de cupons aplicados em seu carrinho. | A loja limita a quantidade de cupons simultâneos. |
O cupom não pôde ser aplicado. Favor verificar o cep de entrega, valor total dos produtos ou se outro desconto já foi concedido. | Cupom inexistente, expirado, fora da região de entrega, abaixo do valor mínimo ou incompatível com outro desconto já aplicado. |
Observações
- Reaplicar um cupom já presente no carrinho é idempotente: ele não é duplicado.
- Aplicar ou remover cupom zera
payment_discountepayment_interest. Refaça a simulação de pagamento (POST /order/{uuid}/payment-data/) depois.
DELETE /order/{uuid}/coupons/
DELETE /order/{uuid}/coupons/Remove um cupom aplicado.
Body
{ "code": "BEMVINDO10" }Resposta 200 OK
200 OKO objeto completo do carrinho atualizado. Se o cupom não estava aplicado, a resposta vem sem mensagens de erro (operação idempotente).