API ile neler yapabilirim?
Gerçek veriye dokunmadan başlamak için deneme ortamını kullanın.
API sipariş, müşteri, ürün, stok, kategori, ürün markası ve kupon bilgilerini okur ve yazar; kargo, iade ve fatura işlemlerini, başka kanaldaki kesinleşmiş satışı bildirmeyi ve toplu fiyat/stok güncellemeyi destekler. Değişiklikleri olay akışı ve webhook ile haber verir, toplu aktarım için dosya hazırlar. Aşağıdaki bütün görevler hazırdır. Her yazma isteği Idempotency-Key başlığı (tekrar anahtarı: aynı isteği güvenle yeniden göndermek için sizin ürettiğiniz benzersiz metin) ister.
“Gereken kapsam” sütunu, anahtarın o işi yapabilmesi için seçilmesi gereken izni gösterir; anahtar yalnız izin verilen markaların verisini görür. Uç adına tıklayınca alanları, örnek isteği ve yanıtı görürsünüz.
| Görev | Uç | Gereken kapsam | Rehber bağlantısı |
|---|---|---|---|
| AI asistanınızı bağlamak | POST /mcp | OAuth; araca göre aynı kaynak kapsamları | AI asistanınızı bağlamak |
Siparişleri listelemek (en yeni başta: sort=-created_at) | Siparişleri listele | orders:read | Siparişleri listelemek |
| Tek siparişi ve satırlarını görmek | Siparişi getir, Sipariş satırlarını listele | orders:read | Sipariş ayrıntısı |
| Siparişi numarayla bulmak | Siparişleri listele ?number=48273910 | orders:read | Numarayla bulmak |
| Yeni/değişen siparişleri almak | Siparişleri listele ?updated_at_from=2026-10-16T09:00:00Z, Olayları listele | orders:read; olaylar için ayrıca events:read | Değişiklikleri almak |
| Müşterileri listelemek | Müşterileri listele | customers:read | Müşterileri bulmak |
| Müşteriyi e-posta/telefonla bulmak | Müşterileri listele ?email=Ornek@Example.com veya ?phone=+90 500 000 00 00 | customers:read, personal_data:read | E-posta ve telefonla aramak |
| Bir müşterinin siparişlerini görmek | Siparişleri listele ?customer=cus_…&sort=-created_at | orders:read | Müşterileri bulmak |
| Ürünleri ve stoku okumak | Ürünleri listele, Stok miktarlarını listele | products:read, inventory:read | Stoku eşitlemek |
| Değişikliklerde webhook almak | Webhook adresi oluştur | webhooks:manage ve seçilen kaynağın okuma kapsamı (ör. orders:read) | Webhook |
| İlk toplu aktarımı yapmak (dışa aktarma) | Dışa aktarma başlat, Dışa aktarmanın durumunu getir, Dışa aktarma dosyasını indir | exports:write ve kaynağın okuma kapsamı; devamındaki olaylar için events:read | İlk eşitleme |
| Sipariş eklemek | Sipariş oluştur | orders:write; müşteri ve adres için personal_data:write | Sipariş eklemek |
| Başka kanalda kesinleşmiş satışı bildirmek | Başka kanaldaki satışı bildir | orders:write; müşteri ve adres için personal_data:write | Başka kanaldaki satışı bildirmek |
| Siparişi düzeltmek ve durumunu ilerletmek | Siparişi düzelt, Siparişi onayla vb. | orders:write; yerel para iadesi doğuyorsa money_out:write | Sipariş eklemek ve ilerletmek |
| Müşteri eklemek, güncellemek, arşivlemek | Müşteri oluştur, Müşteriyi güncelle, Müşteriyi arşivle | customers:write, personal_data:write; arşiv için archive:write | Müşteri eklemek |
| Müşteriyi KVKK kapsamında anonimleştirmek | Müşteriyi anonimleştir (KVKK) | customers:write, customers:erase, personal_data:write | KVKK silme isteği |
| Stok girmek, saymak, fire yazmak, depolar arası taşımak | Stok girişi yap, Stok sayımı yap, Fire ve kayıp yaz, Depolar arası taşı | inventory:write; alış fiyatı için costs:write | Stok girmek, saymak ve taşımak |
| Ürün ve seçenek eklemek, güncellemek, arşivlemek; marka fiyatı yazmak | Ürün oluştur, Ürünü güncelle, Ürüne seçenek ekle, Marka fiyatını yaz | products:write; maliyet için costs:write, arşiv için archive:write | Ürün eklemek ve güncellemek |
| Kategori yazmak | Kategori oluştur, Kategoriyi güncelle, Kategoriyi arşivle, Kategoriyi geri getir | products:write; arşiv/geri getirme için archive:write | Kategori, ürün markası ve kupon yazmak |
| Ürün markası yazmak | Ürün markası oluştur, Ürün markasını güncelle, Ürün markasını arşivle, Ürün markasını geri getir | products:write; arşiv/geri getirme için archive:write | Kategori, ürün markası ve kupon yazmak |
| Kupon yazmak | Kupon oluştur, Kuponu güncelle, Kuponu arşivle, Kuponu geri getir | coupons:write; arşiv/geri getirme için archive:write | Kategori, ürün markası ve kupon yazmak |
| Kargo oluşturmak/etiket almak | Kargo fiyatı sor, Gönderi oluştur, Kargo etiketini indir, Gönderiyi iptal et | Açma/fiyat/iptal: shipments:write; okuma/etiket: shipments:read; etiket ayrıca personal_data:read | Kargoya vermek |
| İade yapmak | İadeyi önizle, İade başlat, İade talebini onayla, İade talebini reddet | returns:write; para iadesinde ayrıca money_out:write, geri gönderim kodunda shipments:write | İade almak ve para iadesi |
| Başka satıcılar için uygulama yapmak — davetli | GET /oauth/authorize, POST /oauth/token | Satıcının onayladığı kapsamlar | Uygulama yapmak |
| Toplu fiyat ve stok güncellemek | Toplu fiyat güncelle, Toplu stok say, Toplu işin durumunu getir, Toplu işin hatalarını listele | products:write veya inventory:write; maliyet için costs:write | Toplu güncelleme |
| Fatura oluşturmak | Fatura kes, Faturayı iptal et, Fatura belgesini indir | invoices:write; iptalde money_out:write; belgede invoices:read personal_data:read | Fatura kesmek ve iptal etmek |
Mevcut gönderi, iade ve fatura kayıtları sipariş altından da okunabilir. Webhook kurmak ve dışa aktarma başlatmak sipariş, müşteri, ürün veya stok verisini değiştirmez.
API temel adresi https://api.siparis.app/v1. İlk bağlantı için Başlarken sayfasını açın.
Sunucu uygulamanız için repodan kurulabilen TypeScript ve Python SDK istemcilerini kullanabilirsiniz.