İşletme API Dokümantasyonu
İşletmeler siparişleri kendi kasa/adisyon yazılımlarından yönetebilir, menü ve ürün güncellemelerini gönderebilir, sipariş olaylarını webhook ile alabilir. Tüm istekler işletmeye özel x-api-key başlığıyla doğrulanır.
Kimlik doğrulama
Anahtar, yönetim panelindeki “Market API Anahtarları” ekranından işletme adına oluşturulur ve yalnızca o işletmenin verisine erişir. Anahtar her isteğe başlık olarak eklenir; gövdeye veya adres satırına yazılmaz.
Uç noktalar
| Yöntem | Adres | Açıklama |
|---|---|---|
| GET | /api/isletme/menu | Menü detayı: kategoriler, ürünler, seçenekler |
| POST | /api/isletme/urun | Tek ürün ekleme, düzenleme, satışa açma/kapama |
| GET | /api/isletme/kategoriler | Kategori listesi ve ürün adetleri |
| POST | /api/isletme/kategoriler | Kategori ekleme, adı değiştirme, açma/kapama, sıralama |
| GET | /api/isletme/siparisler | Tarih aralıklı sipariş listesi ve özet (rapor) |
| GET | /api/isletme/siparis?no= | Tek siparişin tam detayı |
| POST | /api/isletme/siparis | Sipariş durumu değiştirme ve iptal bildirimi |
| GET | /api/isletme/durum | Mağazanın açık/kapalı durumu |
| POST | /api/isletme/durum | Mağazayı açma/kapama |
| GET | /api/isletme/teslimat | Tanımlı teslimat bölgeleri |
| POST | /api/isletme/teslimat | Teslimat bölgelerini ve alanı bildirme |
| POST | /api/isletme/test-siparis | Test siparişi oluşturma / test durumu değiştirme |
| GET | /api/isletme/test-siparis?no= | Test siparişi detayı |
Toplu ürün aktarımı için mevcut şablon ayrı sayfada: Market API Entegrasyon Şablonu.
Sipariş durumu değiştirme
| durum | Sonuç | Açıklama |
|---|---|---|
| kabul | preparing | Sipariş kabul edildi; hazırlık süresi başlar (hazirlik_dakika) |
| hazir | - | Paket hazır; kurye hemen çağrılır (siparis.hazir olayı) |
| yolda | on_the_way | Sipariş yola çıktı |
| teslim | delivered | Sipariş teslim edildi |
| iptal | cancelled | Sipariş iptal edildi; sebep opsiyonel (sebep) |
Her durum değişikliğinde müşteriye bildirim gider ve işletmenin webhook adresine olay gönderilir. Online ödemeli ve ödemesi tamamlanmamış sipariş kabul edilemez; teslim edilen sipariş iptal edilemez.
Menü, ürün, kategori, teslimat ve mağaza durumu
- Menüdeki her ürünün
iddeğeri ürün uçlarında kullanılır; marketler ayrıca kendirefkodunu gönderebilir. - Fiyat veya görsel değişimi ürünü yeniden yönetici onayına alır.
- Kapatılan kategorinin ürünleri vitrinde görünmez, kayıtları korunur.
{ "acik": false }mağazayı kapatır: vitrinde kapalı görünür ve yeni sipariş alınmaz;{ "manuel_durum": "auto" }çalışma saatlerine döndürür.- Teslimat bölgeleri ilçe adları listesi ve hizmet alanı (km²) olarak bildirilir.
Sipariş webhook'u
Webhook adresi işletme panelindeki “API ve Webhook” ekranından tanımlanır. Adres https olmalıdır. Gönderim 8 saniye içinde yanıtlanmazsa başarısız sayılır; sipariş akışı bundan etkilenmez, son gönderim sonucu panelde görünür.
| Olay | Ne zaman gönderilir |
|---|---|
| siparis.yeni | Yeni sipariş oluştu |
| siparis.durum | Durum değişti: kabul, yolda, teslim |
| siparis.hazir | Sipariş hazır olarak işaretlendi |
| siparis.iptal | Sipariş iptal edildi (sebep dahil) |
| siparis.kurye | Siparişe kurye atandı |
x-pp-signature, gövdenin imza anahtarıyla hesaplanmış HMAC-SHA256 özetidir (hex). Doğrulama örneği:
Test ortamı
Test siparişleri canlı sipariş tablosuna hiç yazılmaz: kendi kayıtlarında tutulur, raporlara, kurye akışına ve müşteri bildirimlerine karışmaz. Böylece entegrasyon denemeleri canlı operasyonu etkilemez. Test sipariş numaraları TEST- önekiyle üretilir.
Test siparişi oluşturulduğunda webhook adresinize gerçek olayla aynı yapıda bir gönderim yapılır ve yanıt kodu döner; adresiniz çalışmıyorsa bunu anında görürsünüz.
Hata yanıtları
- 200 / 201 işlem alındı
- 400 şablon veya alan hatası —
hataalanında açıklama - 401 geçersiz veya pasif
x-api-key - 404 anahtara bağlı işletme ya da kayıt bulunamadı
- 409 sipariş bu durumdan istenen duruma geçemiyor