Salt la conținutul principal
GET
Obține expedierile accesibile cheii tale API, cele mai noi primele. Fiecare colet se află în această listă unică: o preluare prin curier de la un cabinet, kitul în drum spre un pacient cu kit de testare la domiciliu și proba pe drumul de întoarcere. Filtrează după un singur element părinte cu appointment_id sau home_kit_order_id. Necesită scope-ul shipments_view sau shipments_manage. Răspunsul vine din baza noastră de date și nu apelează niciodată curierul. O sincronizare în fundal actualizează fiecare expediere (la fiecare 10 minute pentru GO!, din oră în oră pentru DHL), iar synced_at din fiecare rând îți arată când a fost interogat ultima dată curierul.

Cerere

Parametri de interogare

string
Doar expedierile asociate cu această programare (UUID). 404 când programarea nu există, 403 când este în afara contextului tău de acces.
string
Doar expedierile asociate cu această comandă de kit de testare la domiciliu (UUID). În mod normal sunt returnate două rânduri — kitul în drum spre pacient și proba înapoi la laborator (destination este laboratorul). Aceleași reguli 404 / 403 ca la appointment_id.
string
Doar expedierile cu acest status. Una dintre valorile pending, in_transit, delivered, fault, cancelled.
integer
Numărul maxim de expedieri returnate. Implicit 100, maximum 500.
integer
Numărul de expedieri omise. Implicit 0. Sortarea este stabilă (created_at descrescător, apoi referință), astfel încât paginile nu se suprapun.

Răspuns

În caz de succes, API-ul returnează 200 OK cu un array de obiecte de expediere.
string
obligatoriu
Identificatorul de referință al expedierii.
string
obligatoriu
Starea expedierii în ciclul de viață. Una dintre valorile pending, in_transit, delivered, fault sau cancelled.
string
obligatoriu
Furnizorul de logistică. Una dintre valorile go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups sau dhl_express. Un colet cu kit pentru acasă folosește dhl_parcel sau dhl_warenpost când pleacă în străinătate ca Warenpost International.
string
Numărul extern de urmărire de la furnizorul de logistică. Poate fi null.
string
Descriere în text liber a conținutului coletului, așa cum a fost dată la creare (de ex., "Medizinisch freigestellte Probe", "Home test kit"). Doar informativ — dacă un colet merge către un laborator se citește din destination, iar perechea lui din paired_with. Poate fi null.
string
obligatoriu
Cine a tipărit eticheta: aniva sau external. Doar expedierile aniva acceptă Actualizare și Anulare; un colet external este urmărit, dar returnează 501 la oricare dintre cele două.
string
Referința celuilalt colet dintr-o expediere cu două colete — coletul care a conținut o etichetă de retur și coletul pe care acea etichetă îl aduce înapoi. Setat pe ambele. null pentru un colet într-un singur sens.
object
Adresa de ridicare. Poate fi null.
object
Adresa de livrare. Aceeași structură ca origin. Poate fi null.
object
Intervalul programat de ridicare. Poate fi null.
string
Note opționale. Poate fi null.
object[]
obligatoriu
Evenimentele cronologice din ciclul de viață de la furnizorul de logistică (cele mai vechi primele). Array gol dacă furnizorul nu a raportat încă niciun eveniment. Folosește acest câmp pentru UI per eveniment, audit și semnalele mai detaliate ale curierului; bazează-te pe status pentru starea curentă canonică.
ShipmentAppointmentLink[]
obligatoriu
Programările asociate cu această expediere, în ordinea asocierii (cele mai vechi primele). Fiecare intrare este { id, added_at }; corelează fiecare id cu Obține programarea pentru payload-ul complet al programării. Array gol când nu există programări asociate. Sunt listate doar programările din contextul tău de acces.
ShipmentHomeKitOrderLink[]
obligatoriu
Comenzile de kit de testare la domiciliu asociate cu această expediere, în ordinea asocierii (cele mai vechi primele), în același format { id, added_at }. Corelează fiecare id cu Obține comanda de kit de testare la domiciliu. Array gol pentru coletele de la cabinete. Sunt listate doar comenzile din contextul tău de acces. Vezi Acces.
string
Când a fost sincronizată ultima dată expedierea cu curierul său, ca moment UTC. Citirile nu apelează niciodată curierul — o sincronizare în fundal menține expedierile actualizate — așa că aceasta arată cât de vechi este răspunsul. null până la prima sincronizare.
string
obligatoriu
Data și ora creării (ISO 8601).
string
Data și ora ultimei actualizări (ISO 8601). Poate fi null.

Apeluri repetate

Aniva stochează răspunsul acestui endpoint timp de 5 minute pentru fiecare cheie API. Un apel repetat în acest interval primește răspunsul stocat. Antetele Cache-Status și Age arată că răspunsul este stocat și cât de vechi este. Pentru a afla imediat despre o modificare, abonează-te la evenimentele webhook shipment.created și shipment.updated. Vezi Citiri repetate.

Răspunsuri de eroare