Statü sebeplerini listele

GET /Lookup/OrderStatusReasonByTenant/GetStatusReasonByType — OMS API · Tanımlar

İptal ve iade isteklerinde gönderilecek reasonId değerlerini listeler. Dönen kayıtların id alanı reasonId olarak kullanılır.

Ne zaman çağrılır: Entegrasyon kurulurken ya da sebep listesini önbelleğinizde yenilemek için; her iptal/iade isteğinden önce çağırmaya gerek yoktur.

Yanıt bir dizidir (zarf yoktur); sebep adına göre sıralıdır.

Parametreler

  • statusType (query, string, zorunlu): Sebebin ait olduğu statü: iptal için Cancelled, iade için Returned (bkz. OrderPackageStatus).
  • statusReasonSource (query, string, zorunlu): Sebebi kimin seçtiği. Entegrasyonlarda genellikle Customer.
  • culture (query, string): Sebep adlarının dili (ör. tr, en). Boşsa varsayılan ad döner.

Yanıtlar

  • 200: Sebep listesi.
  • 400: Gövde doğrulanamadı (zorunlu alan eksik, tip uyumsuz ya da JSON bozuk). Yanıt ASP.NET Core ValidationProblemDetails biçimindedir; errors alanı hangi alanın hatalı olduğunu gösterir.
  • 401: Authorization başlığı yok, token geçersiz ya da süresi dolmuş. Gövde boş döner; /Auth/login ile yeni token alın.
  • 500: Beklenmeyen sunucu hatası. Bu yanıt PascalCase alan adlarıyla döner (diğer yanıtlardan farklı olarak) ve null alanlar da yazılır.

200 yanıt alanları

  • id (integer<int64>): Sebep kimliği. İptal/iade isteklerinde reasonId olarak bu değer gönderilir.
  • createdAt (string<date-time>): Kayıt zamanı.
  • reasonName (string): Sebep adı (culture verildiyse o dilde).
  • reasonSourceId (integer<int32>): Sebebin kaynağı: 1 = Customer, 2 = Vendor, 3 = Operator.
  • orderStatusReasonId (integer<int64>): Genel sebep tanımının kimliği.