Przejdź do głównej treści
GET
Pobierz przesyłki dostępne dla twojego klucza API, od najnowszej. Na tej jednej liście znajdują się wszystkie paczki: odbiór kurierski z gabinetu, domowy zestaw testowy w drodze do pacjenta oraz próbka w drodze powrotnej. Filtruj do jednego obiektu nadrzędnego za pomocą appointment_id lub home_kit_order_id. Wymaga zakresu shipments_view lub shipments_manage. Odpowiedź pochodzi z naszej bazy danych i nigdy nie odpytuje przewoźnika. Synchronizacja w tle odświeża każdą przesyłkę (co 10 minut dla GO!, co godzinę dla DHL), a pole synced_at w każdym wierszu informuje, kiedy ostatnio odpytano przewoźnika.

Żądanie

Parametry zapytania

string
Tylko przesyłki powiązane z tą wizytą (UUID). 404, gdy wizyta nie istnieje, 403, gdy znajduje się poza twoim kontekstem dostępu.
string
Tylko przesyłki powiązane z tym zamówieniem domowego zestawu testowego (UUID). Zwykle zwracane są dwa wiersze — zestaw w drodze do pacjenta oraz próbka wracająca do laboratorium (jej destination to laboratorium). Takie same zasady 404 / 403 jak dla appointment_id.
string
Tylko przesyłki o tym statusie. Jedna z wartości: pending, in_transit, delivered, fault, cancelled.
integer
Maksymalna liczba zwracanych przesyłek. Domyślnie 100, maks. 500.
integer
Liczba przesyłek do pominięcia. Domyślnie 0. Sortowanie jest stabilne (created_at malejąco, potem numer referencyjny), więc strony nie nakładają się na siebie.

Odpowiedź

W razie powodzenia API zwraca 200 OK z tablicą obiektów przesyłek.
string
wymagane
Identyfikator referencyjny przesyłki.
string
wymagane
Status cyklu życia przesyłki. Jedna z wartości: pending, in_transit, delivered, fault lub cancelled.
string
wymagane
Dostawca logistyczny. Jedna z wartości: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups lub dhl_express. Paczka z zestawem domowym ma wartość dhl_parcel albo dhl_warenpost, gdy jest wysyłana za granicę jako Warenpost International.
string
Zewnętrzny numer śledzenia od dostawcy logistycznego. Może mieć wartość null.
string
Dowolny opis zawartości paczki podany przy tworzeniu (np. "Medizinisch freigestellte Probe", "Home test kit"). Ma charakter wyłącznie informacyjny — to, czy paczka zmierza do laboratorium, odczytasz z destination, a jej odpowiednik z paired_with. Może mieć wartość null.
string
wymagane
Kto wydrukował etykietę: aniva lub external. Tylko przesyłki aniva obsługują Zaktualizuj i Anuluj; paczka external jest śledzona, ale dla obu zwraca 501.
string
Numer referencyjny drugiej paczki w przesyłce dwupaczkowej — tej, która zawierała etykietę zwrotną, i tej, która wraca z tą etykietą. Ustawione dla obu. null dla paczki w jedną stronę.
object
Adres odbioru. Może mieć wartość null.
object
Adres dostawy. Taka sama struktura jak origin. Może mieć wartość null.
object
Zaplanowane okno odbioru. Może mieć wartość null.
string
Opcjonalne notatki. Może mieć wartość null.
object[]
wymagane
Chronologiczne zdarzenia cyklu życia przesyłki od dostawcy logistycznego (od najstarszego). Pusta tablica, jeśli dostawca nie zgłosił jeszcze żadnych zdarzeń. Używaj tego pola do widoku zdarzeń, audytu i szczegółowych sygnałów przewoźnika; kanoniczny bieżący stan odczytuj z status.
ShipmentAppointmentLink[]
wymagane
Wizyty powiązane z tą przesyłką, od najstarszego powiązania. Każdy wpis ma postać { id, added_at }; każdy id sprawdź w Pobierz wizytę, aby uzyskać pełne dane wizyty. Pusta tablica, gdy żadne wizyty nie są powiązane. Na liście są tylko wizyty w twoim kontekście dostępu.
ShipmentHomeKitOrderLink[]
wymagane
Zamówienia domowych zestawów testowych powiązane z tą przesyłką, od najstarszego powiązania, w tej samej postaci { id, added_at }. Każdy id sprawdź w Pobierz zamówienie domowego zestawu testowego. Pusta tablica dla paczek z gabinetów. Na liście są tylko zamówienia w twoim kontekście dostępu. Zobacz Dostęp.
string
Czas ostatniej synchronizacji przesyłki z przewoźnikiem jako znacznik czasu UTC. Odczyty nigdy nie odpytują przewoźnika — dane odświeża synchronizacja w tle — więc to pokazuje, jak stara jest odpowiedź. null do pierwszej synchronizacji.
string
wymagane
Znacznik czasu utworzenia (ISO 8601).
string
Znacznik czasu ostatniej aktualizacji (ISO 8601). Może mieć wartość null.

Powtarzane wywołania

Aniva przechowuje odpowiedź tego punktu końcowego przez 5 minut dla każdego klucza API. Ponowne wywołanie w tym czasie zwraca zapisaną odpowiedź. Nagłówki Cache-Status i Age pokazują, że odpowiedź jest zapisana i jaki jest jej wiek. Aby od razu dowiedzieć się o zmianie, zasubskrybuj zdarzenia webhooka shipment.created i shipment.updated. Zobacz Powtarzane odczyty.

Odpowiedzi z błędami