مشاهده محدودیت مکانی (Get: Location Whitelist)

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

---

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

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

---

احراز هویت

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

---

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

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

---

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

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

---

پاسخ موفق

{
  "data": [
    {
      "created_at": "string",
      "id": 0,
      "location_type": 1,
      "name": "string",
      "updated_at": "string"
    }
  ],
  "message": "string",
  "status": 0,
  "voucher": {
    "bulk_count": 0,
    "created_at": "string",
    "enabled": true,
    "end_date": "string",
    "id": 0,
    "is_claimed": true,
    "mode": 0,
    "percent_value": 0,
    "start_date": "string",
    "static_value": 0,
    "title": "string",
    "total_max_use_times": 0,
    "type": 0,
    "updated_at": "string",
    "user_id": 0,
    "user_max_use_times": 0,
    "value_cap": 0,
    "voucher_code": "string"
  }
}

---

توضیحات فیلدهای پاسخ

لیست موقعیت‌های سفید شده (data)

فیلد	نوع داده	توضیحات
id	integer	شناسه موقعیت مکانی در لیست سفید
name	string	نام موقعیت مکانی
location_type	integer	نوع موقعیت مکانی (۱: مبدأ، ۲: مقصد)
created_at	string	تاریخ ایجاد موقعیت مکانی
updated_at	string	تاریخ آخرین بروزرسانی موقعیت مکانی

اطلاعات کد تخفیف (voucher)

فیلد	نوع داده	توضیحات
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	وضعیت دریافت‌شده بودن کد تخفیف
created_at	string	تاریخ ایجاد کد تخفیف
updated_at	string	تاریخ آخرین بروزرسانی کد تخفیف

---

خطاها

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

---

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

• location_type مشخص می‌کند که موقعیت مکانی برای مبدأ (۱) یا مقصد (۲) است.
• اگر کد تخفیف دارای موقعیت‌های سفید نباشد، مقدار data آرایه‌ای خالی خواهد بود.