Barkod İptal - cancelBarcode()

Barkod İptal Etme İşlemi

Horoz Lojistik Yurtiçi Dağıtım Entegrasyonu üzerinde bulunan cancelBarcode() metodu, daha önce createShipping() metodu ile oluşturulmuş ve createBarcode() ile onaylanıp, mal kabul kaydı oluşturularak, barkod etiketi alınmış bir sevk emrine ait mal kabul kaydını (ATF kaydını/barkod etiketi kaydını) eğer iptal şartlarına uyuyor ise iptal etmek için kullanılır.
Eğer daha önce Horoz Lojistik sisteminde createBarcode() metodu ile onaylanıp, mal kabul kaydı (ATF kaydı) oluşturulmuş ve operasyonel olarak okutma hareketi görmüş bir sevk emri kaydı var ise, istemci cancelBarcode() metodu ile ilgili sevk emrine ait barkod etiketinin iptalini denediğinde, entegrasyon üzerinden hata alacaktır.

cancelBarcode() metodu ile ilgili önemli bilgiler ve Horoz sisteminde sevk emrinin barkodu iptal edilirken dikkat edilmesi gerekenler liste halinde aşağıda istemcilerin bilgisine sunulmuştur.

• cancelBarcode() metodu POST yöntem ile JSON formatta veri alan, bir RESTful web servis metodudur.

• cancelBarcode() metodu ile Horoz sistemine daha önce gönderilmiş ve barkod etiketi oluşturulmuş bir sevk emri barkodu için iptal işlemi yaparken, atfId (createBarcode metodunun yanıtında dönen barcode alanındaki bilginin ilk 11 hanesi) ve sipariş numarası metodun body kısmına JSON veri tipinde geçilmelidir. İstemciye ait processKey bilgisi metodun header kısmına parametre tipinde geçilmelidir. cancelBarcode() metodu ile yapılan gönderim UTF-8 olarak encode edilerek Horoz Lojistik Yurtiçi Dağıtım Entegrasyonu Web servisine iletilmelidir.

• cancelBarcode() metodu ile Horoz Lojistik sistemine barkod etiketi iptal isteği gönderilecek siparişin, daha evvel createShipping() + createBarcode() metotları ile barkod etiketi oluşturulmuş bir teslimatın mevcut olması gerekir. Horoz Lojistik sisteminde barkod etiketi alınmamış bir teslimat için mal kabul kaydı (ATF kaydı) barkod etiketi iptal edilemez.

• cancelBarcode() metodu ile Horoz Lojistik sistemine barkod etiketi iptal istediği gönderilecek siparişin, Horoz Lojistik tarafında onaylanmış, mal kabul kaydının yapılmış fakat operasyonel hareket görmemiş olması gerekir. Aksi halde cancelBarcode() metodu ile yapılan çağrı için istemciye hata dönülecektir.

• cancelBarcode() metodu barkod etiketi iptal işlemini sipariş bazlı yapmaktadır. Daha önce createBarcode() metodu ile mal kabul kaydı (ATF kaydı) oluşturulup, barkod etiketi alınmış bir siparişin içerisindeki herhangi bir ürünün, herhangi bir parçası için parça bazlı barkod etiketi iptal işlemi yapılamaz.

• cancelBarcode() metodu ile Horoz Lojistik sistemine barkod etiketi iptal isteği gönderilip, mal kabul kaydı (ATF kaydı / barkod etiketi) edildiğinde, ilgili siparişin bünyesindeki ürünlerin üzerinden iptal edilen barkod etiketleri sökülmelidir. Eğer ilgili sipariş için tekrardan createBarcode() metodu ile mal kabul kaydı (ATF kaydı / barkod etiketi) oluşturuldu ise, yeni barkod etiketi ilgili siparişin bünyesindeki ürünlerin üzerine yapıştırılmalıdır.

• Daha önce createShipping ile Horoz Lojistik sistemine sevk emri gönderilip, createBarcode() metodu ile mal kabul kaydı (ATF kaydı / barkod etiketi) oluşturulan siparişin istemci tarafında Horoz Lojistik’e verilmesinden vazgeçilir ise barkod etiketinin ve siparişin tamamen iptal edilmesi gerekir. Barkod etiketinin iptali için cancelBarcode() metotunun çağırılıp, akabinde siparişin tamamen iptal edilmesi için cancelShipping() metodunun çağırılması gerekir.

---

POST cancelBarcode()

ENDPOINT

http://b2btest.horoz.com.tr:7801/horozshipping_test/v1/cancelBarcode

Parametre Açıklamaları & Kuralları

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

Alanlar

Parametre	Açıklama	Veri Tipi	Uzunluk	Alan Yeri	Zorunluluk
processKey	İstemci için tanımlanan processKey bilgisi	string	100	Header	Zorunlu
requestNumber	İstemci tarafından createShipping ile oluşturulan siparişin requestNumber bilgisi	string	50	inBody Request	Zorunlu
atfId	ATF kaydı / Barkod kaydı ID bilgisi	string	11	inBody Request	Zorunlu

Örnek İstek

  {
    "atfId": "15854236521",
    "requestNumber": "TEST123456"
  }s

Örnek Cevap

  {
        "response": {
            "responseCode": "STA-100",
            "responseMessage": "Kayit islemi basarili"
        }
    }

---

Servis Cevapları

Response Kodu	Response Mesajı	Açıklama
STA-100	Kayit islemi basarili	Barkod iptal etme işleminin başarılı olduğunu ifade eder.
ERR-20001	HATALI IŞLEM ANAHTARI	Geçilen processKey bilgisinin yanlış olduğunu belirtir.
ERR-20020	SEVK KAYDI BULUNAMADI YADA GEÇERSİZ KAYIT	Barkodu iptal edilmeye çalışılan siparişin sistemde var olmadığını yada geçersiz yapıldığını belirtir.
ERR-20021	GECERSIZ SEVK KAYDI.	Barkodu iptal edilmeye çalışılan siparişin geçersiz yapıldığını belirtir.
ERR-20022	Kaydın ATF si oluşturulamadı.	Barkodu iptal edilmeye çalışılan sipariş için henüz bir ATF oluşturulmadığını ve barkodunun olmadığını belirtir.
ERR-20023	Kayıt onaylanmadı.	Barkodu iptal edilmeye çalışılan sipariş henüz Müşteri Temsilcisi tarafından onaylanmadığını belirtir.
ERR-20052	HAREKET GÖRMÜŞ ATF GÜNCELLENEMEZ	Barkodu iptal edilmeye çalışılan siparişin lojistik sürece girdiğini ve haerket gördüğünden dolayı iptal edilemeyeceğini ifade eder.