Přejít na hlavní obsah
POST
Vytvoří objednávku zásilky ze zadaného výchozího místa. Cílovou laboratoř určíš pomocí destination_lab. Zásilka půjde na registrovanou doručovací adresu této laboratoře. Vyžaduje scope shipments_manage. Odešli volitelnou hlavičku Idempotency-Key, aby šlo toto vytvoření bezpečně zopakovat — opakované použití stejného klíče vrátí původní odpověď místo vytvoření dalšího záznamu. Viz Idempotence.

Požadavek

Parametry těla

string
povinné
UUID výchozího testovacího místa. Místo musí být aktivní a v přístupovém kontextu tvého API klíče. Dostupná ID míst najdeš přes Vypsat místa.
string
povinné
Cílová laboratoř. Jedna z hodnot zotzklimas, labclinic, nordicgroup, biomes, imd nebo quade. Zásilka půjde na doručovací adresu registrovanou pro tuto laboratoř. Laboratoř bez registrované doručovací adresy vrátí 400.
string
Volitelné UUID termínu, ke kterému se má tato zásilka přiřadit při vytvoření. Termín musí být v přístupovém kontextu tvého API klíče. Propojení se zobrazí přímo jako položka v poli appointments zásilky a obráceně jako položka v poli shipments termínu. Pro přiřazení dalších termínů po vytvoření nebo odebrání původního propojení použij Přiřadit termíny k zásilce a Odebrat termíny ze zásilky.
string
povinné
Datum vyzvednutí ve formátu YYYY-MM-DD (např. 2026-04-15), vyhodnocované v časovém pásmu výchozího místa. Musí to být pracovní den (pondělí–pátek), dnešek nebo budoucí datum. Vyzvednutí ve stejný den není k dispozici po 16:00 Europe/Berlin.
string
povinné
Nejdřívější čas vyzvednutí ve formátu HH:MM (např. 09:00), vyhodnocovaný jako místní čas v časovém pásmu výchozího místa. Musí být mezi 09:00 a 19:00.
string
povinné
Nejpozdější čas vyzvednutí ve formátu HH:MM (např. 12:00), vyhodnocovaný jako místní čas v časovém pásmu výchozího místa. Musí být mezi 09:00 a 19:00. Časové okno (pickup_time_till - pickup_time_from) musí mít alespoň 2 hodiny.
integer
výchozí:"1"
Počet balíků. Výchozí hodnota je 1.
number
výchozí:"0.5"
Hmotnost v kg. Výchozí hodnota je 0.5.
string
Pokyny pro kurýra při vyzvednutí (poznámky odesílatele). Pokud chybí, použijí se uložené poznámky u adresy vyzvednutí (nebo žádné, pokud u adresy nejsou). Maximálně 128 znaků.
string
Volný textový popis obsahu balíku, který se zobrazí kurýrovi a vrátí zpět v poli contents. Maximálně 40 znaků (např. Medizinisch freigestellte Probe).
string
Volitelné interní poznámky. Maximálně 128 znaků.

Odpověď

Při úspěchu vrátí API 201 Created s novou zásilkou.
string
povinné
Referenční identifikátor zásilky (např. P2604151234).
string
povinné
Stav životního cyklu zásilky. Jedna z hodnot pending, in_transit, delivered, fault nebo cancelled.
string
povinné
Poskytovatel logistiky. Jedna z hodnot go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups nebo dhl_express. Balík s domácí sadou je dhl_parcel, případně dhl_warenpost, když jde do zahraničí jako Warenpost International.
string
Externí sledovací číslo od poskytovatele logistiky. Může být null.
string
Volný textový popis obsahu balíku zadaný při vytvoření. Může být null.
string
povinné
Kdo vytiskl štítek: aniva nebo external. Zásilka, kterou vytvoříš, má hodnotu aniva.
string
Reference druhého balíku zásilky se dvěma balíky. Pro jednosměrný balík je null.
object
Adresa vyzvednutí. Může být null.
object
Doručovací adresa. Stejná struktura jako origin. Může být null.
object
Naplánované okno vyzvednutí. Může být null.
string
Volitelné poznámky. Může být null.
object[]
povinné
Chronologické události životního cyklu od poskytovatele logistiky (od nejstarší). Každá položka má state, code, detail_code, status, description, location a time. Jednotlivá pole najdeš v Získat zásilku. Hned po vytvoření je pole prázdné. Synchronizace na pozadí doplňuje události podle toho, jak je poskytovatel hlásí.
ShipmentAppointmentLink[]
povinné
Termíny přiřazené k této zásilce, od nejstaršího přiřazení. Každá položka má tvar { id, added_at }; každé id dohledej přes Získat termín. Hned po vytvoření obsahuje termín předaný přes appointment_id (pokud byl zadán).
ShipmentHomeKitOrderLink[]
povinné
Objednávky domácích sad přiřazené k této zásilce ve stejném tvaru { id, added_at }. Prázdné pole pro zásilku, kterou vytvoříš.
string
Kdy byla zásilka naposledy sladěna s přepravcem, jako okamžik v UTC. null až do první synchronizace.
string
povinné
Časové razítko vytvoření (ISO 8601).
string
Časové razítko poslední aktualizace (ISO 8601). Může být null.

Chybové odpovědi