validateDiscountsCoupon

Valida um código de cupom de desconto.

Descrição

Este método valida um código de cupom de desconto e verifica se ele existe e está atualmente ativo. Ele retorna uma Promise que resolve para um objeto ICouponValidationResult com os detalhes da validação.

Descontos.validateDiscountsCoupon(

code*

);

Esquema de parâmetros

Esquema

code(obrigatório): string
O código do cupom a ser validado

Exemplos

Exemplo mínimo

const response = await Discounts.validateDiscountsCoupon('SUMMER20');

Exemplo de resposta

{
  "valid": true,
  "coupon": {
    "id": 1,
    "discountId": 1,
    "code": "SUMMER-KBWZ-2428",
    "usedAt": null,
    "isUsed": false,
    "isReusable": false,
    "orderId": null
  }
}

Esquema de resposta

Esquema: ICouponValidationResult

valid: boolean
Se o cupom é válido.

coupon: ICouponEntity
Dados do cupom se o cupom for válido.

coupon.id: number
ID do registro do cupom.
exemplo: 1

coupon.discountId: number
Desconto ao qual o cupom pertence.
exemplo: 1

coupon.code: string
Código do cupom.
exemplo: "SUMMER-KBWZ-2428"

coupon.isReusable: boolean
Se o cupom pode ser usado mais de uma vez.
exemplo: false

coupon.isUsed: boolean
Se o cupom já foi utilizado.
exemplo: false

coupon.orderId: number | null
ID do pedido onde o cupom foi aplicado, ou null.
exemplo: null

coupon.usedAt: string | null
Quando o cupom foi usado, ou null.
exemplo: null

error: string
Mensagem de erro se o cupom for inválido.

---