Hopp til hovedinnhold
GET
Hent én enkelt forsendelse med referanse-ID-en. Svaret kommer fra databasen vår og kaller aldri transportøren. En bakgrunnssynkronisering oppdaterer alle forsendelser (hvert 10. minutt for GO!, hver time for DHL), og synced_at viser når transportøren sist ble spurt. Krever tilgangsomfanget shipments_view eller shipments_manage.

Forespørsel

Stiparametere

string
påkrevd
Forsendelsens referanse-ID (f.eks. P2611194821).

Respons

Ved suksess returnerer API-et 200 OK med forsendelsesobjektet.
string
påkrevd
Referanseidentifikator for forsendelsen.
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 innholdet i pakken, slik den ble oppgitt ved opprettelse (f.eks. "Medizinisch freigestellte Probe", "Home test kit"). Kun til informasjon — om en pakke skal til et laboratorium, leses av fra destination, og motparten fra paired_with. Kan være null.
string
påkrevd
Hvem som skrev ut etiketten: aniva eller external. Bare aniva-forsendelser godtar Oppdater og Kanseller; en external-pakke spores, men returnerer 501 på begge.
string
Referansen til den andre pakken i en topakkeforsendelse – pakken som hadde med en returetikett, og pakken den etiketten sender tilbake. Satt på begge. 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). Tom liste hvis leverandøren ikke har rapportert noen hendelser ennå. Bruk dette til brukergrensesnitt per hendelse, revisjon og mer detaljerte transportørsignaler; bruk status for den gjeldende hovedtilstanden.
ShipmentAppointmentLink[]
påkrevd
Timer knyttet til denne forsendelsen, med eldste kobling først. Hver oppføring er { id, added_at }; slå opp hver id i Hent time for å få alle timedataene. Tom liste når ingen timer er tilknyttet. Bare timene i din tilgangskontekst vises.
ShipmentHomeKitOrderLink[]
påkrevd
Bestillinger av hjemmetestsett knyttet til denne forsendelsen, med eldste kobling først, i samme { id, added_at }-format. Slå opp hver id i Hent bestilling av hjemmetestsett. Tom liste for praksispakker. Bare bestillingene i din tilgangskontekst vises. Se Tilgang.
string
Når forsendelsen sist ble avstemt med transportøren, som et UTC-tidspunkt. Leseoperasjoner kaller aldri transportøren – en bakgrunnssynkronisering holder forsendelsene oppdatert – så dette viser hvor gammelt svaret er. 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.

Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 60 minutter for hver API-nøkkel. Et gjentatt kall innenfor dette tidsrommet får det lagrede svaret så lenge forsendelsen er uendret. Etter en endring får du et ferskt svar. Headerne Cache-Status og Age viser at svaret er lagret og hvor gammelt det er. I et lagret svar kan synced_at og updated_at være eldre enn i et ferskt svar. For å få beskjed om en endring med en gang, abonner på webhook-hendelsene shipment.created og shipment.updated. Se Gjentatte lesekall.

Feilresponser