Siirry pääsisältöön
GET
Hae lähetykset, joihin API-avaimellasi on pääsy, uusin ensin. Kaikki paketit ovat tässä yhdessä listassa: kuriirinouto vastaanotolta, potilaalle matkalla oleva kotitestipakkaus sekä takaisin matkalla oleva näyte. Suodata yhteen yläkohteeseen parametrilla appointment_id tai home_kit_order_id. Vaatii shipments_view- tai shipments_manage-käyttöoikeuden. Vastaus tulee tietokannastamme eikä koskaan kutsu kuljetusyhtiötä. Taustasynkronointi päivittää jokaisen lähetyksen (GO! 10 minuutin välein, DHL tunnin välein), ja kunkin rivin synced_at kertoo, milloin kuljetusyhtiöltä viimeksi kysyttiin tietoja.

Pyyntö

Kyselyparametrit

string
Vain tähän ajanvaraukseen linkitetyt lähetykset (UUID). 404, kun ajanvarausta ei ole olemassa, 403, kun se on pääsykontekstisi ulkopuolella.
string
Vain tähän kotitestipakkauksen tilaukseen linkitetyt lähetykset (UUID). Tavallisesti palautuu kaksi riviä — potilaalle matkalla oleva kotitestipakkaus ja laboratorioon palaava näyte (sen destination on laboratorio). Samat 404- ja 403-säännöt kuin parametrilla appointment_id.
string
Vain tässä tilassa olevat lähetykset. Jokin arvoista pending, in_transit, delivered, fault, cancelled.
integer
Palautettavien lähetysten enimmäismäärä. Oletus 100, enintään 500.
integer
Ohitettavien lähetysten määrä. Oletus 0. Lajittelu on vakaa (created_at laskevassa järjestyksessä, sitten viite), joten sivut eivät mene päällekkäin.

Vastaus

Onnistuessaan API palauttaa tilakoodin 200 OK ja taulukon lähetysobjekteja.
string
vaadittu
Lähetyksen viitetunniste.
string
vaadittu
Lähetyksen elinkaaritila. Yksi arvoista pending, in_transit, delivered, fault tai cancelled.
string
vaadittu
Logistiikkapalveluntarjoaja. Yksi arvoista go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups tai dhl_express. Kotitestipaketin lähetys on dhl_parcel, tai dhl_warenpost, kun se lähetetään ulkomaille Warenpost International -lähetyksenä.
string
Logistiikkapalveluntarjoajan ulkoinen seurantanumero. Voi olla null.
string
Vapaamuotoinen kuvaus paketin sisällöstä sellaisena kuin se annettiin luonnin yhteydessä (esim. "Medizinisch freigestellte Probe", "Home test kit"). Vain tiedoksi – se, onko paketti menossa laboratorioon, luetaan kentästä destination, ja sen vastinpari kentästä paired_with. Voi olla null.
string
vaadittu
Kuka tulosti osoitekortin: aniva tai external. Vain aniva-lähetykset tukevat toimintoja Päivitä ja Peruuta; external-pakettia seurataan, mutta kumpikin palauttaa koodin 501.
string
Kaksipakettisen lähetyksen toisen paketin viite — paketti, jonka mukana palautusosoitekortti lähti, ja paketti, jonka kyseinen osoitekortti tuo takaisin. Asetettu molemmille. null yksisuuntaiselle paketille.
object
Nouto-osoite. Voi olla null.
object
Toimitusosoite. Sama rakenne kuin kentässä origin. Voi olla null.
object
Ajoitettu noutoaikaikkuna. Voi olla null.
string
Valinnaiset muistiinpanot. Voi olla null.
object[]
vaadittu
Logistiikkakumppanin elinkaaritapahtumat aikajärjestyksessä (vanhin ensin). Tyhjä taulukko, jos kumppani ei ole vielä ilmoittanut tapahtumia. Käytä tätä tapahtumakohtaiseen käyttöliittymään, auditointiin ja kuljetusyhtiön tarkempiin signaaleihin; luota varsinaisen nykytilan osalta kenttään status.
ShipmentAppointmentLink[]
vaadittu
Tähän lähetykseen linkitetyt ajanvaraukset, vanhin linkitys ensin. Jokainen merkintä on { id, added_at }; hae täydet ajanvaraustiedot kullekin id-arvolle kutsulla Hae ajanvaraus. Tyhjä taulukko, kun ajanvarauksia ei ole linkitetty. Vain pääsykontekstiisi kuuluvat ajanvaraukset listataan.
ShipmentHomeKitOrderLink[]
vaadittu
Tähän lähetykseen linkitetyt kotitestipakkausten tilaukset, vanhin linkitys ensin, samassa { id, added_at } -muodossa. Hae tiedot kullekin id-arvolle kutsulla Hae kotitestipakkauksen tilaus. Tyhjä taulukko vastaanottojen paketeille. Vain pääsykontekstiisi kuuluvat tilaukset listataan. Katso Pääsyoikeudet.
string
Ajankohta, jolloin lähetyksen tiedot viimeksi täsmäytettiin kuljetusyhtiön kanssa (UTC-aika). Lukukutsut eivät koskaan kutsu kuljetusyhtiötä — taustasynkronointi pitää lähetykset ajan tasalla — joten tämä kertoo, kuinka vanha vastaus on. null ensimmäiseen synkronointiin asti.
string
vaadittu
Luontiaikaleima (ISO 8601).
string
Viimeisimmän päivityksen aikaleima (ISO 8601). Voi olla null.

Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 5 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä tehty toistuva kutsu saa tallennetun vastauksen. Otsikot Cache-Status ja Age kertovat, että vastaus on tallennettu ja kuinka vanha se on. Jos haluat tiedon muutoksesta heti, tilaa webhook-tapahtumat shipment.created ja shipment.updated. Katso Toistuvat haut.

Virhevastaukset