Перейти до основного вмісту
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.

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