Spring til hovedindhold
GET
Hent de forsendelser, som din API-nøgle har adgang til, nyeste først. Alle pakker findes på denne ene liste: en kurerafhentning fra en praksis, kittet på vej til en patient med hjemmetestkit og prøven på vej tilbage. Filtrer til ét overordnet element med appointment_id eller home_kit_order_id. Kræver scopet shipments_view eller shipments_manage. Svaret kommer fra vores database og kalder aldrig fragtfirmaet. En baggrundssynkronisering opdaterer hver forsendelse (hvert 10. minut for GO!, hver time for DHL), og synced_at på hver række fortæller dig, hvornår fragtfirmaet sidst blev forespurgt.

Forespørgsel

Forespørgselsparametre

string
Kun forsendelser tilknyttet denne tid (UUID). 404, når tiden ikke findes, 403, når den ligger uden for din adgangskontekst.
string
Kun forsendelser tilknyttet denne hjemmetestkitordre (UUID). Normalt returneres to rækker – kittet på vej til patienten og prøven tilbage til laboratoriet (dens destination er laboratoriet). Samme regler for 404 / 403 som for appointment_id.
string
Kun forsendelser med denne status. En af pending, in_transit, delivered, fault, cancelled.
integer
Maksimalt antal forsendelser, der returneres. Standard er 100, maks. 500.
integer
Antal forsendelser, der springes over. Standard er 0. Sorteringen er stabil (created_at faldende, derefter reference), så siderne ikke overlapper.

Svar

Ved succes returnerer API’et 200 OK med et array af forsendelsesobjekter.
string
påkrævet
Forsendelsens reference-id.
string
påkrævet
Forsendelsens livscyklusstatus. En af pending, in_transit, delivered, fault eller cancelled.
string
påkrævet
Logistikudbyder. En af go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. En hjemmekit-pakke er dhl_parcel, eller dhl_warenpost, når den sendes til udlandet som Warenpost International.
string
Eksternt sporingsnummer fra logistikudbyderen. Kan være null.
string
Fritekstbeskrivelse af pakkens indhold, som angivet ved oprettelse (f.eks. "Medizinisch freigestellte Probe", "Home test kit"). Kun til information — om en pakke er på vej til et laboratorium, aflæses af destination, og dens modstykke af paired_with. Kan være null.
string
påkrævet
Hvem der udskrev labelen: aniva eller external. Kun aniva-forsendelser understøtter Opdater og Annuller; en external-pakke spores, men returnerer 501 ved begge.
string
Reference til den anden pakke i en forsendelse med to pakker – pakken, der indeholdt en returlabel, og pakken, som den label sender tilbage. Angivet på begge. null for en envejspakke.
object
Afhentningsadresse. Kan være null.
object
Leveringsadresse. Samme struktur som origin. Kan være null.
object
Planlagt afhentningstidsrum. Kan være null.
string
Valgfrie noter. Kan være null.
object[]
påkrævet
Kronologiske livscyklushændelser fra logistikudbyderen (ældste først). Tomt array, hvis udbyderen endnu ikke har rapporteret nogen hændelser. Brug dette til hændelsesvisning, audit og mere detaljerede signaler fra fragtfirmaet; brug status til den gældende aktuelle status.
ShipmentAppointmentLink[]
påkrævet
Tider tilknyttet denne forsendelse, med den ældste tilknytning først. Hvert element er { id, added_at }; slå hvert id op i Hent tid for at få de fulde data for tiden. Tomt array, når ingen tider er tilknyttet. Kun tider i din adgangskontekst vises.
ShipmentHomeKitOrderLink[]
påkrævet
Hjemmetestkitordrer tilknyttet denne forsendelse, med den ældste tilknytning først, i samme { id, added_at }-format. Slå hvert id op i Hent hjemmetestkitordre. Tomt array for praksispakker. Kun ordrer i din adgangskontekst vises. Se Adgang.
string
Hvornår forsendelsen sidst blev afstemt med fragtfirmaet, angivet som UTC-tidspunkt. Læsninger kalder aldrig fragtfirmaet – en baggrundssynkronisering holder forsendelserne opdaterede – så dette viser, hvor gammelt svaret er. null indtil første synkronisering.
string
påkrævet
Tidsstempel for oprettelse (ISO 8601).
string
Tidsstempel for seneste opdatering (ISO 8601). Kan være null.

Gentagne kald

Aniva gemmer svaret fra dette endpoint i 5 minutter for hver API-nøgle. Et gentaget kald inden for dette tidsrum får det gemte svar. Headerne Cache-Status og Age viser, at svaret er gemt, og hvor gammelt det er. For at få besked om en ændring med det samme kan du abonnere på webhook-hændelserne shipment.created og shipment.updated. Se Gentagne læsninger.

Fejlsvar