Skip to main content
Use este endpoint público para validar um código de cupom durante o checkout. Ele verifica se o cupom está ativo, dentro do limite de usos e dentro da validade, e devolve o valor do desconto calculado sobre o total informado. Por ser público, pode ser chamado direto do frontend sem expor sua API Key.

​
Método

POST /api/v1/coupons/validate
Este endpoint é público e não requer o header Authorization. Pode ser chamado direto do frontend da sua loja, sem expor sua API Key ao cliente.

​
Parâmetros do corpo

​
string
required
Código do cupom a ser validado, por exemplo DESCONTO10.
​
string
required
UUID da loja à qual o cupom pertence.
​
number
required
Valor total do pedido em reais, com decimais, sobre o qual o desconto será calculado. Exemplo: 100 para R$ 100,00.
​
array
UUIDs dos produtos do carrinho. Obrigatório quando o cupom vale só para produtos ou categorias específicas.

​
Exemplo de requisição

​
Resposta com cupom válido

​
Cupom recusado

Quando o cupom não pode ser aplicado, a API responde 400 com um message explicando o motivo — cupom inexistente, expirado, inativo, limite de usos atingido, valor mínimo de compra não alcançado ou produto fora da lista de aplicação.

​
Campos da resposta

​
boolean
true quando o cupom pode ser aplicado ao pedido.
​
object
Detalhes do cupom e o desconto já calculado.
Use sempre o discount devolvido pela API para aplicar o desconto. Calcular no frontend abre espaço para o cliente manipular o valor, e a API é quem garante que o cupom ainda é válido no momento da compra.