Kavramlar ve kimlik önekleri
siparis.app API alan adları İngilizce, açıklamaları Türkçedir. API temel adresi https://api.siparis.app/v1; her ucun kapsamı kendi sayfasındadır (Bütün uçlar); kodlu değerlerin Türkçe karşılıkları Kodlar ve durumlar sayfasındadır. Kimlikleri metin olarak saklayın; önekten sonraki 32 küçük onaltılık karakter UUID’dir. Kimlik sırasından zaman veya iş sırası çıkarmayın.
| Türkçe kavram | API alanı / kaynak | Kimlik öneki |
|---|---|---|
| İşletme | business | bus_ |
| Satıcının satış markası | store / stores | sto_ |
| Ürün markası (üretici) | brand / brands | brd_ |
| Depo | location / locations | loc_ |
| Ürün | product / products | prd_ |
| Seçenek | variant / variants | var_ |
| Kategori | category / categories | cat_ |
| Sipariş | order / orders | ord_ |
| Sipariş satırı | line / lines | lin_ |
| Müşteri | customer / customers | cus_ |
| Tahsilat | collection / payments | col_ |
| Geri ödeme | refund / payments | rfd_ (eski iade kaydı ret_) |
| İade / değişim | return / returns | ret_ |
| Gönderi | shipment / shipments | shp_ |
| Fatura | invoice / invoices | inv_ |
| Stok bakiyesi | inventory/levels | lvl_ |
| Stok hareketi | inventory/movements | mov_ |
| Stok belgesi | inventory/documents | doc_ |
| Tedarikçi | supplier | sup_ |
| API bağlantısı | grant | grt_ |
| Olay | event / events | evt_ |
| Webhook adresi | webhook_endpoints | whe_ |
| Webhook teslimi | deliveries | whd_ |
| Teslim denemesi | attempts | wha_ |
| Dışa aktarma | exports | exp_ |
| İndirilebilir dosya | files | fil_ |
store satıcının markasıdır; brand ürünün üretici/ticari markasıdır. Marka fiyatının bağımsız kimliği yoktur: anahtarı store, product, variant üçlüsüdür. number görünen sipariş numarasıdır, id yerine kullanılmaz.
scope bir işlem iznidir. grant işletmenin verdiği bağlantı yetkisidir; anahtar döndürülünce aynı bağlantı sürer. cursor kaldığınız yeri taşıyan opak metindir, kimlik değildir. resume_cursor tutarlı ilk dosyadan olay akışına geçiş konumudur. İmleçleri ayrıştırmayın veya kendiniz üretmeyin.
Para ve miktar ondalık metindir; null, sıfır değildir. Zamanlar RFC 3339 UTC; tarih alanları YYYY-MM-DD biçimindedir. Alanın hiç bulunmaması izin veya istenmeyen genişletme nedeniyle olabilir; null ile aynı varsaymayın. archived=true arşiv kayıtlarını açık kayıtlarla birlikte getirir; veri geçmişi korunur.
job_: toplu fiyat/stok güncelleme işinin kalıcı kimliği; /jobs/{id} ve /jobs/{id}/errors ile izlenir.