Hoppa till huvudinnehåll
GET
Hämta de försändelser som din API-nyckel har åtkomst till, nyast först. Alla paket finns i den här enda listan: en budhämtning från en mottagning, kitet på väg till en patient med hemtestkit och provet på väg tillbaka. Filtrera till en överordnad post med appointment_id eller home_kit_order_id. Kräver scope shipments_view eller shipments_manage. Svaret kommer från vår databas och anropar aldrig transportören. En bakgrundssynkronisering uppdaterar varje försändelse (var 10:e minut för GO!, varje timme för DHL) och synced_at på varje rad visar när transportören senast tillfrågades.

Förfrågan

Frågeparametrar

string
Endast försändelser kopplade till den här bokningen (UUID). 404 när bokningen inte finns, 403 när den ligger utanför din åtkomstkontext.
string
Endast försändelser kopplade till den här beställningen av hemtestkit (UUID). Normalt kommer två rader tillbaka – kitet på väg till patienten och provet tillbaka till laboratoriet (dess destination är laboratoriet). Samma regler för 404 / 403 som för appointment_id.
string
Endast försändelser med den här statusen. Ett av pending, in_transit, delivered, fault, cancelled.
integer
Maximalt antal försändelser att returnera. Standard är 100, max 500.
integer
Antal försändelser att hoppa över. Standard är 0. Sorteringen är stabil (created_at fallande, sedan referens), så sidorna överlappar inte.

Svar

Vid lyckat anrop returnerar API:et 200 OK med en array av försändelseobjekt.
string
obligatorisk
Försändelsens referensidentifierare.
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 så som den angavs när försändelsen skapades (t.ex. "Medizinisch freigestellte Probe", "Home test kit"). Endast i informationssyfte — om ett paket är på väg till ett laboratorium utläses från destination, och dess motpart från paired_with. Kan vara null.
string
obligatorisk
Vem som skrev ut etiketten: aniva eller external. Endast aniva-försändelser tar emot Uppdatera och Avboka; ett external-paket spåras men returnerar 501 vid båda.
string
Referens till det andra paketet i en sändning med två paket – paketet som hade med en returetikett och paketet som etiketten skickar tillbaka. Anges på båda. null för ett paket som bara går åt ett håll.
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 (äldst först). Tom array om leverantören inte har rapporterat några händelser ännu. Använd detta för händelsevyer i gränssnittet, granskning och mer detaljerade signaler från transportören; förlita dig på status för den aktuella huvudstatusen.
ShipmentAppointmentLink[]
obligatorisk
Bokningar kopplade till denna försändelse, äldsta kopplingen först. Varje post är { id, added_at }; slå upp varje id med Hämta bokning för hela bokningsobjektet. Tom array när inga bokningar är kopplade. Endast bokningarna i din åtkomstkontext listas.
ShipmentHomeKitOrderLink[]
obligatorisk
Beställningar av hemtestkit kopplade till denna försändelse, äldsta kopplingen först, med samma struktur { id, added_at }. Slå upp varje id med Hämta beställning av hemtestkit. Tom array för paket från mottagningar. Endast beställningarna i din åtkomstkontext listas. Se Åtkomst.
string
När försändelsen senast stämdes av mot transportören, som en UTC-tidpunkt. Läsningar anropar aldrig transportören – en bakgrundssynkronisering håller försändelserna uppdaterade – så det här visar hur gammalt svaret är. 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.

Upprepade anrop

Aniva lagrar svaret från den här slutpunkten i 5 minuter per API-nyckel. Ett upprepat anrop inom den tiden får det lagrade svaret. Headerna Cache-Status och Age visar att svaret är lagrat och hur gammalt det är. För att få veta om en ändring direkt, prenumerera på webhook-händelserna shipment.created och shipment.updated. Se Upprepade läsningar.

Felsvar