اگر پس از ثبت سفارش، نیاز به لغو آن داشته باشید، از این سرویس استفاده می‌شود.
الزامات و قوانین لغو سفارش
لغو کلی سفارش (Shipment-Level): فرآیند لغو در سیستم دیجی‌اکسپرس صرفاً و منحصراً بر روی کل سفارش (Shipment) امکان‌پذیر است. امکان لغو کردن یک یا چند بسته (Parcel) به صورت مجزا در یک سفارش چندبسته‌ای وجود ندارد؛ چرا که دیجی‌اکسپرس کل سفارش را یک واحد عملیاتی یکپارچه در نظر می‌گیرد.
مکانیزم همگام (Sync): سرویس لغو به صورت همگام (Synchronous) عمل می‌کند؛ یعنی سیستم در همان لحظه فراخوانی، وضعیت را بررسی کرده و نتیجه قطعی را در ریسپانس برمی‌گرداند. در صورت موفقیت، علاوه بر دریافت HTTP Code 200، تغییر وضعیت سفارش به حالت Canceled از طریق وب‌هوک نیز به سرور شما شلیک می‌شود.
بازه زمانی مجاز و محدودیت‌های لغو
شما تا زمانی مجاز به لغو سفارش هستید که بار در مراحل اولیه لجستیک باشد. در شرایط زیر سیستم اجازه لغو به شما نداده و خطا برمی‌گرداند:
توزیع (Last-mile): اگر بسته وارد مراحل نهایی توزیع شده و در نزدیکی تحویل به مشتری (Last-mile ride start) باشد، امکان لغو سیستمی بسته می‌شود.
سفارشات نهایی شده: لغو سفارشی که قبلاً تحویل مشتری شده یا از قبل لغو شده باشد، امکان‌پذیر نیست.
سرویس لغو سفارش (Cancel Shipment)
https://api-demo.digiexpress.ir/api/v2/shipments/{shipment_id_or_ref}/status/cancel- Header: Authorization: YOUR_JWT_TOKEN
این متد فاقد بدنه (Request Body) است و شناسایی سفارش کاملاً از طریق آدرس (URL) انجام می‌شود.
جدول پارامترهای آدرس (Path Variables)
- توضیح فنی
- شناسه سفارش دیجی‌اکسپرس (shipment_id) یا کد مرجع سمت کانساینر (shipment_ref).
- توضیح بیزینسی
- مشخصه سفارشی که قصد دارید کل فرآیند ارسال آن را متوقف و لغو کنید.
جدول وضعیت‌ها و خطاهای پاسخ (Response Codes & Errors)
- کد خطا (Error Code)
- —
- شرح بیزینسی و علت خطا
- سفارش با موفقیت لغو شد.
- کد خطا (Error Code)
- 1145
- شرح بیزینسی و علت خطا
- سفارش قبلاً لغو شده است.
- کد خطا (Error Code)
- 1014
- شرح بیزینسی و علت خطا
- امکان لغو وجود ندارد؛ مرسوله به مشتری تحویل داده شده است.
- کد خطا (Error Code)
- 1103
- شرح بیزینسی و علت خطا
- امکان لغو وجود ندارد؛ مرسوله در فرآیند عودت یا بازگشت به فرستنده (سلر) است.
- کد خطا (Error Code)
- 1153
- شرح بیزینسی و علت خطا
- عدم امکان لغو توسط ناوگان؛ مرسوله در راید توزیع نهایی (Last-mile) یا آخرین راید واسط (Mid-mile) سفارشات پستی قرار دارد.
- کد خطا (Error Code)
- 1015
- شرح بیزینسی و علت خطا
- امکان لغو سفارش در وضعیت عملیاتی جاری وجود ندارد.