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

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