validateDiscountsCoupon

Valider un code promo.

Description

Vérifie si un code promo existe et peut encore être utilisé. La recherche est insensible à la casse. Se résout en un ICouponValidationResult : valid vaut false lorsque le code est introuvable ("Coupon not found") ou lorsqu'un coupon à usage unique a déjà été utilisé ("Coupon has already been used" ; coupon est tout de même renvoyé dans ce cas). La méthode ne vérifie pas la période de validité de la remise (startDate/endDate). Pour la vérifier, récupérez la remise à laquelle appartient le coupon (identifiée par le discountId du coupon) et comparez vous-même les dates.

.validateDiscountsCoupon(

);

Schéma des paramètres

Schéma

code(obligatoire): string
Code de coupon à valider.

Exemples

Exemple minimal

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

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: ICouponEntity
L'enregistrement du coupon. Présent lorsque le code est trouvé, y compris lorsqu'un coupon à usage unique a déjà été utilisé ; absent lorsque le code est introuvable.

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

coupon.discountId: number
ID de la remise à laquelle appartient le coupon.
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 à laquelle 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 n'est pas valide.

---