İçeriğe geç
KuryeSoft

Siparişler

Sipariş nesnesi

Sipariş iki biçimde gelir: API yanıtlarında entegrasyonun ihtiyaç duyduğu özet, webhook gövdesinde ise siparişin bütün ayrıntıları.
Nerede
API yanıtı:POST /orders, GET /orders/{ref}, /ready, /cancel
Webhook gövdesi:order alanı
İşletme
API yanıtı:restaurant_id
Webhook gövdesi:restaurant nesnesi (ad, adres, telefon, konum)
Kurye
API yanıtı:ad, telefon ve yoldayken canlı konum
Webhook gövdesi:kimlik, ad, telefon, araç, fotoğraf
Müşteri, adres, ürünler
API yanıtı:—
Webhook gövdesi:Var
Sizin kimliğiniz
API yanıtı:external_id
Webhook gövdesi:external_code (gönderdiyseniz); external_id yer almaz
Takip
API yanıtı:tracking_url
Webhook gövdesi:tracking_token
Teslimat ücreti
API yanıtı:delivery_fee (firma izin veriyorsa)
Webhook gövdesi:restaurant_fee

Webhook'u siparişinizle eşleştirmek

Webhook gövdesinde external_id bulunmaz. Siparişi gönderdiğinizde yanıttaki id değerini kendi kaydınıza yazın ve webhook'u order.id ile eşleştirin. Kısa sipariş numaranızı external_code olarak gönderdiyseniz o da gövdede gelir.

API yanıtındaki sipariş

Sipariş oluştur, sorgula, hazır işaretle ve iptal et çağrıları bu nesneyi döndürür.

idtam sayı
Siparişin sistemdeki kimliği. Kendi kaydınızda saklayın: webhook gövdesinde order.id olarak gelir.
codemetin
Sipariş numarası. Panelde ve kurye uygulamasında görünen numaradır (ör. 2611200001).
external_idmetin · boş olabilir
Siparişi gönderirken verdiğiniz kendi kimliğiniz.
statusmetin
Siparişin durumu. Bkz. Sipariş yaşam döngüsü.

Değerler: pending, assigned, accepted, at_restaurant, picked_up, at_customer, delivered, cancelled, failed

status_labelmetin
Durumun Türkçe adı; ekranda gösterebilirsiniz.
restaurant_idtam sayı
Siparişin yazıldığı işletmenin kimliği.
tracking_urlmetin
Müşteriyle paylaşılabilen canlı takip sayfası. Bkz. Müşteri takibi.
couriernesne · boş olabilir
Atanan kurye; kurye atanmadıysa null.
courier.namemetin
Kuryenin adı.
courier.phonemetin
Kuryenin telefonu (05XXXXXXXXX).
courier.latsayı · boş olabilir
Kuryenin son konumu. Yalnızca paket yoldayken (picked_up, at_customer) dolar.
courier.lngsayı · boş olabilir
Kuryenin son konumu (boylam).
distance_mtam sayı · boş olabilir
İşletmeden teslimat adresine yol mesafesi (metre). Konum yoksa null.
eta_attarih-saat · boş olabilir
Tahmini teslim zamanı. Kurye atandıktan sonra hesaplanır; sipariş sonuçlanınca null olur.
delivery_feesayı
İşletmeye yansıyan teslimat ücreti (TL). Kurye firması işletmenin ücretleri görmesini kapattıysa bu alan yanıtta hiç yer almaz.
total_amountsayı
Sipariş tutarı (TL).
collect_amountsayı
Kuryenin kapıda tahsil edeceği tutar (TL). Önceden ödenmiş siparişte 0.
created_attarih-saat
Siparişin alındığı an.
assigned_attarih-saat · boş olabilir
Kuryenin atandığı an.
picked_up_attarih-saat · boş olabilir
Paketin teslim alındığı an.
delivered_attarih-saat · boş olabilir
Teslim edildiği an.
cancelled_attarih-saat · boş olabilir
İptal edildiği ya da teslim edilemediği an.
cancel_reasonmetin · boş olabilir
İptal ya da teslim edilememe sebebi.
Örnek: paket yolda
{
  "id": 1842,
  "code": "2611200042",
  "external_id": "POS-10452",
  "status": "picked_up",
  "status_label": "Yolda",
  "restaurant_id": 1,
  "tracking_url": "https://kurye.firmaniz.com/takip/oKe9xPqrlr7b_4jbNQiNCw",
  "courier": {
    "name": "Ahmet Yılmaz",
    "phone": "05550000001",
    "lat": 40.992,
    "lng": 29.03
  },
  "distance_m": 1754,
  "eta_at": "2026-11-20T18:31:28.000Z",
  "delivery_fee": 70,
  "total_amount": 285.5,
  "collect_amount": 285.5,
  "created_at": "2026-11-20T18:10:32.000Z",
  "assigned_at": "2026-11-20T18:12:05.000Z",
  "picked_up_at": "2026-11-20T18:24:40.000Z",
  "delivered_at": null,
  "cancelled_at": null,
  "cancel_reason": null
}

Webhook gövdesindeki sipariş

Webhook isteklerinin order alanı, siparişin olay anındaki tam halidir. Örnek gövde için Olaylar sayfasına bakın.

