Aller au contenu principal

validateDiscountsCoupon

Valider un code de coupon de réduction.

Description

Cette méthode valide un code de coupon de réduction et vérifie s'il existe et est actuellement actif. Elle prend un code de coupon en entrée et renvoie une promesse qui se résout à true si le coupon est valide ou false si le coupon n'existe pas ou a expiré.

Réductions.validateDiscountsCoupon(

code*

);

Parameters schema

Schéma

code(obligatoire): string
Le code du coupon à valider

Exemples

Exemple minimal

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

Exemple de réponse

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

Schéma de réponse

Schéma: ICouponValidationResult

valid: boolean
Indique si le coupon est valide.

coupon: unknown
Données du coupon si le coupon est valide.

error: string
Message d'erreur si le coupon est invalide.