Ana içeriğe geç

Teslimat Detayları Listeleme - listShippingDetails()

Teslimat Detayları Listeleme​

listShippingDetails() metodu; Horoz Lojistik Yurtiçi Dağıtım Kargo Takip Entegrasyonu kapsamında Horoz Lojistik sistemine istemci tarafından Horoz Lojistik Yurtiçi Dağıtım Entegrasyonu üzerinden gönderilmiş teslimat verisinin Horoz Lojistik dağıtım operasyonu yaşam döngüsü içerisindeki kargo durumlarının teslimat bazında takip edilmesine olanak sağlayan metottur. listShippingDetails() metodu ile ilgili önemli bilgiler ve Horoz sisteminden kargo takip verilerinin müşteri siparişi bazında sorgulanması işlemi sırasında dikkat edilmesi gerekenler liste halinde aşağıda istemcilerin bilgisine sunulmuştur.

  • listShippingDetails() metodu istemci tarafından webservis URL’sine parametre olarak teslimat numarası geçilerek GET yöntem ile JSON formatta veri alan, bir RESFtul web servis metodudur.

  • listShippingDetails() metodu ile Horoz Lojistik sisteminden sipariş bazında kargo takibi işlemi yaparken, siparişe ait teslimat numarası bilgisi metoda parametre olarak geçilmelidir. Buna ek olarak; istemciye ait processKey bilgisi metodun header kısmına parametre tipinde geçilmelidir.

  • listShippingDetails() metodu, shippingDeliveryState, listOfShipments ve listOfMovements olmak üzere 3 farklı yapı altında kargo takip verilerini teslimat bazında istemciye döner.

  • shippingDeliveryState yapısı içerdiği alanlar ile; ilgili teslimata ait sipariş numarası, kargo takip numarası, siparişin bünyesindeki son teslimat denemesine ait ATF numarası bilgisini, gönderen bilgilerini, alıcı bilgilerini, teslimatın bünyesindeki fiziksel taşınabilir toplam adet bilgisini ve teslim durumu bilgilerini istemciye döner.

  • listOfShipments yapısı içerdiği alanlar ile; ilgili siparişin bünyesindeki son teslimat denemesine ait ATF’ye ait ürün kodu, ürün adı, adet, ağırlık ve desi bilgilerini istemciye döner.

  • listOfMovements yapısı içerdiği alanlar ile; ilgili siparişin Horoz Lojistik Yurtiçi Dağıtım Operasyonel Yaşam Döngüsü içerisindeki karo takip durumlarını bir tarihçe modelinde, tarih sırası gözeterek sipariş numarası, ATF numarası, teslimat tipi, gönderen bilgileri, alıcı bilgileri, adet, desi, kargo takip durumu, kargo takip durumu tarihi, teslim durumu ve tutar bilgilerini içererek istemciye döner.

  • listShippingDetails() metodu içerisinde istemciye dönülen cargoTrackingNumber bilgisi https://www.horoz.com.tr üzerindeki gönderi takip ekranı ve/veya https://app3.horoz.com.tr kargo URL’si ile kullanılarak satıcı web portalında kargo takibi sağlanabilecek benzersiz bir numaradır.

  • listShippingDetails() metodunda bulunan movements arrayList altında istemciye dönülen status bilgisi, ilgili teslimat için güncel kargo takip durumunu istemciye döner. status alanıda istemciye dönen varsayılan (firma bazında özelleştirilmemiş) kargo takip durumları ve açıklamaları aşağıdaki tabloda paylaşılmıştır.

STATUSAÇIKLAMA
BEKLİYORTeslimat için mal kabul yapılarak barkod etiketi oluşturulma durumunu ifade eder. (Kayıt iptal edilemez)
GİRİŞSevkiyat başlamış ve bir aktarma merkezine giriş yapılmış. (Kayıt iptal edilemez)
ÇIKIŞSevkiyat başlamış ve bir aktarma merkezinden çıkış yapılmış. (Kayıt iptal edilemez)
TESLİM SORUNTeslimat için dağıtıma çıkmış ve teslim edilememiş ve bir sorun girilmiş. (Kayıt iptal edilemez)
TESLİMTeslimata çıkmış ve teslim edilmiş. (Kayıt iptal edilemez)

  • listShippingDetails() metodunda bulunan movements arrayList altında istemciye dönülen deliveryProblem bilgisi, ilgili teslimatın son alıcıya teslim edilememe durumunda ilgili ATF’ye girilen olası teslim sorununun bilgilerini istemciye döner. Olası teslim sorunları bilgileri ve açıklamaları aşağıdaki tabloda paylaşılmıştır.

  • listShippindDetails() metodu Horoz Lojistik’in bütün yurtiçi dağıtım entegrasyon paydaşlarının kullanımına açık olan kargo takip metodudur. İlgili metoda gelen istek trafiğinin yönetilerek, metodun optimum kullanımının sağlanabilmesi adına, metodun istemciler tarafından kullanımı saatlik bir frekans kontrolü ile sınırlandırılarak kontrol altına alınmıştır. İlgili metodun istemciler tarafından 1 saatte bir kere 5 dakikalık aralıkta çağırılmasına izin verilmektedir. Bu aralıklar dışındaki çağırımlarda istemcilere Yeni sorgulama DD.MM.YYYY HH24:MI:SS tarihinden sonra yapılabilir. hatası döner.

GET listShippingDetails()​

ENDPOINT

http://b2btest.horoz.com.tr:7801/listsrestservice_test/v1/listShippingDetails

Parametre Açıklamaları & Kuralları​

Aşağıdaki tabloda listShippingDetails() işleminin giriş ve çıkış parametreleri ve bu parametrelerin tür ve formatları listelenmiştir.

AlanlarAçıklamaVeri TipiUzunlukAlan YeriZorunluluk
processKeyİstemci için tanımlanan processKey bilgisistring100HeaderZorunlu
requestNumberSipariş numarasıstring50Header ParametersZorunlu

Servis Cevapları​

Response KoduResponse MesajıAçıklama
STA-100Kayit islemi basariliSevkiyat iptal işleminin başarılı olduğunu ifade eder.
ERR-20002Yeni sorgulama DD.MM.YYYY HH24:MI:SS tarihinden sonra yapılabilir.Servise ait frekans kontrolü olduğundan bu yanıt dönmektedir. Belirtilen tarihte sonra sorgulama yapılabileceği ifade edilir.
ERR-20004TALEP NUMARASI BULUNAMADI - Key: X TalepNo: X Method: listShippingDetailsSorgulanmak istenilen siparişin sistemde oluşturulmadğını yada ilgili siparişin mal kabulünün henüz yapılmadığını ifade eder.