OMS API

CommerceLab Sipariş Yönetim Sistemi (OMS) API'si. Satış kanalınızdaki siparişleri OMS'ye aktarmak, gönderi paketlerini çekip statü/fatura/kargo bilgisini güncellemek, iptal ve iade süreçlerini yürütmek için kullanılır.

Başlarken

1. Size verilen API kullanıcısıyla Token al (POST /Auth/login) ucunu çağırın.
2. Dönen token'ı diğer tüm isteklerde Authorization: Bearer <token> başlığıyla gönderin.
3. Önce Test ortamında deneyin; Prod'a geçişte yalnızca sunucu adresi ve kullanıcı değişir.

Tipik akış

Sipariş kaydet → Sipariş paketlerini listele → Paket client statüsü yaz → Fatura bilgisi yaz / Kargo bilgisi yaz / Paket statüsü güncelle → gerekirse İptal / İade uçları. Paket ve talep durum değişiklikleri size webhook ile bildirilir.

Hata modeli

• HTTP 200 + isSuccess: false — iş kuralı hatası (kayıt bulunamadı, statü uygun değil vb.). Mesaj errorMesssage alanındadır (alan adı kaynakta üç s ile yazılmıştır). Her yanıtta isSuccess alanını kontrol edin.
• HTTP 400 — gövde/parametre doğrulama hatası (ValidationProblemDetails). Dokümanda zorunlu işaretli alanlar boş gönderilirse bu hata döner.
• HTTP 401 — token yok, geçersiz ya da süresi dolmuş.
• HTTP 500 — beklenmeyen hata; gövde PascalCase alan adlarıyla döner (IsSuccess, ErrorMesssage).

JSON alan adları istekte büyük/küçük harf duyarsızdır; yanıtlar camelCase döner.

Ortamlar

• Test: https://api.oms.awstest.hebiar.com
• Prod: https://api.oms.prod.hebiar.com

Kimlik Doğrulama

• POST /Auth/login — Token al

Siparişler

• POST /Orders/SaveOrders — Sipariş kaydet
• POST /Orders/SetOrderClientStatus — Sipariş client statüsü yaz
• POST /Orders/SetErpInfoList — ERP bilgisi yaz

Paketler

• POST /OrderPackage/CreatePackage — Paket oluştur
• GET /Orders/GetOrderPackages — Sipariş paketlerini listele
• POST /OrderPackage/SetPackageClientStatus — Paket client statüsü yaz
• POST /OrderPackage/SetOrderPackageStatusInfoList — Paket statüsü güncelle (toplu)
• POST /OrderPackage/SetOrderPackageInvoiceInfoList — Fatura bilgisi yaz
• POST /OrderPackage/SetOrderPackageCargoInfoList — Kargo bilgisi yaz

Paket Bölme

• POST /OrderPackage/shipment-packages/{shipmentPackageId}/split — Paketi böl (satır bazlı)
• POST /OrderPackage/shipment-packages/{shipmentPackageId}/multi-split — Paketi gruplara böl
• POST /OrderPackage/shipment-packages/{shipmentPackageId}/quantity-split — Paketi adede göre böl
• POST /OrderPackage/shipment-packages/{shipmentPackageId}/split-packages — Paketten adetli yeni paketler oluştur

İptal & İade

• POST /Orders/CreateOrderItemLineCancelRequest — İptal talebi oluştur
• POST /Orders/CancelOrderItemLineList — Satır iptal et
• POST /Return/CreateReturnRequest — İade talebi oluştur
• GET /Orders/GetReturnOrderPackages — İade paketlerini listele

Tanımlar

• GET /Lookup/OrderStatusReasonByTenant/GetStatusReasonByType — Statü sebeplerini listele