Перейти до основного вмісту
DELETE
Скасуй замовлення на відправлення. Це викликає API логістичного провайдера для скасування замовлення та оновлює статус відправлення на cancelled. Скасування відправлення, яке вже має статус cancelled, повертає 200 із цим відправленням, а провайдер викликається лише один раз. Відповідь містить заголовок Idempotent-Replayed: true, щоб можна було відрізнити повторний виклик від того, що виконав дію. Див. Ідемпотентність.
Відправлення не можна скасувати після забору відправлення — у такому разі повертається 409 Conflict.
Зворотну етикетку DHL не можна скасувати окремо — це також повертає 409 Conflict. Натомість скасуй вихідну посилку. Скасування вихідної посилки DHL також скасовує пов’язані з нею рядки зворотного відправлення зі статусом pending. Кожен із них отримує статус cancelled із записом RETURN_LEG_CANCELLED у status_updates. Див. Зворотні етикетки. У коробці з кількома наборами кожен набір має власний рядок вихідного відправлення та власну зворотну етикетку, навіть коли коробка їде за етикеткою одного з наборів. Скасування рядка вихідного відправлення набору також скасовує його зворотну етикетку. Щоб скасувати посилку з домашнім набором, кожне пов’язане замовлення домашнього набору має бути у твоєму контексті доступу. Інакше запит поверне 403. Див. Доступ.

Запит

Параметри шляху

string
обов'язково
Референсний ID відправлення (наприклад, P2611194821).

Відповідь

У разі успіху API повертає 200 OK з об’єктом скасованого відправлення.
string
обов'язково
Ідентифікатор відправлення.
string
обов'язково
Статус життєвого циклу відправлення. Після успішного скасування матиме значення cancelled.
string
обов'язково
Логістичний провайдер. Одне зі значень: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups або dhl_express. Для посилки з домашнім набором це dhl_parcel, або dhl_warenpost, якщо вона прямує за кордон як Warenpost International.
string
Зовнішній трек-номер від логістичного провайдера. Може бути null.
string
Опис вмісту посилки в довільній формі, вказаний під час створення. Може бути null.
string
обов'язково
Хто надрукував етикетку: aniva або external. Цей запит підтримується лише для відправлень aniva.
string
Ідентифікатор іншої посилки в парному відправленні. null для посилки в один бік.
object
Адреса забору відправлення. Може бути null.
object
Адреса доставки. Така сама структура, як в origin. Може бути null.
object
Заплановане вікно забору. Може бути null.
string
Необов’язкові примітки. Може бути null.
object[]
обов'язково
Хронологічні події життєвого циклу від логістичного провайдера (спочатку найстаріші). Кожен елемент містить state, code, detail_code, status, description, location і time. Опис кожного поля дивись в Отримати відправлення. Порожній масив, якщо подій ще не зафіксовано.
ShipmentAppointmentLink[]
обов'язково
Записи, які були прив’язані до цього відправлення до скасування. Кожен елемент має вигляд { id, added_at }; звіряй кожен id через Отримати запис. У списку лише записи з твого контексту доступу.
ShipmentHomeKitOrderLink[]
обов'язково
Замовлення домашніх наборів, прив’язані до цього відправлення (спочатку найдавніші), у тому ж форматі { id, added_at }. У списку лише замовлення з твого контексту доступу. Порожній масив для посилок із практик.
string
Коли відправлення востаннє звірялося з перевізником, як момент часу UTC. null до першої синхронізації.
string
обов'язково
Часова мітка створення (ISO 8601).
string
Часова мітка останнього оновлення (ISO 8601). Може бути null.

Відповіді з помилками