انتقل إلى المحتوى الرئيسي

validateDiscountsCoupon

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

الوصف​

تتحقق مما إذا كان رمز القسيمة موجودًا وما زال قابلًا للاستخدام. البحث غير حساس لحالة الأحرف. تُعيد ICouponValidationResult: تكون valid مساوية لـ false عندما لا يُعثر على الرمز ("Coupon not found") أو عندما تكون قسيمة الاستخدام الواحد قد استُخدمت بالفعل ("Coupon has already been used"؛ وتُعاد coupon في هذه الحالة أيضًا). لا تتحقق الطريقة من فترة صلاحية الخصم (startDate/endDate). للتحقق منها، اجلب الخصم الذي تنتمي إليه القسيمة (المحدَّد بـ discountId الخاص بالقسيمة) وقارن التواريخ بنفسك.

.validateDiscountsCoupon(

);

مخطط المعلمات​

المخطط

code(مطلوب): string
رمز القسيمة المراد التحقق منه.

أمثلة​

مثال بسيط​

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

مثال على الاستجابة​

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

مخطط الاستجابة​

المخطط: 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
رسالة الخطأ إذا كانت القسيمة غير صالحة.