İade paketi statüsü değişti

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

İade paketinin statüsü değiştiğinde (ör. kargoya verildi, depoya ulaştı) gönderilir. packageId iadesi yapılan gönderi paketini, returnId iade paketini gösterir.

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[]): İade paketindeki satırlar.
  • 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.packageItemReturnRejectReasonId (integer<int64>): İade reddedildiyse ret sebebi kimliği.
  • items.packageItemStatusReturnReasonId (integer<int64>): İade sebebi kimliği.
  • items.packageItemReturnRejectReasonDesc (string): Ret açıklaması.
  • items.packageItemReturnRejectReasonName (string): Ret sebebi adı.
  • items.packageItemStatusReturnReasonDesc (string): İade açıklaması.
  • items.packageItemStatusReturnReasonName (string): İade sebebi adı.
• orderId (string): Siparişin sizin gönderdiğiniz orderId değeri.
• cargoKey (string): Kargo anahtarı.
• hookName (string): Olay adı. Abonelikte takma ad tanımlıysa o ad gelir.
• returnId (string): İade paketinin kimliği.
• 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>): Son statü değişikliğinin zamanı.
• 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.