validateDiscountsCoupon
Valida un código de cupón de descuento.
Descripción
Este método valida un código de cupón de descuento y verifica si existe y está actualmente activo. Devuelve una Promesa que se resuelve en un objeto ICouponValidationResult con los detalles de la validación.
Descuentos.validateDiscountsCoupon(
code*);
Esquema de parámetros
Esquema
code(requerido): string
El código del cupón a validar
Ejemplos
Ejemplo mínimo
const response = await Discounts.validateDiscountsCoupon('SUMMER20');
Ejemplo de respuesta
{
"valid": true,
"coupon": {
"id": 1,
"discountId": 1,
"code": "SUMMER-KBWZ-2428",
"usedAt": null,
"isUsed": false,
"isReusable": false,
"orderId": null
}
}
Esquema de respuesta
Esquema: ICouponValidationResult
valid: boolean
Si el cupón es válido.
coupon: ICouponEntity
Datos del cupón si el cupón es válido.
coupon.id: number
Id del registro del cupón.
ejemplo: 1
coupon.discountId: number
Descuento al que pertenece el cupón.
ejemplo: 1
coupon.code: string
Código del cupón.
ejemplo: "SUMMER-KBWZ-2428"
coupon.isReusable: boolean
Si el cupón se puede usar más de una vez.
ejemplo: false
coupon.isUsed: boolean
Si el cupón ya ha sido utilizado.
ejemplo: false
coupon.orderId: number | null
Id del pedido donde se aplicó el cupón, o null.
ejemplo: null
coupon.usedAt: string | null
Cuándo se utilizó el cupón, o null.
ejemplo: null
error: string
Mensaje de error si el cupón es inválido.