Перейти к основному содержанию
PATCH
Обнови данные отправления, например расписание забора, количество упаковок или заметки. Если меняется любое поле, важное для логистики (дата, время забора, количество упаковок или вес), текущий логистический заказ отменяется и автоматически создается новый. Поля, которые ты не укажешь, сохраняются из существующего отправления. Обновленные поля расписания проверяются на соответствие правилам расписания забора.
Отправление нельзя изменить после забора. Попытка обновить уже забранное отправление возвращает 409 Conflict.
Для посылки с набором для домашнего теста этикетка уже напечатана, поэтому можно изменить только notes. Новое окно забора или вес для такой посылки возвращают 409 Conflict; вместо этого отмени ее и создай новое отправление. Чтобы обновить посылку с набором для домашнего теста, каждый привязанный заказ набора для домашнего теста должен быть в твоем контексте доступа. Иначе запрос вернет 403. См. Доступ.

Запрос

Параметры пути

string
обязательно
Референсный ID отправления (например, P2611194821).

Параметры тела запроса

Все параметры тела запроса необязательны — передавай только те поля, которые хочешь изменить.
string
Новая дата забора в формате YYYY-MM-DD, интерпретируется в часовом поясе места отправления.
string
Новое самое раннее время забора в формате HH:MM, интерпретируется как местное время в часовом поясе места отправления.
string
Новое самое позднее время забора в формате HH:MM, интерпретируется как местное время в часовом поясе места отправления.
integer
Новое количество упаковок.
number
Новый вес в kg.
string
Новые заметки или примечания. Максимум 128 символов.

Ответ

При успехе API возвращает 200 OK с обновленным отправлением.
string
обязательно
Референсный идентификатор отправления.
string
обязательно
Статус жизненного цикла отправления. Одно из значений: pending, in_transit, delivered, fault или 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.

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