Naar hoofdinhoud gaan
GET
Haal de zendingen op waartoe je API-sleutel toegang heeft, nieuwste eerst. Elk pakket staat in deze ene lijst: een koeriersophaling bij een praktijk, de kit onderweg naar een thuistestkitpatiënt en het monster op de terugweg. Filter op één bovenliggend item met appointment_id of home_kit_order_id. Vereist de scope shipments_view of shipments_manage. Het antwoord komt uit onze database en roept de vervoerder nooit aan. Een achtergrondsynchronisatie vernieuwt elke zending (elke 10 minuten voor GO!, elk uur voor DHL) en synced_at geeft op elke rij aan wanneer de vervoerder voor het laatst is bevraagd.

Verzoek

Queryparameters

string
Alleen zendingen gekoppeld aan deze afspraak (UUID). 404 als de afspraak niet bestaat, 403 als deze buiten je toegangscontext valt.
string
Alleen zendingen gekoppeld aan deze thuistestkitbestelling (UUID). Meestal komen er twee rijen terug — de kit onderweg naar de patiënt en het monster terug naar het laboratorium (destination is het lab). Dezelfde regels voor 404 / 403 als bij appointment_id.
string
Alleen zendingen met deze status. Een van pending, in_transit, delivered, fault, cancelled.
integer
Maximaal aantal zendingen om terug te geven. Standaard 100, maximaal 500.
integer
Aantal over te slaan zendingen. Standaard 0. De sortering is stabiel (created_at aflopend, daarna referentie), zodat pagina’s elkaar niet overlappen.

Respons

Bij succes geeft de API 200 OK terug met een array van zendingsobjecten.
string
vereist
Referentie-identifier van de zending.
string
vereist
Levenscyclusstatus van de zending. Een van pending, in_transit, delivered, fault of cancelled.
string
vereist
Vervoerder. Een van go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups of dhl_express. Een pakket met een thuistestkit is dhl_parcel, of dhl_warenpost wanneer het naar het buitenland gaat als Warenpost International.
string
Extern trackingnummer van de vervoerder. Kan null zijn.
string
Vrije tekstbeschrijving van de inhoud van het pakket, zoals opgegeven bij het aanmaken (bijv. "Medizinisch freigestellte Probe", "Home test kit"). Alleen ter informatie — of een pakket naar een laboratorium gaat lees je af uit destination, en de tegenhanger ervan uit paired_with. Kan null zijn.
string
vereist
Wie het verzendlabel heeft afgedrukt: aniva of external. Alleen zendingen van aniva ondersteunen Bijwerken en Annuleren; een external-pakket wordt gevolgd, maar geeft bij beide 501 terug.
string
Referentie van het andere pakket in een zending van twee pakketten — het pakket met een retourlabel en het pakket dat met dat label terugkomt. Ingesteld op beide. null bij een enkel pakket.
object
Ophaaladres. Kan null zijn.
object
Bezorgadres. Zelfde structuur als origin. Kan null zijn.
object
Gepland ophaalvenster. Kan null zijn.
string
Optionele notities. Kan null zijn.
object[]
vereist
Chronologische gebeurtenissen in de levenscyclus van de logistieke partner (oudste eerst). Lege array als de aanbieder nog geen gebeurtenissen heeft gemeld. Gebruik dit voor weergave per gebeurtenis, audit en gedetailleerdere signalen van de vervoerder; vertrouw op status voor de definitieve actuele status.
ShipmentAppointmentLink[]
vereist
Afspraken gekoppeld aan deze zending, oudste koppeling eerst. Elk item heeft de vorm { id, added_at }; haal elke id op via Afspraak ophalen voor de volledige gegevens van de afspraak. Lege array als er geen afspraken zijn gekoppeld. Alleen de afspraken binnen je toegangscontext worden weergegeven.
ShipmentHomeKitOrderLink[]
vereist
Thuistestkitbestellingen gekoppeld aan deze zending, oudste koppeling eerst, in dezelfde vorm { id, added_at }. Haal elke id op via Thuistestkitbestelling ophalen. Lege array voor praktijkpakketten. Alleen de bestellingen binnen je toegangscontext worden weergegeven. Zie Toegang.
string
Wanneer de zending voor het laatst met de vervoerder is gesynchroniseerd, als UTC-tijdstip. Leesverzoeken roepen de vervoerder nooit aan — een achtergrondsynchronisatie houdt zendingen actueel — dus dit geeft aan hoe oud het antwoord is. null tot de eerste synchronisatie.
string
vereist
Tijdstempel van aanmaken (ISO 8601).
string
Tijdstempel van laatste update (ISO 8601). Kan null zijn.

Herhaalde aanroepen

Aniva slaat het antwoord van dit endpoint 5 minuten op per API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het opgeslagen antwoord. De headers Cache-Status en Age laten zien dat het antwoord is opgeslagen en hoe oud het is. Abonneer je op de webhook-gebeurtenissen shipment.created en shipment.updated om direct op de hoogte te zijn van wijzigingen. Zie Herhaalde leesverzoeken.

Foutresponsen