Pāriet uz galveno saturu
GET
Iegūsti tavai API atslēgai pieejamos sūtījumus, sākot ar jaunāko. Šajā vienā sarakstā ir katra paka: kurjera paņemšana no prakses, komplekts ceļā pie mājas testa komplekta pacienta un paraugs ceļā atpakaļ. Filtrē pēc viena vecākobjekta ar appointment_id vai home_kit_order_id. Nepieciešams shipments_view vai shipments_manage tvērums. Atbilde nāk no mūsu datubāzes un nekad nesazinās ar pārvadātāju. Fona sinhronizācija atsvaidzina katru sūtījumu (ik pēc 10 minūtēm GO!, reizi stundā DHL), un synced_at katrā rindā parāda, kad pārvadātājam pēdējo reizi tika vaicāts.

Pieprasījums

Vaicājuma parametri

string
Tikai ar šo pierakstu saistītie sūtījumi (UUID). 404, ja pieraksts neeksistē, 403, ja tas ir ārpus tava piekļuves konteksta.
string
Tikai ar šo mājas testa komplekta pasūtījumu saistītie sūtījumi (UUID). Parasti tiek atgrieztas divas rindas — komplekts ceļā pie pacienta un paraugs atpakaļ uz laboratoriju (tā destination ir laboratorija). Tādi paši 404 / 403 noteikumi kā appointment_id.
string
Tikai sūtījumi šajā statusā. Viena no vērtībām: pending, in_transit, delivered, fault, cancelled.
integer
Maksimālais atgriežamo sūtījumu skaits. Noklusējums 100, maksimums 500.
integer
Izlaisto sūtījumu skaits. Noklusējums 0. Kārtošana ir stabila (created_at dilstošā secībā, tad atsauce), tāpēc lapas nepārklājas.

Atbilde

Veiksmes gadījumā API atgriež 200 OK ar sūtījumu objektu masīvu.
string
obligāts
Sūtījuma atsauces identifikators.
string
obligāts
Sūtījuma dzīves cikla statuss. Viena no šīm vērtībām: pending, in_transit, delivered, fault vai cancelled.
string
obligāts
Loģistikas pakalpojumu sniedzējs. Viena no vērtībām: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups vai dhl_express. Mājas komplekta paka ir dhl_parcel vai dhl_warenpost, ja tā dodas uz ārzemēm kā Warenpost International.
string
Loģistikas pakalpojumu sniedzēja ārējais izsekošanas numurs. Var būt null.
string
Brīva teksta apraksts par pakas saturu, kā norādīts izveides brīdī (piem., "Medizinisch freigestellte Probe", "Home test kit"). Tikai informatīvs — to, vai paka dodas uz laboratoriju, nolasa no destination, bet tās pāri no paired_with. Var būt null.
string
obligāts
Kas izdrukāja uzlīmi: aniva vai external. Tikai aniva sūtījumi atbalsta Atjaunināt un Atcelt; external paka tiek izsekota, bet abos gadījumos atgriež 501.
string
Otras pakas atsauce divu paku sūtījumā — paka, kurā bija atpakaļsūtīšanas uzlīme, un paka, kas ar šo uzlīmi tiek nosūtīta atpakaļ. Norādīta abām. null vienvirziena pakai.
object
Paņemšanas adrese. Var būt null.
object
Piegādes adrese. Tāda pati struktūra kā origin. Var būt null.
object
Ieplānotais paņemšanas laika logs. Var būt null.
string
Neobligātas piezīmes. Var būt null.
object[]
obligāts
Hronoloģiski dzīves cikla notikumi no loģistikas pakalpojumu sniedzēja (vecākie vispirms). Tukšs masīvs, ja pakalpojumu sniedzējs vēl nav ziņojis par notikumiem. Izmanto to saskarnei pa notikumiem, auditam un detalizētākiem pārvadātāja signāliem; noteicošajam pašreizējam stāvoklim paļaujies uz status.
ShipmentAppointmentLink[]
obligāts
Ar šo sūtījumu saistītie pieraksti, sākot ar vecāko saiti. Katrs ieraksts ir { id, added_at }; pārbaudi katru id ar Iegūt pierakstu, lai iegūtu pilnus pieraksta datus. Tukšs masīvs, ja nav saistītu pierakstu. Ir uzskaitīti tikai tie pieraksti, kas ir tavā piekļuves kontekstā.
ShipmentHomeKitOrderLink[]
obligāts
Ar šo sūtījumu saistītie mājas testa komplektu pasūtījumi tādā pašā { id, added_at } formā, sākot ar vecāko saiti. Pārbaudi katru id ar Iegūt mājas testa komplekta pasūtījumu. Tukšs masīvs prakses pakām. Ir uzskaitīti tikai tie pasūtījumi, kas ir tavā piekļuves kontekstā. Skati Piekļuve.
string
Laiks UTC formātā, kad sūtījums pēdējo reizi tika salāgots ar pārvadātāju. Lasīšanas pieprasījumi nekad nesazinās ar pārvadātāju — sūtījumus atjaunina fona sinhronizācija —, tāpēc šis rāda, cik veca ir atbilde. null līdz pirmajai sinhronizācijai.
string
obligāts
Izveides laikspiedols (ISO 8601).
string
Pēdējās atjaunināšanas laikspiedols (ISO 8601). Var būt null.

Atkārtoti izsaukumi

Aniva saglabā šī galapunkta atbildi 5 minūtes katrai API atslēgai. Atkārtots izsaukums šajā laikā saņem saglabāto atbildi. Galvenes Cache-Status un Age rāda, ka atbilde ir saglabāta un cik veca tā ir. Lai par izmaiņām uzzinātu uzreiz, abonē webhook notikumus shipment.created un shipment.updated. Skati Atkārtota lasīšana.

Kļūdu atbildes