پرش به مطلب اصلی

تاریخچه استفاده کد تخفیف (Get: Export Voucher History)

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

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

  • آدرس: /api/v2/purchased-voucher/{id}/history/export
  • متد: GET
  • نوع محتوا: text/csv, application/octet-stream (بسته به فرمت خروجی)
  • احراز هویت: نیازمند token

احراز هویت​

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

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

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

پارامترهای Query​

پارامترنوع دادهضروریتوضیحات
formatstringبلهفرمت خروجی: csv یا excel

نمونه درخواست (CSV)​

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

نمونه درخواست (Excel)​

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

پاسخ موفق​

  • در صورت موفقیت، یک فایل CSV یا Excel به عنوان پاسخ دانلود می‌شود.
  • نوع محتوای پاسخ بسته به فرمت انتخابی (text/csv یا application/octet-stream) متفاوت است.

خطاها​

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