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

لغو سفارش با شناسه

👋 Introduction

با فراخوانی این مسیر می‌تونی یه سفارش خاص خودت رو با استفاده از شناسه‌اش لغو کنی.

🔗 Endpoint

DELETE /api/v1/odr/orders/{order_id}/

Rate Limit

اطلاعیه

حداکثر تعداد درخواست‌های مجاز برای لغو سفارش برابر با 5400 درخواست در ساعت هست.

📨 Request Example

curl --location --request DELETE 'https://api.bitpin.ir/api/v1/odr/orders/{order_id}/' \  
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
اطلاعیه

حتماً مطمئن شو که شناسه‌ی سفارش (order_id) رو به درستی وارد کردی. این شناسه باید به سفارشی که می‌خوای لغو کنی، اختصاص داشته باشه.

💬 Responses

  • اگه درخواست موفق باشه، کد 204 No Content برگردونده می‌شه که به معنی لغو موفقیت‌آمیز سفارشه.
  • اگه درخواست ناموفق باشه، کد 406 Not Acceptable برگردونده می‌شه که نشون می‌ده درخواست لغو با مشکل مواجه شده.

Error Responses

{
"detail": "not allowed"
}
اخطار
  • کد 406: درخوسات غیر قابل قبول.