Przejdź do głównej treści
POST
Utwórz zlecenie przesyłki ze wskazanej lokalizacji nadania. Docelowe laboratorium określasz przez destination_lab. Przesyłka trafia na zarejestrowany adres wysyłkowy tego laboratorium. Wymaga zakresu shipments_manage. Wyślij opcjonalny nagłówek Idempotency-Key, aby ponawianie tego żądania utworzenia było bezpieczne — powtórzenie tego samego klucza zwraca pierwotną odpowiedź zamiast tworzyć kolejną wizytę. Zobacz Idempotentność.

Żądanie

Parametry treści

string
wymagane
UUID źródłowej lokalizacji badań. Lokalizacja musi być aktywna i znajdować się w kontekście dostępu twojego klucza API. Użyj Wyświetl lokalizacje, aby znaleźć dostępne ID lokalizacji.
string
wymagane
Docelowe laboratorium. Jedna z wartości: zotzklimas, labclinic, nordicgroup, biomes, imd lub quade. Przesyłka trafia na adres wysyłkowy zarejestrowany dla tego laboratorium. Laboratorium bez zarejestrowanego adresu wysyłkowego zwraca 400.
string
Opcjonalny UUID wizyty do powiązania z tą przesyłką w momencie utworzenia. Wizyta musi znajdować się w kontekście dostępu twojego klucza API. Powiązanie pojawia się bezpośrednio jako wpis w tablicy appointments przesyłki oraz odwrotnie jako wpis w tablicy shipments wizyty. Aby powiązać dodatkowe wizyty po utworzeniu lub usunąć początkowe powiązanie, użyj Dołącz wizyty do przesyłki i Odłącz wizyty od przesyłki.
string
wymagane
Data odbioru w formacie YYYY-MM-DD (np. 2026-04-15), interpretowana w strefie czasowej lokalizacji nadania. Musi to być dzień roboczy (poniedziałek–piątek), dzisiaj lub w przyszłości. Odbiory tego samego dnia nie są dostępne po 16:00 czasu Europe/Berlin.
string
wymagane
Najwcześniejsza godzina odbioru w formacie HH:MM (np. 09:00), interpretowana jako czas lokalny w strefie czasowej lokalizacji nadania. Musi mieścić się między 09:00 a 19:00.
string
wymagane
Najpóźniejsza godzina odbioru w formacie HH:MM (np. 12:00), interpretowana jako czas lokalny w strefie czasowej lokalizacji nadania. Musi mieścić się między 09:00 a 19:00. Okno (pickup_time_till - pickup_time_from) musi trwać co najmniej 2 godziny.
integer
domyślnie:"1"
Liczba paczek. Domyślnie 1.
number
domyślnie:"0.5"
Waga w kg. Domyślnie 0.5.
string
Instrukcje dla kuriera przy odbiorze (uwagi nadawcy). Jeśli pominiesz to pole, użyte zostaną zapisane uwagi dla adresu odbioru (lub brak, jeśli adres ich nie ma). Maksymalnie 128 znaków.
string
Dowolny opis zawartości paczki, wyświetlany kurierowi i zwracany w polu contents. Maksymalnie 40 znaków (np. Medizinisch freigestellte Probe).
string
Opcjonalne notatki wewnętrzne. Maksymalnie 128 znaków.

Odpowiedź

W przypadku powodzenia API zwraca 201 Created z nową przesyłką.
string
wymagane
Identyfikator referencyjny przesyłki (np. P2604151234).
string
wymagane
Status cyklu życia przesyłki. Jedna z wartości: pending, in_transit, delivered, fault lub cancelled.
string
wymagane
Dostawca logistyczny. Jedna z wartości: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups lub dhl_express. Paczka z zestawem domowym ma wartość dhl_parcel albo dhl_warenpost, gdy jest wysyłana za granicę jako Warenpost International.
string
Zewnętrzny numer śledzenia od dostawcy logistycznego. Może mieć wartość null.
string
Dowolny opis tekstowy zawartości paczki podany podczas tworzenia. Może mieć wartość null.
string
wymagane
Kto wydrukował etykietę: aniva lub external. Dla utworzonej przez ciebie przesyłki to aniva.
string
Numer referencyjny drugiej paczki w przesyłce dwupaczkowej. null w przypadku paczki w jedną stronę.
object
Adres odbioru. Może mieć wartość null.
object
Adres dostawy. Taka sama struktura jak origin. Może mieć wartość null.
object
Zaplanowane okno odbioru. Może mieć wartość null.
string
Opcjonalne notatki. Może mieć wartość null.
object[]
wymagane
Chronologiczne zdarzenia z cyklu życia przesyłki od dostawcy logistycznego (od najstarszych). Każdy wpis ma pola state, code, detail_code, status, description, location i time. Szczegóły każdego pola znajdziesz w Pobierz przesyłkę. Pusta tablica bezpośrednio po utworzeniu. Synchronizacja w tle dodaje zdarzenia w miarę ich zgłaszania przez dostawcę.
ShipmentAppointmentLink[]
wymagane
Wizyty powiązane z tą przesyłką, od najstarszego powiązania. Każdy wpis ma format { id, added_at }; każde id sprawdź w Pobierz wizytę. Bezpośrednio po utworzeniu zawiera wizytę przekazaną w appointment_id (jeśli została podana).
ShipmentHomeKitOrderLink[]
wymagane
Zamówienia zestawów domowych powiązane z tą przesyłką, w tym samym formacie { id, added_at }. Pusta tablica dla przesyłki utworzonej przez ciebie.
string
Czas ostatniego uzgodnienia stanu przesyłki z przewoźnikiem jako znacznik czasu UTC. null do pierwszej synchronizacji.
string
wymagane
Znacznik czasu utworzenia (ISO 8601).
string
Znacznik czasu ostatniej aktualizacji (ISO 8601). Może mieć wartość null.

Odpowiedzi z błędami