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

Examples

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
  }
}

Response schema

Schéma: ICouponValidationResult

valid: boolean
Indique si le coupon est valide.

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

coupon.id: number
ID de l'enregistrement du coupon.
exemple: 1

coupon.discountId: number
Réduction à laquelle le coupon appartient.
exemple: 1

coupon.code: string
Code du coupon.
exemple: "SUMMER-KBWZ-2428"

coupon.isReusable: boolean
Indique si le coupon peut être utilisé plusieurs fois.
exemple: false

coupon.isUsed: boolean
Indique si le coupon a déjà été utilisé.
exemple: false

coupon.orderId: number | null
ID de la commande où le coupon a été appliqué, ou null.
exemple: null

coupon.usedAt: string | null
Quand le coupon a été utilisé, ou null.
exemple: null

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

---