Ugrás a fő tartalomhoz
GET
Kérd le az API-kulcsod számára elérhető küldeményeket, a legújabbtól kezdve. Minden csomag ebben az egy listában szerepel: a rendelőből történő futárfelvétel, az otthoni tesztkészletet rendelő pácienshez tartó készlet és a visszafelé tartó minta. Szűrj egyetlen szülőelemre az appointment_id vagy a home_kit_order_id paraméterrel. A shipments_view vagy a shipments_manage scope szükséges hozzá. A válasz az adatbázisunkból érkezik, és soha nem hívja a futárszolgálatot. Egy háttérben futó szinkronizálás frissít minden küldeményt (a GO! esetében 10 percenként, a DHL esetében óránként), az egyes sorokban található synced_at pedig megmutatja, mikor kérdeztük le utoljára a futárszolgálatot.

Kérés

Lekérdezési paraméterek

string
Csak az ehhez az időponthoz kapcsolt küldemények (UUID). 404, ha az időpont nem létezik, 403, ha a hozzáférési körödön kívül esik.
string
Csak az ehhez az otthoni tesztkészlet-rendeléshez kapcsolt küldemények (UUID). Általában két sor érkezik vissza – a pácienshez tartó készlet és a laboratóriumba visszaküldött minta (a destination értéke a laboratórium). Ugyanazok a 404 / 403 szabályok érvényesek, mint az appointment_id esetében.
string
Csak az ebben az állapotban lévő küldemények. Az alábbiak egyike: pending, in_transit, delivered, fault, cancelled.
integer
A visszaadható küldemények maximális száma. Alapértelmezés szerint 100, legfeljebb 500.
integer
Az átugorandó küldemények száma. Alapértelmezés szerint 0. A rendezés stabil (created_at szerint csökkenő, majd hivatkozás szerint), így az oldalak nem fedik át egymást.

Válasz

Siker esetén az API 200 OK választ ad vissza a küldemény-objektumok tömbjével.
string
kötelező
A küldemény referenciaazonosítója.
string
kötelező
A küldemény életciklus-állapota. A következő értékek egyike: pending, in_transit, delivered, fault vagy cancelled.
string
kötelező
Logisztikai szolgáltató. Lehetséges értékei: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups vagy dhl_express. Az otthoni tesztkészlet-csomag dhl_parcel, illetve dhl_warenpost, ha külföldre megy Warenpost International küldeményként.
string
A logisztikai szolgáltatótól kapott külső csomagkövetési szám. Lehet null.
string
Szabad szöveges leírás a csomag tartalmáról, a létrehozáskor megadottak szerint (pl. "Medizinisch freigestellte Probe", "Home test kit"). Csak tájékoztató jellegű — az, hogy a csomag laboratóriumba tart-e, a destination mezőből, a párja pedig a paired_with mezőből olvasható ki. Lehet null.
string
kötelező
Ki nyomtatta ki a címkét: aniva vagy external. Csak az aniva küldeményeknél használható a Módosítás és a Lemondás; az external csomagot követjük, de mindkettőre 501 választ ad.
string
Egy kétcsomagos szállítmány másik csomagjának hivatkozása – az a csomag, amely a visszaküldési címkét vitte, és az a csomag, amelyet ez a címke hoz vissza. Mindkettőnél be van állítva. Egyirányú csomagnál null.
object
Felvételi cím. Lehet null.
object
Kézbesítési cím. Ugyanolyan szerkezetű, mint az origin. Lehet null.
object
Ütemezett felvételi időablak. Lehet null.
string
Opcionális megjegyzések. Lehet null.
object[]
kötelező
Időrendi életciklus-események a logisztikai szolgáltatótól (a legrégebbitől kezdve). Üres tömb, ha a szolgáltató még nem jelentett eseményt. Használd eseményenkénti megjelenítéshez, audithoz és a részletesebb futárszolgálati jelzésekhez; az irányadó aktuális állapothoz a status mezőre támaszkodj.
ShipmentAppointmentLink[]
kötelező
Az ehhez a küldeményhez kapcsolt időpontok, a legrégebben kapcsolttól kezdve. Minden elem { id, added_at } formátumú; a teljes időpontadatokhoz kérd le az egyes id értékeket az Időpont lekérése végponton. Üres tömb, ha nincs kapcsolt időpont. Csak a hozzáférési körödben lévő időpontok szerepelnek a listában.
ShipmentHomeKitOrderLink[]
kötelező
Az ehhez a küldeményhez kapcsolt otthoni tesztkészlet-rendelések, a legrégebben kapcsolttól kezdve, ugyancsak { id, added_at } formátumban. Kérd le az egyes id értékeket az Otthoni tesztkészlet-rendelés lekérése végponton. Rendelői csomagoknál üres tömb. Csak a hozzáférési körödben lévő rendelések szerepelnek a listában. Lásd: Hozzáférés.
string
A küldemény és a futárszolgálat utolsó egyeztetésének UTC időpontja. A lekérdezések soha nem hívják a futárszolgálatot – a háttérben futó szinkronizálás tartja frissen a küldeményeket –, így ez mutatja a válasz korát. Az első szinkronizálásig null.
string
kötelező
Létrehozási időbélyeg (ISO 8601).
string
Utolsó frissítés időbélyege (ISO 8601). Lehet null.

Ismételt hívások

Az Aniva minden API-kulcshoz 5 percig tárolja ennek a végpontnak a válaszát. Ezen az időn belül egy ismételt hívás a tárolt választ kapja vissza. A Cache-Status és az Age fejléc mutatja, hogy a válasz tárolt, és mennyi idős. Ha azonnal értesülni szeretnél egy változásról, iratkozz fel a shipment.created és a shipment.updated webhook-eseményekre. Lásd: Ismételt lekérdezések.

Hibaválaszok