İçeriğe geç
KuryeSoft

API başvurusu

Siparişi iptal et

Siparişi iptal eder; atanmış kurye varsa siparişin iptal edildiği bildirilir.
POSThttps://kurye.firmaniz.com/api/v1/orders/{ref}/cancel

İşletme adına iptal yapılır; bu yüzden kurye firmasının işletmeler için belirlediği kurallar geçerlidir. Varsayılan olarak sipariş, kurye kabul edene kadar (pending, assigned, accepted) iptal edilebilir; kurye işletmeye vardıktan sonra 403 FORBIDDEN döner ve iptal için kurye firmasıyla iletişime geçilmesi gerekir.

İptal edilen siparişin ücretlendirilip ücretlendirilmeyeceği kurye firmasının ayarına bağlıdır (varsayılan: paket teslim alındıysa ücret alınır).

İptal order.cancelled webhook olayını üretir.

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.

İstek gövdesi

Content-Type: application/json. Belirtilmeyen alanlar varsayılan değeriyle kabul edilir; tanımsız alanlar yok sayılır.

reasonmetin
İptal sebebi. Panelde ve raporlarda görünür. İptal sebepleri listesinden seçilmesi önerilir.

2–255 karakter · Varsayılan: Dış sistem tarafından iptal edildi

Örnek istek

curl -X POST "https://kurye.firmaniz.com/api/v1/orders/ext:POS-10452/cancel" \
  -H "X-Api-Key: $KURYESOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Müşteri vazgeçti"
  }'

Yanıt

200 Başarılı

Sipariş iptal edildi. Gövde bir sipariş nesnesidir.

200 · application/json
{
  "id": 1842,
  "code": "2611200042",
  "external_id": "POS-10452",
  "status": "cancelled",
  "status_label": "İptal edildi",
  "restaurant_id": 1,
  "tracking_url": "https://kurye.firmaniz.com/takip/oKe9xPqrlr7b_4jbNQiNCw",
  "courier": null,
  "distance_m": 1754,
  "eta_at": null,
  "delivery_fee": 70,
  "total_amount": 285.5,
  "collect_amount": 285.5,
  "created_at": "2026-11-20T18:10:32.000Z",
  "assigned_at": null,
  "picked_up_at": null,
  "delivered_at": null,
  "cancelled_at": "2026-11-20T18:14:03.000Z",
  "cancel_reason": "Müşteri vazgeçti"
}

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.
VALIDATION
HTTP:422
Anlamı:Eksik ya da hatalı alan. Hangi alanın neden reddedildiği fields içinde yazar.
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.
FORBIDDEN
HTTP:403
Anlamı:İşlem kurye firmasının ayarlarıyla kapalı (ör. sipariş bu aşamada işletme tarafından iptal edilemez).
ALREADY_CANCELLED
HTTP:409
Anlamı:Sipariş zaten iptal edilmiş.
ORDER_FINAL
HTTP:400
Anlamı:Sipariş sonuçlanmış (teslim edildi, teslim edilemedi); değiştirilemez.
İpucu:

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