siparis.app API
Siparişlerinizi, müşterilerinizi, ürünlerinizi ve stoğunuzu kendi yazılımınızdan okuyup yazmanızı sağlayan REST API. Kargo, iade ve fatura işlemleri de buradan yapılır; değişiklikler olay akışı ve webhook ile gelir. Kullanımı ücretsizdir.
Tek bakışta
| Konu | Bilgi |
|---|---|
| Temel adres | Canlı: https://api.siparis.app/v1 · Deneme: https://api.sandbox.siparis.app/v1 (ayrı hesap ve spk_test_ anahtarı; Deneme ortamı) |
| Kimlik doğrulama | Her istekte Authorization: Bearer <anahtar> başlığı. Anahtarı işletme sahibi panelde İşletme › Entegrasyonlar › Geliştirici sayfasında oluşturur; anahtar yalnız sunucunuzda durur, tarayıcıya ve URL’ye yazılmaz. |
| İzinler | Anahtar yalnız seçilen kapsamları (izinleri) ve markaları görür; yazma izni okuma izni vermez. Kapsamlar |
| Biçim | JSON, UTF-8. Tutar ve miktar ondalık metindir ("120.00"), zaman RFC 3339 UTC’dir. Kimlikler önekli metindir (ord_…); Kimlik önekleri |
| Hız sınırı | Bağlantı başına 60 saniyede 600 puan; çoğu okuma 1–2 puandır. Aşımda 429 ve beklenecek saniyeyi veren Retry-After döner. Yeni satış (sipariş açma, başka kanaldaki satışı bildirme) bu bütçeye girmez. Hız sınırı |
| Tekrar anahtarı | Her yazma isteğinde Idempotency-Key başlığı zorunludur (en çok 200 karakter, iş başına benzersiz). Ağ hatasında aynı anahtar ve aynı gövdeyle tekrar edin; iş iki kez yapılmaz, yanıta Idempotent-Replayed: true eklenir. |
| Sürüm | Adresteki v1. Yanıttaki Siparis-Version başlığı sürümü söyler; geriye uyumsuz değişiklik yeni sürümle gelir. Değişiklik günlüğü |
| Listeler | {data, has_more, next_cursor}; limit en çok 100. Sonraki sayfa için next_cursor değerini cursor olarak gönderin. İmleçle listeleme |
| Hatalar | application/problem+json; programınız code alanına göre karar verir. Hata kodları |
| Postman | Postman koleksiyonunu indirin: bütün uçlar, {{baseUrl}} ve {{apiKey}} değişkenleriyle; anahtar içermez. |
| AI ile | AI için belge dizini, OpenAPI ve MCP bağlantısı. |
İlk istek
curl --fail-with-body --silent --show-error \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/me" \
-H "Authorization: Bearer $SIPARIS_API_KEY"
Yanıt anahtarın kapsamlarını, erişebildiği markaları ve bu ortamın adresini verir. Adım adım kurulum: Başlarken.
Kaynaklar
Menüdeki her grup bir kaynaktır; her ucun kendi sayfasında alanlar, örnek istek ve yanıt, o uca özgü hatalar bulunur. Hepsi bir arada: Bütün uçlar.
- Siparişler: Sipariş açın, listeleyin, onaylayın, teslim edin, düzeltin ve iptal edin. Sipariş oluştur, Siparişleri listele, Siparişi getir
- Müşteriler: Müşteri kartını bulun, ekleyin, güncelleyin, arşivleyin veya KVKK için anonimleştirin. Müşteri oluştur, Müşterileri listele, Müşteriyi getir
- Ürünler: Ürün, seçenek, kategori, ürün markası ve markaya özel fiyat. Ürün oluştur, Ürünleri listele, Ürünü getir
- Stok: Depodaki miktarlar, stok girişi, sayım, fire, depolar arası taşıma ve stok geçmişi. Stok miktarlarını listele, Stok girişi yap, Stok sayımı yap
- Kargo: Kargo fiyatı sorun, BasitKargo gönderisi açın, etiket indirin ve iptal edin. Kargo fiyatı sor, Gönderi oluştur, Gönderiyi getir
- İade: İade talebini karara bağlayın, ürünü geri alın ve parayı iade edin. İadeyi önizle, İade başlat, Para iadesini getir
- Fatura: Fatura kesin, belgesini indirin ve iptal edin. Faturayı önizle, Fatura kes, Faturayı getir
- Başka kanaldaki satış: Ödemesi başka kanalda alınmış satışı stoğa ve sipariş listesine işleyin. Başka kanaldaki satışı bildir
- Toplu işler: Binlerce satırlık fiyat ve stok güncellemesini tek işte yapın. Toplu fiyat güncelle, Toplu stok say, Toplu işin durumunu getir
- Kuponlar: İndirim kuponlarını ekleyin, güncelleyin ve arşivleyin. Kupon oluştur, Kuponları listele, Kuponu getir
- Olaylar ve Webhook: Değişiklikleri olay akışından okuyun ya da adresinize imzalı bildirim alın. Olayları listele, Olayı getir, Webhook adresi oluştur
- Dışa aktarma: İlk eşitleme için tutarlı JSONL/CSV dosyası hazırlayın ve indirin. Dışa aktarma başlat, Dışa aktarmanın durumunu getir, Dışa aktarma dosyasını indir
- Uygulamalar (OAuth) ve MCP: Başka satıcılar için uygulama yapmak (OAuth: /oauth/authorize, /oauth/token) ve AI asistanını /mcp adresine bağlamak. Uygulamalar ve MCP aynı REST uçlarını ve kapsamları kullanır. Başka satıcılar için uygulama yapmak, Uygulama sözleşmesi ve KVKK taahhüdü, AI asistanınızı bağlamak (MCP)
- Hesap: Bağlantıyı doğrulayın; işletmeyi ve markaları okuyun. Bağlantıyı doğrula, İşletmeyi getir, Markaları listele
Her yanıttaki başlıklar
Bu başlıklar bütün uçlarda aynıdır; uç sayfalarında yalnız o uca özgü başlıklar (ör. ETag, Location) yazılır.
| Başlık | Anlamı |
|---|---|
X-Request-ID | Destek için istek takip kimliği. |
Siparis-Version | Yanıtın API ana sürümü. |
RateLimit | Kalan okuma puanı (r) ve kayan pencerenin uzunluğu, saniye (t). Kimliksiz sözleşme ucunda bulunmaz. |
RateLimit-Policy | Bağlantı başına 60 saniyede 600 okuma puanı. Kimliksiz sözleşme ucunda bulunmaz. |
Retry-After | Yeniden denemeden önce beklenecek saniye sayısı. |
Idempotent-Replayed | Makbuz bulunduğunda true; işlem yeniden yürütülmez, kaynak güncel izinlerle okunur. |
Yapmak istediğiniz işi görev görev görmek için: Neler yapabilirim.