مشاهده کد تخفیف با آیدی (Get)

کد تخفیف مشخصی را با استفاده از آیدی نمایش می‌دهد.

---

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

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

---

احراز هویت

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

---

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

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

---

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

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

---

پاسخ موفق

{
    "message": "Success",
    "data": {
        "title": "تست حذف کاربر از لیست",
        "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",
        "expired": false,
        "enabled": true,
        "is_claimed": false,
        "total_payment": 500000,
        "used_amount": 0,
        "remain_amount": 500000,
        "claimed_amount": 0,
        "claimed_at": null,
        "created_at": "2025-01-25T13:10:54+03:30"
    },
    "status": 200
}

فیلد	نوع داده	توضیحات
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	تاریخ پایان کد تخفیف (هجری شمسی)
expired	boolean	آیا کد تخفیف منقضی شده است؟
enabled	boolean	آیا کد تخفیف فعال است؟
is_claimed	boolean	آیا کد تخفیف استفاده شده است؟
total_payment	integer	مقدار کل پرداختی کد تخفیف
used_amount	integer	مقدار استفاده‌شده از کد تخفیف
remain_amount	integer	مقدار باقی‌مانده کد تخفیف
claimed_amount	integer	مقدار درخواست‌شده از کد تخفیف
claimed_at	string/null	تاریخ درخواست استفاده از کد تخفیف
created_at	string	تاریخ ایجاد کد تخفیف

---

خطاها

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

---

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

• مقدار expired نشان می‌دهد که کد تخفیف منقضی شده یا خیر.
• مقدار is_claimed مشخص می‌کند که آیا کد تخفیف استفاده شده است یا خیر.
• مقدار remain_amount نشان‌دهنده مقدار باقی‌مانده از کد تخفیف است.