تاریخچه کد تخفیف تک‌عددی (Get: Single Voucher History)

مستندات API دریافت تاریخچه سفرهای یک کد تخفیف خریداری‌شده

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

---

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

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

---

احراز هویت

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

---

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

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

---

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

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

---

پاسخ موفق

{
  "data": [
    {
      "city": "string",
      "corporate_discount": 0,
      "destination_formatted_address": "string",
      "destination_lat": "string",
      "destination_lng": "string",
      "driver_id": 0,
      "driver_id_number": "string",
      "driver_name": "string",
      "driver_photo": "string",
      "extra_destination_formatted_address": "string",
      "extra_destination_lat": "string",
      "extra_destination_lng": "string",
      "extra_destination_price": 0,
      "origin_formatted_address": "string",
      "origin_lat": "string",
      "origin_lng": "string",
      "passenger_cellphone": "string",
      "passenger_email": "string",
      "passenger_name": "string",
      "payment_method": "string",
      "price": 0,
      "ride_hri": "string",
      "ride_in_hurry": true,
      "ride_status": 0,
      "round_trip_price": 0,
      "service_type": "string",
      "used_at": "string",
      "waiting": "string",
      "waiting_price": 0
    }
  ],
  "is_used": true,
  "voucher": {
    "title": "string",
    "used_at": "string",
    "voucher_code": "string"
  }
}

---

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

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

فیلد	نوع داده	توضیحات
voucher_code	string	کد تخفیف
title	string	عنوان کد تخفیف (اختیاری)
used_at	string	تاریخ و زمان استفاده از کد تخفیف (اختیاری)

تاریخچه سفرها (data)

فیلد	نوع داده	توضیحات
used_at	string	تاریخ و زمان استفاده از کد تخفیف در سفر
passenger_name	string	نام مسافر
passenger_cellphone	string	شماره تلفن همراه مسافر
passenger_email	string	ایمیل مسافر
service_type	string	نوع سرویس (مثلاً پیک، تاکسی)
price	uint	قیمت سفر
corporate_discount	uint	تخفیف سازمانی اعمال شده
ride_in_hurry	bool	آیا سفر فوری بوده است؟
ride_status	int	وضعیت سفر
ride_hri	string	شناسه سفر
driver_id	uint	شناسه راننده
driver_name	string	نام راننده
driver_photo	string	لینک عکس راننده
driver_id_number	string	شماره شناسایی راننده
origin_formatted_address	string	آدرس مبدأ
origin_lat	string	عرض جغرافیایی مبدأ
origin_lng	string	طول جغرافیایی مبدأ
destination_formatted_address	string	آدرس مقصد
destination_lat	string	عرض جغرافیایی مقصد
destination_lng	string	طول جغرافیایی مقصد
extra_destination_formatted_address	string	آدرس مقصد اضافی (اختیاری)
extra_destination_lat	string	عرض جغرافیایی مقصد اضافی (اختیاری)
extra_destination_lng	string	طول جغرافیایی مقصد اضافی (اختیاری)
extra_destination_price	uint	قیمت مقصد اضافی (اختیاری)
payment_method	string	روش پرداخت
waiting	string	مدت زمان انتظار
waiting_price	uint	هزینه انتظار
round_trip_price	uint	هزینه سفر رفت و برگشت
city	string	شهر محل انجام سفر

وضعیت استفاده (is_used)

فیلد	نوع داده	توضیحات
is_used	boolean	نشان‌دهنده استفاده شدن یا نشدن کد تخفیف

---

خطاها

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