Hopp til hovedinnhold
POST
Opprett en forsendelsesordre fra det angitte avsenderstedet. Du oppgir mottakerlaboratoriet med destination_lab. Forsendelsen sendes til laboratoriets registrerte leveringsadresse. Krever tilgangsomfanget shipments_manage. Send en valgfri Idempotency-Key-header for å gjøre denne opprettelsen trygg å prøve på nytt — hvis samme nøkkel sendes igjen, returneres det opprinnelige svaret i stedet for å opprette en til. Se Idempotens.

Forespørsel

Body-parametere

string
påkrevd
UUID for avsendende teststed. Stedet må være aktivt og innenfor API-nøkkelens tilgangskontekst. Bruk Vis steder for å finne tilgjengelige steds-ID-er.
string
påkrevd
Mottakerlaboratorium. En av zotzklimas, labclinic, nordicgroup, biomes, imd eller quade. Forsendelsen sendes til leveringsadressen som er registrert for dette laboratoriet. Et laboratorium uten registrert leveringsadresse returnerer 400.
string
Valgfri time-UUID som forsendelsen kobles til ved opprettelse. Timen må være innenfor API-nøkkelens tilgangskontekst. Koblingen vises direkte som en oppføring i forsendelsens appointments-liste, og tilsvarende som en oppføring i timens shipments-liste. For å koble til flere timer etter opprettelse, eller fjerne den opprinnelige koblingen, bruker du Koble timer til forsendelse og Fjern timer fra forsendelse.
string
påkrevd
Hentedato i formatet YYYY-MM-DD (f.eks. 2026-04-15), tolket i avsenderstedets tidssone. Må være en ukedag (mandag–fredag), i dag eller frem i tid. Henting samme dag er ikke tilgjengelig etter 16:00 Europe/Berlin.
string
påkrevd
Tidligste hentetidspunkt i formatet HH:MM (f.eks. 09:00), tolket som lokal klokketid i avsenderstedets tidssone. Må være mellom 09:00 og 19:00.
string
påkrevd
Seneste hentetidspunkt i formatet HH:MM (f.eks. 12:00), tolket som lokal klokketid i avsenderstedets tidssone. Må være mellom 09:00 og 19:00. Vinduet (pickup_time_till - pickup_time_from) må være minst 2 timer.
integer
standard:"1"
Antall pakker. Standard er 1.
number
standard:"0.5"
Vekt i kg. Standard er 0.5.
string
Instruksjoner til budet ved henting (avsendermerknader). Hvis feltet utelates, brukes de lagrede merknadene for henteadressen (eller ingen hvis adressen ikke har noen). Maks 128 tegn.
string
Fritekstbeskrivelse av innholdet i pakken, som vises til budet og returneres som contents. Maks 40 tegn (f.eks. Medizinisch freigestellte Probe).
string
Valgfrie interne notater. Maks 128 tegn.

Respons

Ved suksess returnerer API-et 201 Created med den nye forsendelsen.
string
påkrevd
Referanse-ID for forsendelsen (f.eks. P2604151234).
string
påkrevd
Livssyklusstatus for forsendelsen. En av pending, in_transit, delivered, fault eller cancelled.
string
påkrevd
Logistikkleverandør. Én av go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. En hjemmesettpakke er dhl_parcel, eller dhl_warenpost når den sendes utenlands som Warenpost International.
string
Eksternt sporingsnummer fra logistikkleverandøren. Kan være null.
string
Fritekstbeskrivelse av hva som er i pakken, slik den ble oppgitt ved opprettelse. Kan være null.
string
påkrevd
Hvem som skrev ut etiketten: aniva eller external. En forsendelse du oppretter er aniva.
string
Referanse til den andre pakken i en sending med to pakker. null for en enveispakke.
object
Henteadresse. Kan være null.
object
Leveringsadresse. Samme struktur som origin. Kan være null.
object
Planlagt hentevindu. Kan være null.
string
Valgfrie notater. Kan være null.
object[]
påkrevd
Kronologiske livssyklushendelser fra logistikkleverandøren (eldste først). Hver oppføring har state, code, detail_code, status, description, location og time. Se Hent forsendelse for hvert felt. Tom liste rett etter opprettelse. Bakgrunnssynkroniseringen legger til hendelser etter hvert som leverandøren rapporterer dem.
ShipmentAppointmentLink[]
påkrevd
Timer koblet til denne forsendelsen, eldste kobling først. Hver oppføring er { id, added_at }; kryssreferer hver id mot Hent time. Inneholder timen som ble sendt via appointment_id (hvis noen) rett etter opprettelse.
ShipmentHomeKitOrderLink[]
påkrevd
Hjemmetestbestillinger koblet til denne forsendelsen, med samme { id, added_at }-struktur. Tom liste for en forsendelse du oppretter.
string
Når forsendelsen sist ble avstemt med transportøren, som et UTC-tidspunkt. null frem til første synkronisering.
string
påkrevd
Tidsstempel for opprettelse (ISO 8601).
string
Tidsstempel for siste oppdatering (ISO 8601). Kan være null.

Feilresponser