Перейти до основного вмісту
GET
Отримай одне відправлення за його референсним ID. Відповідь надходить із нашої бази даних і ніколи не звертається до перевізника. Фонова синхронізація оновлює кожне відправлення (кожні 10 хвилин для GO!, щогодини для DHL), а synced_at показує, коли востаннє опитували перевізника. Потребує області доступу shipments_view або shipments_manage.

Запит

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

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

Відповідь

У разі успіху 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
Довільний текстовий опис вмісту посилки, вказаний під час створення (наприклад, "Medizinisch freigestellte Probe", "Home test kit"). Лише для інформації — чи прямує посилка до лабораторії, визначається за destination, а її парне відправлення — за paired_with. Може бути null.
string
обов'язково
Хто надрукував етикетку: aniva або external. Лише відправлення aniva підтримують Оновлення та Скасування; посилка external відстежується, але повертає 501 на обидва запити.
string
Номер іншої посилки у відправленні з двох посилок — тієї, що доставила зворотну етикетку, і тієї, яку ця етикетка повертає назад. Заповнено в обох. null для односторонньої посилки.
object
Адреса забору відправлення. Може бути null.
object
Адреса доставки. Така сама структура, як в origin. Може бути null.
object
Заплановане вікно забору. Може бути null.
string
Необов’язкові примітки. Може бути null.
object[]
обов'язково
Хронологічні події життєвого циклу від логістичного провайдера (спочатку найстаріші). Порожній масив, якщо провайдер ще не передав жодної події. Використовуй це поле для відображення окремих подій в інтерфейсі, аудиту й детальніших сигналів перевізника; для канонічного поточного стану орієнтуйся на status.
ShipmentAppointmentLink[]
обов'язково
Записи, пов’язані з цим відправленням, спочатку найраніше додані. Кожен елемент має вигляд { id, added_at }; використай кожен id в Отримати запис, щоб отримати повні дані запису. Порожній масив, якщо пов’язаних записів немає. У списку лише ті записи, що входять у твій контекст доступу.
ShipmentHomeKitOrderLink[]
обов'язково
Замовлення наборів для домашнього тесту, пов’язані з цим відправленням, спочатку найраніше додані, у тій самій формі { id, added_at }. Використай кожен id в Отримати замовлення набору для домашнього тесту. Порожній масив для посилок із практик. У списку лише замовлення у твоєму контексті доступу. Див. Доступ.
string
Коли відправлення востаннє звірялося з перевізником, у форматі часу UTC. Запити на читання ніколи не звертаються до перевізника — дані оновлює фонова синхронізація — тож це поле показує, наскільки свіжою є відповідь. null до першої синхронізації.
string
обов'язково
Часова мітка створення (ISO 8601).
string
Часова мітка останнього оновлення (ISO 8601). Може бути null.

Повторні виклики

Aniva зберігає відповідь цього ендпоінта протягом 60 хвилин для кожного API-ключа. Повторний виклик у межах цього часу отримує збережену відповідь, доки відправлення не змінилося. Після зміни ти отримуєш свіжу відповідь. Заголовки Cache-Status і Age показують, що відповідь збережена та скільки їй часу. У збереженій відповіді значення synced_at і updated_at можуть бути старішими, ніж у свіжій відповіді. Щоб дізнаватися про зміни одразу, підпишись на вебхук-події shipment.created і shipment.updated. Див. Повторні читання.

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