idtam sayı
Siparişin sistemdeki kimliği (API yanıtındaki id). Webhook'u kendi siparişinizle bununla eşleştirin.
codemetin
Sipariş numarası.
statusmetin
Siparişin olay anındaki durumu.

Değerler: pending, assigned, accepted, at_restaurant, picked_up, at_customer, delivered, cancelled, failed

status_labelmetin
Durumun Türkçe adı.
sourcemetin
Siparişin geldiği kanal: bu API ile gönderilenlerde api, panelden girilenlerde manual, hazır platform/POS entegrasyonlarında sağlayıcının adı.
is_simulatedmantıksal
Her zaman false: simülasyon (test modu) siparişleri webhook ile gönderilmez.
external_codemetin · boş olabilir
Gönderirken verdiğiniz external_code.
restaurantnesne
Siparişin işletmesi.
restaurant.idtam sayı
İşletme kimliği.
restaurant.namemetin
İşletme adı.
restaurant.addressmetin · boş olabilir
İşletme adresi.
restaurant.phonemetin · boş olabilir
İşletme telefonu.
restaurant.latsayı · boş olabilir
İşletme konumu.
restaurant.lngsayı · boş olabilir
İşletme konumu.
couriernesne · boş olabilir
Atanan kurye; yoksa null.
courier.idtam sayı
Kurye kimliği.
courier.namemetin
Kuryenin adı.
courier.phonemetin
Kuryenin telefonu.
courier.vehicle_typemetin
Araç türü.

Değerler: motorcycle, car, bicycle, scooter, walk

courier.photo_urlmetin · boş olabilir
Kurye fotoğrafı.
customer_namemetin · boş olabilir
Müşteri adı.
customer_phonemetin · boş olabilir
Müşteri telefonu (05XXXXXXXXX).
addressmetin
Teslimat adresi.
address_detailmetin · boş olabilir
Bina, kat, daire.
directionsmetin · boş olabilir
Adres tarifi.
latsayı · boş olabilir
Teslimat konumu.
lngsayı · boş olabilir
Teslimat konumu.
payment_typenesne · boş olabilir
Ödeme tipi.
payment_type.idtam sayı
Ödeme tipi kimliği.
payment_type.namemetin
Ödeme tipinin adı.
payment_type.kindmetin
Ödeme türü.

Değerler: cash, card, online, meal_card, other

payment_type.collect_from_customermantıksal
Kurye kapıda tahsilat yapar mı.
total_amountsayı
Sipariş tutarı (TL).
collect_amountsayı
Kapıda tahsil edilecek tutar (TL).
package_counttam sayı
Paket sayısı.
itemsnesne dizisi · boş olabilir
Ürünler (gönderdiyseniz).
items[].namemetin
Ürün adı.
items[].quantitysayı
Adet.
items[].pricesayı
Birim fiyat.
items[].notemetin
Ürün notu.
items[].optionsmetin dizisi
Seçenekler.
notemetin · boş olabilir
Sipariş notu.
is_readymantıksal
İşletme siparişi hazır işaretledi mi.
prep_minutestam sayı
Hazırlık süresi (dakika).
ready_attarih-saat · boş olabilir
Siparişin hazır olacağı (ya da hazır işaretlendiği) an.
scheduled_attarih-saat · boş olabilir
İleri tarihli siparişte hazırlığın başlayacağı an.
distance_mtam sayı · boş olabilir
Yol mesafesi (metre).
duration_stam sayı · boş olabilir
Tahmini yol süresi (saniye).
eta_attarih-saat · boş olabilir
Tahmini teslim zamanı.
route_seqtam sayı · boş olabilir
Kuryenin rotasındaki sırası (birden çok paket taşırken).
business_datetarih
Siparişin yazıldığı iş günü (YYYY-AA-GG). İş günü firmanın ayarındaki saatte başlar.
created_attarih-saat
Siparişin alındığı an.
assigned_attarih-saat · boş olabilir
Kuryenin atandığı an.
accepted_attarih-saat · boş olabilir
Kuryenin kabul ettiği an.
arrived_restaurant_attarih-saat · boş olabilir
Kuryenin işletmeye vardığı an.
picked_up_attarih-saat · boş olabilir
Paketin teslim alındığı an.
arrived_customer_attarih-saat · boş olabilir
Kuryenin adrese vardığı an.
delivered_attarih-saat · boş olabilir
Teslim edildiği an.
cancelled_attarih-saat · boş olabilir
İptal edildiği ya da teslim edilemediği an.
cancel_reasonmetin · boş olabilir
İptal ya da teslim edilememe sebebi.
delivery_notemetin · boş olabilir
Kuryenin teslimatta yazdığı not.
proof_photo_urlmetin · boş olabilir
Teslimat fotoğrafı (firma bu özelliği kullanıyorsa).
customer_idtam sayı · boş olabilir
Müşteri kaydının kimliği (telefon numarasına göre).
tracking_tokenmetin
Takip sayfası anahtarı: takip adresi {sunucu}/takip/{tracking_token} biçimindedir.
restaurant_feesayı
İşletmeye yansıyan teslimat ücreti (TL).

Yanıtlara ileride yeni alanlar eklenebilir; tanımadığınız alanları yok sayın.