Перейти к основному содержанию
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.

Ответы с ошибками