Sipariş İptal - cancelShipping()

Sipariş İptal

Horoz Lojistik Yurtiçi Dağıtım Entegrasyonu üzerinde bulunan cancelShipping() metodu, daha önce createShipping() metodu ile oluşturulmuş bir sevk emrini, eğer ilgili sevk emri iptal şartlarına uyuyor ise iptal etmek için kullanılır.

Eğer daha önce Horoz Lojistik sistemine createShipping() metodu ile gönderilen sevk emri kaydı, Horoz Lojistik operasyonu tarafından onaylanıp, mal kabulü yapılarak operasyonel yaşam döngüsüne başladı ise, istemci cancelShipping() metodu ile ilgili sevk emrinin iptalini denediğinde, entegrasyon üzerinden hata alacaktır.

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

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

• cancelShipping() metodu ile Horoz sistemine daha önce gönderilmiş bir sevk emri için iptal işlemi yaparken, 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. cancelShipping() metodu ile yapılan gönderim UTF-8 olarak encode edilerek Horoz Lojistik Yurtiçi Dağıtım Entegrasyonu Web servisine iletilmelidir.

• cancelShipping() metodu ile Horoz Lojistik sistemine iptal isteği gönderilecek siparişin, daha evvel createShipping() metodu ile Horoz Lojistik Yurtiçi Dağıtım Entegrasyonu Webservisi aracılığı ile Horoz Lojistik sisteminde oluşturulmuş olması gerekir. Horoz Lojistik sisteminde mevcut olmayan sipariş iptal edilemez.

• cancelShipping() metodu ile Horoz Lojistik sistemine iptal isteği gönderilecek siparişin, Horoz Lojistik tarafında onaylanmamış, mal kabul kaydının yapılmamış olması gerekir. Aksi halde cancelShipping() metodu ile yapılan çağrı için istemciye hata dönülecektir.

• cancelShipping() metodu iptal işlemini sipariş bazlı yapmaktadır. Daha önce createShipping() metodu ile oluşturulmuş bir siparişin içerisindeki herhangi bir ürünün, herhangi bir parçası için parça bazlı iptal işlemi yapılamaz.

---

POST cancelShipping()

ENDPOINT

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

Parametre Açıklamaları & Kuralları

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

Alanlar

Alanlar	Açıklama	Veri Tipi	Uzunluk	Alan Yeri	Zorunluluk
processKey	İstemci için tanımlanan processKey bilgisi	string	100	Header	Zorunlu
requestNumber	Sipariş numarası	string	50	inBody Request	Zorunlu

Örnek İstek

{
  "requestNumber": "TEST-17052023-1"
}  

Örnek Cevap

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

---

Servis Cevapları

Response Kodu	Response Mesajı	Açıklama
STA-100	Kayit islemi basarili	Sevkiyat iptal işleminin başarılı olduğunu ifade eder.
ERR-20001	HATALI IŞLEM ANAHTARI	Geçilen processKey bilgisinin yanlış olduğunu belirtir.
ERR-20004	TALEP NUMARASI BULUNAMADI - Key: XXX TalepNo: XXX	İstekte geçilen requestNumber ile daha önce bir sevkiyat oluşturulmadığını ifade eder.
ERR-20010	TALEP ONAYLANDIĞINDAN İPTAL EDİLEMEZ	İlgili sevkiyat lojistik sürece girdiğinden dolayı iptal edilemeyeceğini ifade eder.
ERR-20036	requestNumber BİLGİSİ BOŞ GEÇİLEMEZ.	requestNumber bilgisinin eksik girildiğini ifade eder.