لیست کد تخفیف (Get List)

لیست تمامی کدهای تخفیف را نمایش می‌دهد.

---

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

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

---

احراز هویت

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

---

پارامترهای کوئری

پارامتر	نوع داده	ضروری	مقدار پیش‌فرض	توضیحات
limit	integer	خیر	۱۰	تعداد آیتم‌های قابل دریافت در هر درخواست
offset	integer	خیر	۰	تعداد آیتم‌هایی که باید از لیست رد شوند

---

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

curl --location --request GET 'https://corporate.snapp.site/api/v2/purchased-voucher?limit=10&offset=1' \
--header 'Authorization: <your_authorization_token>' \
--header 'Accept: application/json'

---

پاسخ موفق

{
    "message": "",
    "data": [
        {
            "id": 5113,
            "title": "تست حذف کاربر از لیست",
            "voucher_code": "UVJNFHUSJN-0005",
            "user_id": 1443,
            "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,
            "is_claimed": false,
            "enabled": true,
            "created_at": "2025-01-25T13:10:54+03:30",
            "updated_at": "2025-01-25T13:10:54+03:30",
            "total_payment": 500000,
            "used_amount": 0,
            "remain_amount": 500000,
            "claimed_amount": 0,
            "claimed_at": null,
            "expired": false,
            "start_date": "1403/11/06",
            "end_date": "1404/01/01"
        }
    ],
    "status": 200
}

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

---

خطاها

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

---

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

• این API برای دریافت لیست کد تخفیفهای خریداری‌شده استفاده می‌شود.
• مقدار limit تعداد آیتم‌های دریافتی را مشخص می‌کند.
• مقدار offset مشخص می‌کند که چند آیتم اول از لیست رد شوند.