Gönderiyi taşıyıcıda iptal et

POST /openapi/Shipment/CancelShipmentOnCarrier — TMS API · Gönderi Güncelleme ve İptal

Gönderi kaydını taşıyıcı tarafında siler. Etiketi alınmış aktif gönderiler için de çalışır; iptalden sonra aynı shipmentKey ile yeniden etiket alınabilir.

• shipmentKey olarak gönderinin ShipmentKey veya takip numarası verilebilir. Çok koli / tek takip numarasıyla çalışan hesaplarda ShipmentKey konşimento numarasıyla aynıdır.
• Yanıttaki cancelShipmentInfos[].isCancelNotSupported: true ise taşıyıcı entegrasyonu iptali desteklemiyordur; gönderi iptal edilmiş sayılmaz.
• Zimmet alınmış (taşıyıcıya teslim edilmiş) gönderiyi geri çekmek için RecallShipment kullanın.

İstek gövdesi

• clientCode (string, zorunlu): Organizasyon kodu.
• accountCode (string, zorunlu): Hesap kodu.
• shipmentKey (string, zorunlu): Gönderinin ShipmentKey'i veya takip numarası.
• cancellationDescription (string): Taşıyıcıya iletilecek iptal açıklaması (isteğe bağlı).

Yanıtlar

• 200: Taşıyıcının iptal yanıtı
• 400: Gönderi bulunamadı ya da iptal edilemedi
• 401: Token yok, geçersiz ya da süresi dolmuş (gövdesiz yanıt).

200 yanıt alanları

• carrierCode (string): Taşıyıcı kodu.
• cancelShipmentInfos (object[]): Gönderi bazında iptal sonucu.
  • cancelShipmentInfos.message (string): Taşıyıcı mesajı.
  • cancelShipmentInfos.isSuccess (boolean): İptal başarılı mı.
  • cancelShipmentInfos.shipmentId (integer): TMS gönderi kimliği.
  • cancelShipmentInfos.trackingNumber (string): Takip numarası.
  • cancelShipmentInfos.isCancelNotSupported (boolean): true ise taşıyıcı entegrasyonu iptali desteklemiyor; gönderi iptal edilmiş sayılmaz.