Ana içeriğe atla
GET
API anahtarının erişebildiği gönderileri en yeniden başlayarak getir. Her paket bu tek listede yer alır: bir muayenehaneden kurye alımı, evde test kiti hastasına giden kit ve geri dönen numune. appointment_id veya home_kit_order_id ile tek bir üst kayda göre filtrele. shipments_view veya shipments_manage kapsamını gerektirir. Yanıt veritabanımızdan gelir ve hiçbir zaman taşıyıcıyı çağırmaz. Arka plan senkronizasyonu her gönderiyi yeniler (GO! için 10 dakikada bir, DHL için saatte bir) ve her satırdaki synced_at alanı taşıyıcıya en son ne zaman sorulduğunu gösterir.

İstek

Sorgu parametreleri

string
Yalnızca bu randevuya (UUID) bağlı gönderiler. Randevu mevcut değilse 404, erişim bağlamının dışındaysa 403.
string
Yalnızca bu evde test kiti siparişine (UUID) bağlı gönderiler. Normalde iki satır döner — hastaya giden kit ve laboratuvara geri dönen numune (destination alanı laboratuvardır). appointment_id ile aynı 404 / 403 kuralları geçerlidir.
string
Yalnızca bu durumdaki gönderiler. pending, in_transit, delivered, fault, cancelled değerlerinden biri.
integer
Döndürülecek maksimum gönderi sayısı. Varsayılan 100, en fazla 500.
integer
Atlanacak gönderi sayısı. Varsayılan 0. Sıralama kararlıdır (önce created_at azalan, sonra referans), bu nedenle sayfalar çakışmaz.

Yanıt

Başarılı olduğunda API, gönderi nesnelerinden oluşan bir diziyle 200 OK döndürür.
string
gerekli
Gönderi referans tanımlayıcısı.
string
gerekli
Gönderi yaşam döngüsü durumu. pending, in_transit, delivered, fault veya cancelled değerlerinden biri.
string
gerekli
Lojistik sağlayıcı. go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups veya dhl_express değerlerinden biri. Ev kiti paketi dhl_parcel veya yurt dışına Warenpost International olarak gittiğinde dhl_warenpost olur.
string
Lojistik sağlayıcıdan alınan harici takip numarası. null olabilir.
string
Paketin içinde ne olduğuna dair oluşturma sırasında verilen serbest metin açıklaması (ör. "Medizinisch freigestellte Probe", "Home test kit"). Yalnızca bilgi amaçlıdır — bir paketin bir laboratuvara gidip gitmediği destination alanından, karşılığı ise paired_with alanından okunur. null olabilir.
string
gerekli
Etiketi kimin yazdırdığı: aniva veya external. Yalnızca aniva gönderileri Güncelle ve İptal et işlemlerini kabul eder; external bir paket takip edilir ancak her iki işlemde de 501 döndürür.
string
İki paketli bir gönderideki diğer paketin referansı — iade etiketini taşıyan paket ile o etiketin geri getirdiği paket. Her ikisinde de ayarlanır. Tek yönlü bir paket için null.
object
Alım adresi. null olabilir.
object
Teslimat adresi. origin ile aynı yapıdadır. null olabilir.
object
Planlanan alım aralığı. null olabilir.
string
İsteğe bağlı notlar. null olabilir.
object[]
gerekli
Lojistik sağlayıcıdan gelen kronolojik yaşam döngüsü olayları (en eskiden başlayarak). Sağlayıcı henüz herhangi bir olay bildirmediyse boş dizi. Olay bazlı arayüz, denetim ve daha ayrıntılı taşıyıcı sinyalleri için bunu kullan; esas güncel durum için status alanına güven.
ShipmentAppointmentLink[]
gerekli
Bu gönderiye bağlı randevular, en eski bağlantıdan başlayarak. Her giriş { id, added_at } şeklindedir; tam randevu verisi için her id değerini Randevuyu getir ile karşılaştır. Bağlı randevu yoksa boş dizi. Yalnızca erişim bağlamındaki randevular listelenir.
ShipmentHomeKitOrderLink[]
gerekli
Bu gönderiye bağlı evde test kiti siparişleri, en eski bağlantıdan başlayarak, aynı { id, added_at } yapısında. Her id değerini Evde test kiti siparişini getir ile karşılaştır. Muayenehane paketleri için boş dizi. Yalnızca erişim bağlamındaki siparişler listelenir. Erişim bölümüne bak.
string
Gönderinin taşıyıcısıyla en son ne zaman senkronize edildiği, UTC zamanı olarak. Okuma işlemleri hiçbir zaman taşıyıcıyı çağırmaz — gönderileri arka plan senkronizasyonu güncel tutar — bu nedenle yanıtın ne kadar eski olduğunu bu alan gösterir. İlk senkronizasyona kadar null.
string
gerekli
Oluşturulma zaman damgası (ISO 8601).
string
Son güncelleme zaman damgası (ISO 8601). null olabilir.

Tekrarlanan çağrılar

Aniva bu uç noktanın yanıtını her API anahtarı için 5 dakika boyunca saklar. Bu süre içinde yapılan yinelenen bir çağrı saklanan yanıtı alır. Cache-Status ve Age başlıkları yanıtın saklandığını ve ne kadar eski olduğunu gösterir. Bir değişiklikten hemen haberdar olmak için shipment.created ve shipment.updated webhook olaylarına abone ol. Tekrarlanan okumalar bölümüne bak.

Hata yanıtları