Paket statüsü değişti

Webhook: order-package-status-changed — OMS API · Webhook'lar

Gönderi paketinin statüsü değiştiğinde (ör. Picked, Invoiced, Shipped, Delivered, Cancelled) gönderilir. Kargo ve fatura bilgisi doluysa gövdeye eklenir; items paketteki satırların güncel statülerini taşır.

Teslim: OMS, abonelikte tanımlı adresinize POST atar. 2xx dışındaki yanıtlar başarısız sayılır ve abonelikteki deneme sayısına kadar yeniden denenir; aynı olay birden fazla kez gelebilir, işlemeyi tekrar güvenli (idempotent) yapın.

Alan adları: Gövde, kimlik doğrulamasız ya da Basic Auth aboneliklerde PascalCase (HookName, PackageId) ve null alanlar atlanarak; Bearer/API anahtarlı aboneliklerde camelCase olarak serileştirilir. Gövdeyi büyük/küçük harf duyarsız okuyun.

İstek gövdesi

• items (object[]): Paketteki satırlar ve statüleri.
  • items.orderItemLineId (string): Satırın sizin gönderdiğiniz sourceOrderItemLineId değeri.
  • items.packageItemStatusId (integer<int32>): Satırın statü kimliği.
  • items.packageItemStatusName (string): Satırın statü adı.
  • items.packageItemCancelReasonId (integer<int64>): Satır iptal edildiyse iptal sebebi kimliği.
  • items.packageItemCancelReasonDesc (string): İptal açıklaması.
  • items.packageItemCancelReasonName (string): İptal sebebi adı.
  • items.packageItemCancelRejectReasonId (integer<int64>): İptal talebi reddedildiyse ret sebebi kimliği.
  • items.packageItemCancelRejectReasonDesc (string): İptal talebi ret açıklaması.
  • items.packageItemCancelRejectReasonName (string): İptal talebi ret sebebi adı.
• orderId (string): Siparişin sizin gönderdiğiniz orderId değeri.
• cargoKey (string): Kargo anahtarı.
• hookName (string): Olay adı.
• packageId (string): Paketin sourcePackageId değeri.
• invoiceLink (string): Fatura bağlantısı.
• packageType (string): Paket tipi.
• trackingCode (string): Kargo takip numarası.
• estimatedDate (string<date-time>): Paketin termin tarihi.
• invoiceNumber (string): Fatura numarası.
• packageStatusId (integer<int32>): Paketin statü kimliği.
• parentPackageId (string): Paket bölme/kısmi iptalden oluştuysa kaynak paketin kimliği; değilse paketin kendi kimliği.
• cargoCompanyName (string): Kargo firması adı.
• cargoTrackingUrl (string): Kargo takip bağlantısı.
• packageStatusName (string): Paketin statü adı (bkz. OrderPackageStatus).
• packageStatusUser (string): Statüyü değiştiren kullanıcının adı.
• estimatedDateTimestamp (integer<int64>): estimatedDate değerinin Unix zaman damgası (milisaniye).

Yanıtlar

• 200: Bildirimi aldığınızı 2xx ile onaylayın; gövde okunmaz.
• 500: 2xx dışındaki her yanıt başarısız sayılır ve yeniden denenir.