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

لغو سفر (Cancel)

برای لغو کردن یک سفر بر اساس شناسه (ID) آن استفاده می‌شود.

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

  • آدرس: /api/v2/ride/{ride_id}/cancel
  • متد: PATCH
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

احراز هویت​

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

پارامترهای درخواست​

درخواست باید شامل پارامتر زیر در URL باشد:

فیلدنوع دادهضروریتوضیحات
ride_idstringبلهشناسه سفر که باید لغو شود

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

curl 'https://corporate.snapp.site/api/v2/ride/SNP-250223-02506-0982/cancel' \
  -X 'PATCH' \
  -H 'Authorization: <your_authorization_token>' \

پاسخ موفق​

{
    "data": {
        "message": "Ride Cancelled Successfully"
    },
    "status": 200
}
فیلدنوع دادهتوضیحات
dataobjectحاوی اطلاعات مربوط به نتیجه عملیات
messagestringپیام موفقیت آمیز لغو سفر
statusintegerکد وضعیت پاسخ (200 برای موفقیت)

خطاها​

کد وضعیتتوضیحات
400درخواست نامعتبر
401نیاز به احراز هویت
404سفر پیدا نشد
500خطای داخلی سرور

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

  • اطمینان حاصل کنید که شناسه سفر (ride_id) درست است و سفر مورد نظر فعال است تا بتوانید آن را لغو کنید.
  • اگر سفر قبلاً لغو شده باشد یا وضعیت آن تغییر کرده باشد، ممکن است با خطا مواجه شوید.
  • توجه داشته باشید که فقط سفر هایی که وضعیت انها STARTED, ACCEPTED یا ARRIVED باشند قابل لغو هستند.