validateDiscountsCoupon

تحقق من رمز قسيمة الخصم.

Description

تتحقق هذه الطريقة من رمز قسيمة الخصم وتتحقق مما إذا كانت موجودة ونشطة حاليًا. تعيد Promise التي تحل إلى كائن ICouponValidationResult مع تفاصيل التحقق.

Discounts.validateDiscountsCoupon(

code*

);

Parameters schema

Schema

code(required): string
رمز القسيمة للتحقق منه

Examples

Minimal example

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

Example response

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

Response schema

Schema: ICouponValidationResult

valid: boolean
ما إذا كانت القسيمة صالحة.

coupon: ICouponEntity
بيانات القسيمة إذا كانت القسيمة صالحة.

coupon.id: number
معرف سجل القسيمة.
مثال: 1

coupon.discountId: number
الخصم الذي تنتمي إليه القسيمة.
مثال: 1

coupon.code: string
رمز القسيمة.
مثال: "SUMMER-KBWZ-2428"

coupon.isReusable: boolean
ما إذا كانت القسيمة يمكن استخدامها أكثر من مرة.
مثال: false

coupon.isUsed: boolean
ما إذا كانت القسيمة قد تم استخدامها بالفعل.
مثال: false

coupon.orderId: number | null
معرف الطلب الذي تم تطبيق القسيمة عليه، أو null.
مثال: null

coupon.usedAt: string | null
متى تم استخدام القسيمة، أو null.
مثال: null

error: string
رسالة الخطأ إذا كانت القسيمة غير صالحة.

---