Siirry pääsisältöön
POST
Luo lähetystilaus määritetystä lähtötoimipisteestä. Määrität kohdelaboratorion kentällä destination_lab. Lähetys menee kyseisen laboratorion rekisteröityyn toimitusosoitteeseen. Vaatii shipments_manage-käyttöoikeuden. Lähetä valinnainen Idempotency-Key-otsikko, jotta luontipyynnön voi yrittää turvallisesti uudelleen — saman avaimen toistaminen palauttaa alkuperäisen vastauksen toisen luomisen sijaan. Katso Idempotenssi.

Pyyntö

Runkoparametrit

string
vaadittu
Lähtöpaikkana toimivan testitoimipisteen UUID. Toimipisteen on oltava aktiivinen ja API-avaimesi käyttöoikeusalueella. Löydät käytettävissä olevat toimipistetunnukset kohdasta Listaa toimipisteet.
string
vaadittu
Kohdelaboratorio. Yksi arvoista zotzklimas, labclinic, nordicgroup, biomes, imd tai quade. Lähetys menee tälle laboratoriolle rekisteröityyn toimitusosoitteeseen. Laboratorio, jolla ei ole rekisteröityä toimitusosoitetta, palauttaa koodin 400.
string
Valinnainen ajanvarauksen UUID, johon tämä lähetys liitetään luontihetkellä. Ajanvarauksen on oltava API-avaimesi käyttöoikeusalueella. Liitos näkyy suoraan merkintänä lähetyksen appointments-taulukossa ja vastaavasti merkintänä ajanvarauksen shipments-taulukossa. Jos haluat liittää lisää ajanvarauksia luonnin jälkeen tai poistaa alkuperäisen liitoksen, käytä päätepisteitä Liitä ajanvarauksia lähetykseen ja Irrota ajanvarauksia lähetyksestä.
string
vaadittu
Noutopäivä muodossa YYYY-MM-DD (esim. 2026-04-15), tulkittuna lähtötoimipisteen aikavyöhykkeessä. Päivän on oltava arkipäivä (maanantai–perjantai), tänään tai tulevaisuudessa. Saman päivän noudot eivät ole saatavilla klo 16.00 Europe/Berlin jälkeen.
string
vaadittu
Aikaisin noutoaika muodossa HH:MM (esim. 09:00), tulkittuna paikallisena kellonaikana lähtötoimipisteen aikavyöhykkeessä. Arvon on oltava välillä 09:00–19:00.
string
vaadittu
Viimeisin noutoaika muodossa HH:MM (esim. 12:00), tulkittuna paikallisena kellonaikana lähtötoimipisteen aikavyöhykkeessä. Arvon on oltava välillä 09:00–19:00. Aikaikkunan (pickup_time_till - pickup_time_from) on oltava vähintään 2 tuntia.
integer
oletus:"1"
Pakettien määrä. Oletus on 1.
number
oletus:"0.5"
Paino (kg). Oletus on 0.5.
string
Ohjeet kuriirille noutoa varten (lähettäjän huomautukset). Jos kenttä jätetään pois, käytetään nouto-osoitteeseen tallennettuja huomautuksia (tai ei mitään, jos osoitteella ei ole niitä). Enintään 128 merkkiä.
string
Vapaamuotoinen kuvaus paketin sisällöstä, joka näytetään kuriirille ja palautetaan kentässä contents. Enintään 40 merkkiä (esim. Medizinisch freigestellte Probe).
string
Valinnaiset sisäiset muistiinpanot. Enintään 128 merkkiä.

Vastaus

Onnistuessaan API palauttaa tilakoodin 201 Created ja uuden lähetyksen.
string
vaadittu
Lähetyksen viitetunnus (esim. P2604151234).
string
vaadittu
Lähetyksen elinkaaritila. Yksi arvoista pending, in_transit, delivered, fault tai cancelled.
string
vaadittu
Logistiikkapalveluntarjoaja. Yksi arvoista go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups tai dhl_express. Kotitestipaketin lähetys on dhl_parcel, tai dhl_warenpost, kun se lähetetään ulkomaille Warenpost International -lähetyksenä.
string
Logistiikkapalveluntarjoajan ulkoinen seurantanumero. Voi olla null.
string
Vapaamuotoinen kuvaus paketin sisällöstä sellaisena kuin se annettiin luotaessa. Voi olla null.
string
vaadittu
Kuka tulosti lähetystarran: aniva tai external. Luomasi lähetyksen arvo on aniva.
string
Kahden paketin lähetyksen toisen paketin viite. null yhdensuuntaiselle paketille.
object
Nouto-osoite. Voi olla null.
object
Toimitusosoite. Sama rakenne kuin kentässä origin. Voi olla null.
object
Ajoitettu noutoaikaikkuna. Voi olla null.
string
Valinnaiset muistiinpanot. Voi olla null.
object[]
vaadittu
Logistiikkapalveluntarjoajan elinkaaritapahtumat aikajärjestyksessä (vanhin ensin). Jokaisessa merkinnässä on state, code, detail_code, status, description, location ja time. Katso kenttien kuvaukset kohdasta Hae lähetys. Tyhjä taulukko heti luonnin jälkeen. Taustasynkronointi lisää tapahtumia sitä mukaa kun palveluntarjoaja ilmoittaa niistä.
ShipmentAppointmentLink[]
vaadittu
Tähän lähetykseen liitetyt ajanvaraukset, vanhin liitos ensin. Jokainen merkintä on muodossa { id, added_at }; tarkista kunkin id-arvon tiedot päätepisteestä Hae ajanvaraus. Sisältää heti luonnin jälkeen mahdollisen appointment_id-kentässä annetun ajanvarauksen.
ShipmentHomeKitOrderLink[]
vaadittu
Tähän lähetykseen liitetyt kotitestitilaukset samassa { id, added_at } -muodossa. Tyhjä taulukko luomallesi lähetykselle.
string
Milloin lähetys täsmäytettiin viimeksi kuljetusyhtiön kanssa (UTC-ajankohta). null ensimmäiseen synkronointiin asti.
string
vaadittu
Luontiaikaleima (ISO 8601).
string
Viimeisimmän päivityksen aikaleima (ISO 8601). Voi olla null.

Virhevastaukset