API
English

Başlangıç

Temel kurallar

Tüm servisler için geçerli istek ve yanıt kuralları, tarih biçimleri ve limitler.

İstek

  • Adres biçimi: https://out.stockmount.com/api/{Controller}/{Action}, ör. https://out.stockmount.com/api/Integration/GetSales.
  • Tüm servisler POST ile çağrılır. Gövde UTF-8 JSON olmalı ve Content-Type: application/json başlığı gönderilmelidir.
  • Kimlik bilgisi başlıkta değil, gövdedeki ApiCode alanındadır (Kimlik doğrulama).
  • Alan adları dokümandaki yazımla (PascalCase) gönderilmelidir. Bilinmeyen alanlar yok sayılır; değeri null olan alanlar gönderilmemiş sayılır.
  • Ondalık sayılarda nokta kullanın (249.90). Tutarlar veritabanında 2 ondalık basamakla saklanır.

Yanıt zarfı

Başarılı ve başarısız tüm yanıtlar aynı yapıdadır:

AlanAçıklama
Resultİşlem başarılıysa true. Kararı her zaman önce bu alanla verin.
ResponseServisin döndürdüğü veri. Bazı servislerde boştur.
ErrorCodeHata kodu (ör. 00003). Tüm kodlar: Hata kodları.
ErrorMessageHatanın açıklaması veya eksik alanın adı. Metin değişebilir; programınızı bu metne göre kurmayın.
MessageBilgi mesajı. Bazı servisler sonucu veya hatayı bu alanda açıklar.
{
  "Result": true,
  "Response": { "ProductId": 184522 }
}
{
  "Result": false,
  "ErrorCode": "00003",
  "ErrorMessage": "StoreId"
}
  • Boş alanlar yanıtta yer almaz. Değeri null olan alanlar (başarılı yanıtta ErrorCode gibi) JSON'a hiç yazılmaz. Kodunuz eksik alanı boş değer olarak kabul etmelidir.
  • İş hataları HTTP 200 ile döner. HTTP durum koduna değil, Result alanına bakın.
  • Bazı servisler hatada ErrorCode göndermez, yalnızca ErrorMessage veya Message doldurur. Önerilen kontrol sırası: Result → ErrorCode → ErrorMessage / Message.
  • Bazı başarılı yanıtlar da ErrorCode taşır. Örneğin AddProduct aynı kodlu ürün zaten varsa Result: true ile birlikte 70004 döndürür.
  • Mesajların dili servise göre değişir; çoğu İngilizce, bazıları Türkçedir.

HTTP durum kodları

  • 200: istek işlendi; sonucu Result gösterir.
  • 400: gövde boş veya geçerli bir JSON değil. Bu yanıt ResultInfo değil, standart ProblemDetails biçimindedir.
  • 410: servis kaldırıldı (ör. DeleteProduct).

Tarih ve saat

  • İstekte tarihleri ISO 8601 biçiminde, saat dilimi eki olmadan Türkiye saatiyle gönderin: 2026-11-05T14:30:00. Sondaki Z yok sayılır ve değer yine Türkiye saati kabul edilir.
  • 05.11.2026 gibi yerel biçimleri kullanmayın; gün ve ay yer değiştirebilir.
  • Yanıtlarda biçim alana göre değişir. Sipariş tarihleri (OrderDate, CargoDate, InvoiceTime vb.) ve mesaj zamanları UTC olarak Z ekiyle döner. LastModificationTime, CreationTime ve PackageEndDate gibi alanlar ek olmadan Türkiye saatiyle döner. Her alanın biçimi servis sayfasında yazar.
  • Bazı tarih alanları boşken null yerine 1900'den önceki bir tarih (1899-12-31T22:03:00Z) döner. 1900'den önceki tarihleri boş kabul edin.

Limitler

KonuLimit
GetSales tarih aralığıEn fazla 7 gün
GetSales sayfa boyutuVarsayılan 20, en fazla 200 sipariş
GetProducts sayfa boyutuVarsayılan ve en fazla 100 ürün
Ürün güncelleme servisleriÇağrı başına tek ürün (varyantları aynı çağrıda)
Ürün görselleriÜrün başına en fazla 12
API anahtarıHesap başına en fazla 2

Sayfalı servislerde PageIndex 1'den başlar. İstekleri ihtiyacınız kadar gönderin: siparişleri birkaç dakikada bir çekmek yeterlidir; stok ve fiyatı yalnızca değiştiğinde gönderin.

Paketler

  • Giriş için hesabınızda API erişimi veren geçerli bir paket olmalıdır; yoksa DoLogin 99988 döndürür.
  • Ürün servisleri (Product/* ve SetProductSourceProducts) ayrıca aktif Ürün Paketi gerektirir; yoksa 70018 döner. Sipariş servisleri bu paketi gerektirmez.

Değişiklikler

API adresinde sürüm numarası yoktur. Kaldırılan servisler HTTP 410 döndürür; değişiklikler değişiklik günlüğünde duyurulur. Ayrıntılar: Sürüm politikası.

↑ ↓ ile gezinin, Enter ile açın, Esc ile kapatın.

Out API'ye bağlan

DoLogin çağrılır ve dönen ApiCode bu sekmede tutulur. API şifreniz bu siteye gönderilmez.