Ana içeriğe atla
GET
Referans ID’sine göre tek bir gönderiyi getir. Yanıt veritabanımızdan gelir ve kargo şirketini asla çağırmaz. Bir arka plan senkronizasyonu her gönderiyi yeniler (GO! için 10 dakikada bir, DHL için saatte bir) ve synced_at sana kargo şirketine en son ne zaman sorulduğunu gösterir. shipments_view veya shipments_manage kapsamını gerektirir.

İstek

Yol parametreleri

string
gerekli
Gönderi referans ID’si (ör. P2611194821).

Yanıt

Başarılı olduğunda API, gönderi nesnesi ile birlikte 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 60 dakika boyunca saklar. Gönderide bir değişiklik olmadığı sürece bu süre içindeki tekrarlanan çağrılar saklanan yanıtı alır. Bir değişiklikten sonra yeni bir yanıt alırsın. Cache-Status ve Age başlıkları yanıtın saklandığını ve ne kadar eski olduğunu gösterir. Saklanan bir yanıtta synced_at ve updated_at, yeni bir yanıttakinden daha eski olabilir. 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ı