İçeriğe geç
KuryeSoft

API başvurusu

Siparişi sorgula

Siparişin güncel durumu, kurye bilgisi, tahmini teslim zamanı ve takip bağlantısı.
GEThttps://kurye.firmaniz.com/api/v1/orders/{ref}

Durum değişikliklerini öğrenmenin asıl yolu webhook'lardır; bu çağrıyı webhook'u kaçırdığınızdan şüphelendiğinizde ya da kullanıcı ekranı açtığında son durumu almak için kullanın.

Paket yoldayken (picked_up, at_customer) courier.lat ve courier.lng kuryenin son konumunu verir. Düzenli sorgulayacaksanız 30 saniyeden sık sorgulamayın ve sonuçlanan siparişleri (delivered, cancelled, failed) sorgulamayı bırakın.

İşletmeye bağlı anahtar yalnızca kendi işletmesinin siparişlerini görür; diğerleri için 404 döner.

Yol parametreleri

refmetinzorunlu
Sipariş başvurusu: sistemdeki sipariş kimliği (1842), sipariş numarası (2611200042) ya da gönderdiğiniz kimliğin başına ext: eklenmiş hali (ext:POS-10452). Bkz. Temel kavramlar.

Örnek istek

curl "https://kurye.firmaniz.com/api/v1/orders/ext:POS-10452" \
  -H "X-Api-Key: $KURYESOFT_API_KEY"

Yanıt

200 Başarılı

Sipariş. Gövde bir sipariş nesnesidir.

200 · application/json
{
  "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
}

Hatalar

Hata gövdesi her zaman { "error": { "code", "message", "fields" } } biçimindedir. Bu uçta karşılaşabileceğiniz kodlar (bütün liste için Hatalar):

API_KEY_REQUIRED
HTTP:401
Anlamı:İstekte API anahtarı yok ya da ks_ ile başlamıyor.
API_KEY_INVALID
HTTP:401
Anlamı:Anahtar yanlış, silinmiş ya da pasif.
NOT_FOUND
HTTP:404
Anlamı:Sipariş ya da işletme bulunamadı. Anahtarınızın göremediği bir işletmenin siparişi de böyle görünür.
İpucu:

429 RATE_LIMITED ve 5xx yanıtlarında kısa bir beklemeyle yeniden deneyin. Bkz. Yeniden deneme.