Pular para o conteúdo principal

validateDiscountsCoupon

Validar um código de cupom de desconto.

Descrição​

Verifica se um código de cupom existe e ainda pode ser usado. A busca não diferencia maiúsculas de minúsculas. Resolve para um ICouponValidationResult: valid é false quando o código não é encontrado ("Coupon not found") ou quando um cupom de uso único já foi usado ("Coupon has already been used"; nesse caso, coupon ainda é retornado). O método não verifica o período de validade do desconto (startDate/endDate). Para verificá-lo, busque o desconto ao qual o cupom pertence (identificado pelo discountId do cupom) e compare as datas você mesmo.

.validateDiscountsCoupon(

);

Esquema de parâmetros​

Esquema

code(obrigatório): string
Código do cupom a validar.

Exemplos​

Exemplo mínimo​

const response = await Discounts.validateDiscountsCoupon('SUMMER-KBWZ-2428');

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
O registro do cupom. Presente quando o código é encontrado, inclusive quando um cupom de uso único já foi utilizado; ausente quando o código não é encontrado.

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

coupon.discountId: number
ID do 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 ao qual 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.