Перейти к основному содержанию
POST
Создаёт заказ на отправление из указанной исходной локации. Лабораторию назначения ты указываешь в destination_lab. Отправление идёт на зарегистрированный адрес доставки этой лаборатории. Требуется область доступа shipments_manage. Передай необязательный заголовок Idempotency-Key, чтобы этот запрос на создание можно было безопасно повторять — повтор с тем же ключом вернёт исходный ответ вместо создания второй записи. См. Идемпотентность.

Запрос

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

string
обязательно
UUID исходной локации тестирования. Локация должна быть активной и входить в контекст доступа твоего API-ключа. Используй Список локаций, чтобы найти доступные ID локаций.
string
обязательно
Лаборатория назначения. Одно из значений: zotzklimas, labclinic, nordicgroup, biomes, imd или quade. Отправление идёт на зарегистрированный для этой лаборатории адрес доставки. Для лаборатории без зарегистрированного адреса доставки возвращается 400.
string
Необязательный UUID записи, к которой нужно привязать это отправление при создании. Запись должна входить в контекст доступа твоего API-ключа. Привязка отображается как элемент в массиве appointments отправления и, соответственно, как элемент в массиве shipments записи. Чтобы привязать дополнительные записи после создания или удалить начальную привязку, используй Привязать записи к отправлению и Отвязать записи от отправления.
string
обязательно
Дата забора в формате YYYY-MM-DD (например, 2026-04-15), интерпретируется в часовом поясе исходной локации. Должна быть рабочим днём (понедельник–пятница), сегодня или в будущем. Забор в тот же день недоступен после 16:00 Europe/Berlin.
string
обязательно
Самое раннее время забора в формате HH:MM (например, 09:00), интерпретируется как местное время в часовом поясе исходной локации. Должно быть между 09:00 и 19:00.
string
обязательно
Самое позднее время забора в формате HH:MM (например, 12:00), интерпретируется как местное время в часовом поясе исходной локации. Должно быть между 09:00 и 19:00. Окно (pickup_time_till - pickup_time_from) должно составлять не менее 2 часов.
integer
по умолчанию:"1"
Количество посылок. По умолчанию 1.
number
по умолчанию:"0.5"
Вес в kg. По умолчанию 0.5.
string
Инструкции для курьера при заборе (примечания отправителя). Если не указано, используются сохранённые примечания адреса забора (или ничего, если их нет). Максимум 128 символов.
string
Описание содержимого посылки в свободной форме — показывается курьеру и возвращается в поле contents. Максимум 40 символов (например, Medizinisch freigestellte Probe).
string
Необязательные внутренние заметки. Максимум 128 символов.

Ответ

При успехе API возвращает 201 Created с новым отправлением.
string
обязательно
Справочный идентификатор отправления (например, P2604151234).
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 можно через Получить запись. Сразу после создания содержит запись, переданную в appointment_id (если она была указана).
ShipmentHomeKitOrderLink[]
обязательно
Заказы домашних наборов, привязанные к этому отправлению, в том же формате { id, added_at }. Пустой массив для созданного тобой отправления.
string
Время последней сверки отправления с перевозчиком в UTC. null до первой синхронизации.
string
обязательно
Время создания (ISO 8601).
string
Время последнего обновления (ISO 8601). Может быть null.

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