Перейти к основному содержанию
GET
Получи отправления, доступные твоему API-ключу, начиная с самых новых. В этом общем списке есть любая посылка: забор курьером из практики, набор для домашнего теста по пути к пациенту и образец на пути обратно. Отфильтруй список по одному родительскому объекту с помощью appointment_id или home_kit_order_id. Требуется область доступа shipments_view или shipments_manage. Ответ приходит из нашей базы данных и никогда не обращается к перевозчику. Фоновая синхронизация обновляет каждое отправление (каждые 10 минут для GO! и раз в час для DHL), а поле synced_at в каждой строке показывает, когда в последний раз опрашивали перевозчика.

Запрос

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

string
Только отправления, привязанные к этой записи (UUID). 404, если запись не существует, и 403, если она вне твоего контекста доступа.
string
Только отправления, привязанные к этому заказу набора для домашнего теста (UUID). Обычно возвращаются две строки — набор по пути к пациенту и образец обратно в лабораторию (его destination — лаборатория). Те же правила для 404 / 403, что и для appointment_id.
string
Только отправления в этом статусе. Одно из значений: pending, in_transit, delivered, fault, cancelled.
integer
Максимальное количество возвращаемых отправлений. По умолчанию 100, максимум 500.
integer
Количество пропускаемых отправлений. По умолчанию 0. Сортировка стабильна (по убыванию created_at, затем по номеру), поэтому страницы не пересекаются.

Ответ

При успехе 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 хранит ответ этого эндпоинта 5 минут для каждого API-ключа. Повторный запрос в течение этого времени получает сохранённый ответ. Заголовки Cache-Status и Age показывают, что ответ сохранён, и как давно он получен. Чтобы сразу узнавать об изменениях, подпишись на события вебхука shipment.created и shipment.updated. См. Повторное чтение.

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