coupons.validate

Validar cupom antes de aplicar no carrinho/checkout.

storefront.coupons.validate(input)

Valida se um cupom pode ser usado antes de aplicar no checkout.

---

Input

Campo	Obrigatório	Descrição
code	✅	Código digitado pelo cliente
document	—	CPF/CNPJ (obrigatório para validar uso único por cliente)

---

Retorno

{
  canUse: boolean;
  message: string;
  reason?: string;
  coupon?: CouponValidation | null;
}

Motivos comuns (reason)

Valor	Significado
CouponNotFound	Código inválido
CouponInactive	Cupom desativado
CouponExpired	Fora da vigência
CouponExhausted	Esgotou usos
CouponAlreadyUsedByCustomer	Cliente já usou (single use)

---

Exemplo

async function applyCoupon(code, document) {
  const result = await storefront.coupons.validate({ code, document });

  if (!result.canUse) {
    alert(result.message);
    return;
  }

  // aplicar no carrinho / checkout
}

---

Hook / action

Use dentro de event handlers — não em defineSectionData (mutation).

Veja coupons.list e Coupon (resource).