تسویه کد تخفیف (Claim Voucher)

برای تسویه باقی‌مانده موجودی یک کد تخفیف با آیدی استفاده می‌شود.

---

اطلاعات عمومی

• آدرس: /api/v2/purchased-voucher/{id}/claimed
• متد: POST
• نوع محتوا: application/json
• احراز هویت: نیازمند token

---

احراز هویت

• این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.

---

پارامترهای مسیر

پارامتر	نوع داده	ضروری	توضیحات
id	integer	بله	شناسه کد تخفیف خریداری‌شده

---

نمونه درخواست

curl --location --request POST 'https://corporate.snapp.site/api/v2/purchased-voucher/5113/claimed' \
--header 'Authorization: <your_authorization_token>' \
--header 'Accept: application/json'

---

پاسخ موفق

{
    "message": "Success",
    "data": {
        "id": 5113,
        "title": "test",
        "voucher_code": "UVJNFHUSJN-0005",
        "type": 1,
        "mode": 1,
        "bulk_count": 0,
        "percent_value": 10,
        "static_value": 0,
        "value_cap": 10000,
        "user_max_use_times": 10,
        "total_max_use_times": 50,
        "start_date": "1403/11/06 00:00:00",
        "end_date": "1404/01/01 23:59:59",
        "enabled": true,
        "is_claimed": true,
        "user_id": 1443,
        "created_at": "2025-01-25T13:10:54+03:30",
        "updated_at": "2025-02-25T13:10:54+03:30"
    },
    "status": 200
}

فیلد	نوع داده	توضیحات
id	integer	شناسه کد تخفیف خریداری‌شده
title	string	عنوان کد تخفیف
voucher_code	string	کد کد تخفیف
type	integer	نوع کد تخفیف (۱: درصدی، ۲: مبلغ ثابت)
mode	integer	حالت کد تخفیف
bulk_count	integer	تعداد کد تخفیف در حالت گروهی
percent_value	integer	مقدار درصدی تخفیف
static_value	integer	مقدار ثابت تخفیف
value_cap	integer	حداکثر سقف تخفیف برای کد تخفیفهای درصدی
user_max_use_times	integer	حداکثر تعداد استفاده برای هر کاربر
total_max_use_times	integer	حداکثر تعداد استفاده کلی
start_date	string	تاریخ شروع کد تخفیف (هجری شمسی)
end_date	string	تاریخ پایان کد تخفیف (هجری شمسی)
enabled	boolean	آیا کد تخفیف فعال است؟
is_claimed	boolean	آیا کد تخفیف استفاده شده است؟
user_id	integer	شناسه کاربری که کد تخفیف را استفاده کرده
created_at	string	تاریخ ایجاد کد تخفیف
updated_at	string	تاریخ آخرین به‌روزرسانی کد تخفیف

---

خطاها

کد وضعیت	توضیحات
400	درخواست نامعتبر (ورودی‌های اشتباه)
401	نیاز به احراز هویت
403	دسترسی غیرمجاز
404	کد تخفیف موردنظر یافت نشد
500	خطای داخلی سرور

---

توضیحات تکمیلی

• مقدار is_claimed پس از ثبت ادعا true خواهد شد.
• مقدار updated_at نشان‌دهنده زمان آخرین به‌روزرسانی کد تخفیف است.