Hoppa till huvudinnehåll
POST
Skapa en försändelseorder från den angivna avsändarplatsen. Du anger mottagande laboratorium med destination_lab. Försändelsen skickas till det laboratoriets registrerade leveransadress. Kräver scope shipments_manage. Skicka med en valfri Idempotency-Key-header så att anropet säkert kan upprepas – om samma nyckel skickas igen returneras det ursprungliga svaret i stället för att en andra bokning skapas. Se Idempotens.

Förfrågan

Body-parametrar

string
obligatorisk
UUID för avsändande testplats. Platsen måste vara aktiv och ligga inom din API-nyckels åtkomstkontext. Använd Lista platser för att hitta tillgängliga plats-ID:n.
string
obligatorisk
Mottagande laboratorium. Ett av zotzklimas, labclinic, nordicgroup, biomes, imd eller quade. Försändelsen skickas till den leveransadress som är registrerad för det här laboratoriet. Ett laboratorium utan registrerad leveransadress returnerar 400.
string
Valfritt UUID för bokning att koppla till den här försändelsen när den skapas. Bokningen måste ligga inom din API-nyckels åtkomstkontext. Kopplingen visas direkt som en post i försändelsens appointments-array, och omvänt som en post i bokningens shipments-array. För att koppla ytterligare bokningar efter skapandet, eller ta bort den ursprungliga kopplingen, använder du Koppla bokningar till försändelse och Koppla bort bokningar från försändelse.
string
obligatorisk
Upphämtningsdatum i formatet YYYY-MM-DD (t.ex. 2026-04-15), tolkat i avsändarplatsens tidszon. Måste vara en vardag (måndag–fredag), i dag eller i framtiden. Upphämtning samma dag är inte tillgänglig efter 16:00 Europe/Berlin.
string
obligatorisk
Tidigaste upphämtningstid i formatet HH:MM (t.ex. 09:00), tolkat som lokal tid i avsändarplatsens tidszon. Måste vara mellan 09:00 och 19:00.
string
obligatorisk
Senaste upphämtningstid i formatet HH:MM (t.ex. 12:00), tolkat som lokal tid i avsändarplatsens tidszon. Måste vara mellan 09:00 och 19:00. Tidsfönstret (pickup_time_till - pickup_time_from) måste vara minst 2 timmar.
integer
standard:"1"
Antal paket. Standardvärdet är 1.
number
standard:"0.5"
Vikt i kg. Standardvärdet är 0.5.
string
Instruktioner till budet vid upphämtning (avsändarens anmärkningar). Om fältet utelämnas används upphämtningsadressens sparade anmärkningar (eller inga om adressen saknar sådana). Högst 128 tecken.
string
Fritextbeskrivning av paketets innehåll som visas för budet och returneras som contents. Högst 40 tecken (t.ex. Medizinisch freigestellte Probe).
string
Valfria interna anteckningar. Högst 128 tecken.

Svar

Vid lyckat anrop returnerar API:et 201 Created med den nya försändelsen.
string
obligatorisk
Referens-ID för försändelsen (t.ex. P2604151234).
string
obligatorisk
Försändelsens livscykelstatus. Ett av pending, in_transit, delivered, fault eller cancelled.
string
obligatorisk
Logistikleverantör. Ett av go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. Ett paket med hemtestkit använder dhl_parcel, eller dhl_warenpost när det skickas utomlands som Warenpost International.
string
Externt spårningsnummer från logistikleverantören. Kan vara null.
string
Fritextbeskrivning av paketets innehåll, som angavs vid skapandet. Kan vara null.
string
obligatorisk
Vem som skrev ut etiketten: aniva eller external. En försändelse du skapar får aniva.
string
Referens till det andra paketet i en sändning med två paket. null för ett enkelriktat paket.
object
Upphämtningsadress. Kan vara null.
object
Leveransadress. Samma struktur som origin. Kan vara null.
object
Schemalagt upphämtningsfönster. Kan vara null.
string
Valfria anteckningar. Kan vara null.
object[]
obligatorisk
Kronologiska livscykelhändelser från logistikleverantören (äldsta först). Varje post har state, code, detail_code, status, description, location och time. Se Hämta försändelse för respektive fält. Tom array direkt efter skapandet. Bakgrundssynkroniseringen lägger till händelser allt eftersom leverantören rapporterar dem.
ShipmentAppointmentLink[]
obligatorisk
Bokningar kopplade till den här försändelsen, äldsta kopplingen först. Varje post är { id, added_at }; stäm av varje id mot Hämta bokning. Innehåller bokningen som angavs via appointment_id (om någon) direkt efter skapandet.
ShipmentHomeKitOrderLink[]
obligatorisk
Beställningar av hemtestkit som är kopplade till den här försändelsen, med samma { id, added_at }-struktur. Tom array för en försändelse du skapar.
string
När försändelsen senast stämdes av mot sin transportör, som en UTC-tidpunkt. null fram till den första synkroniseringen.
string
obligatorisk
Tidsstämpel för skapande (ISO 8601).
string
Tidsstämpel för senaste uppdatering (ISO 8601). Kan vara null.

Felsvar