Siparişler

Siparişi oku

Bir siparişi mekanda şu an olduğu haliyle okuyun.

GET/public/v1/orders/{orderId}

Kimlik doğrulama: X-Api-Key başlığında API anahtarı
Gereken izin: Sipariş gönderebilir
Hız sınırı: Anahtar başına dakikada yaklaşık 120 istek

Bir siparişi takip etmek için bunu sorgulayın ya da aynı gövdeyi sipariş her değiştiğinde gönderen webhook'a güvenin. Sipariş, verildiği mekanın her anahtarıyla okunabilir; merkezin anahtarıyla şubelerinde de. API üzerinden verilmemiş, başka bir mekandaki ya da hiç olmayan sipariş 404 alır.

status siparişin satırlarından ve hesabından her okumada hesaplanır; değerlerin anlamı alanların altında. paymentStatus hesap mekanda ödendikçe değişir; müşteri totals.remaining tutarını mekanda öder.

Zaten açık bir hesaba eklenen masa siparişi, başkalarının sipariş ettiği satırlarla birlikte hesabın tamamı olarak gelir.

Rehber: Sipariş vermek

Parametreler

orderIdstring · uuidYol parametresizorunlu

Siparişin kimliği, sipariş verme yanıtından.

Accept-LanguagestringBaşlık

Hata yanıtlarındaki userMessage metninin dili: tr (varsayılan), en, de, fr, it, es, ar ya da ru. Başlıktaki ilk dil belirler, bölgesi olmadan (en-US, en okunur) ve q ağırlıklarına bakılmadan; Cibusy'nin sunmadığı bir dil Türkçe yanıtlanır. Menünün dilini seçmez; o, menü çağrısındaki lang parametresidir.

Yanıtlar

200

Sipariş.

401

X-Api-Key başlığı yok (PUBLIC_API_KEY_MISSING) ya da anahtar geçersiz veya iptal edilmiş (PUBLIC_API_KEY_INVALID).

403

PUBLIC_API_SCOPE_MISSING: anahtar "Sipariş gönderebilir" izniyle oluşturulmamış.

404

PUBLIC_API_ORDER_NOT_FOUND.

429

Anahtarın dakikada yaklaşık 120 isteklik bütçesi doldu; Retry-After kadar saniye bekleyin.

Retry-After

Beklenecek saniye. Bir sonraki dakikalık pencere bu süre içinde açılır.

Başarılı yanıtın `data` alanı

API üzerinden verilmiş bir sipariş, mekanda şu an olduğu haliyle. GET /orders/{orderId} yanıtının ve webhook'un order.updated olayının taşıdığı gövdenin aynısı. Tutarlar TL, KDV dahil, iki ondalığa yuvarlanmış.

idstring · uuid

Siparişin kimliği. GET /orders/{orderId} ile kullanın.

numberinteger

Mekanın siparişi çağırdığı numara, mekan içinde 1'den başlayarak sayılır. Müşteriye gösterin; mutfak fişinde yazan numaradır. Yalnız mekan içinde benzersizdir.

venueIdstring · uuid

Siparişin verildiği mekan.

typestring

Siparişin misafire nasıl ulaştığı.

DineIn: Masada: tur, masanın açık hesabına eklenir ya da yeni bir hesap açar.
Takeaway: Gel-al: müşteri siparişi mekandan alır.
Delivery: Paket: mekan siparişi müşteriye götürür.

statusstring

Siparişin geldiği aşama; sipariş satırlarından ve hesaptan her okumada yeniden hesaplanır.

Received: Mekan siparişi aldı, mutfak henüz başlamadı.
Preparing: Mutfak satırlardan en az birine başladı.
Ready: Her satır hazır ya da servis edildi.
Served: Her satır servis edildi.
OnTheWay: Paket mekandan çıktı.
Completed: Mekan hesabı kapattı.
Cancelled: Sipariş iptal edildi ya da üzerindeki her satır silindi.

paymentStatusstring

Hesabın ne kadarının mekanda ödendiği.

Unpaid: Mekanda henüz hiçbir şey ödenmedi.
PartiallyPaid: Hesabın bir kısmı ödendi.
Paid: Hesap ödendi.

tableobjectnull olabilir

Masa siparişinin masası. Gel-al ve pakette null.

Sipariş masası alanları

idstring · uuid

Masanın kimliği, GET /venues/{venueId}/tables listesindeki gibi.

namestring

Masanın adı.

customerobjectnull olabilir

Gel-al ya da paket siparişin kimin için olduğu. Masa siparişinde ve müşteri bilgisi alınmamış siparişte null.

Müşteri bilgisi alanları

namestringnull olabilir

Müşterinin adı.

phonestringnull olabilir

Müşterinin telefon numarası, uluslararası biçimde.

addressstringnull olabilir

Paketin gideceği adres.

paymentMethodstringnull olabilir

Müşterinin söylediyse nasıl ödeyeceği. Aksi halde null.

Cash: Nakit.
Card: Kart.
MealCard: Yemek kartı.

notestringnull olabilir

Siparişin verildiği mutfak notu. Not yoksa null.

linesobject[]

Siparişteki her satır; başkalarının masa hesabına koyduğu satırlar ve sonradan iptal edilenler dahil. Zaten açık bir hesaba eklenen masa siparişinde hesabın tüm satırları buradadır; sipariş verme yanıtındaki addedLineIds hangilerini o çağrının yazdığını söyler.

Sipariş satırı alanları

idstring · uuid

Satırın kimliği. Satır siparişte kaldığı sürece değişmez.

productIdstring · uuid

Ürün, menüdeki gibi.

productNamestring

Ürünün mekanın kendi sözleriyle adı.

portionIdstring · uuidnull olabilir

Sipariş edilen porsiyon, menüdeki gibi.

portionNamestringnull olabilir

Porsiyonun sipariş verildiği andaki adı.

quantityinteger

Kaç adet.

unitPricenumber

Bir adedin fiyatı, ekstralar dahil, sipariş verildiği andaki haliyle.

totalnumber

Satırın tuttuğu: unitPrice × quantity, kampanyalardan önce. İptal edilen ve mekanın ikram ettiği satırda 0.

statusstring

Satırın mutfakta geldiği aşama.

Pending: Mutfakta sırada.
Preparing: Hazırlanıyor.
Ready: Hazır.
Served: Servis edildi.
Cancelled: İptal edildi. İptal edilmiş bir siparişin satırları da böyle okunur.

extrasobject[]

Her adetteki ekstralar.

Satır ekstrası alanları

idstring · uuid

Ekstra, menüdeki gibi.

namestring

Ekstranın adı.

pricenumber

Sipariş verildiği anda adet başına tuttuğu.

removedIngredientsobject[]

Her adetten çıkarılan malzemeler.

Çıkarılan malzeme alanları

idstring · uuid

Malzeme, menüdeki gibi.

namestring

Malzemenin adı.

notestringnull olabilir

Bu satır için mutfak notu. Not yoksa null.

orderedAtstring · date-time

Satırın siparişe konduğu an (UTC).

totalsobject

Siparişin tuttuğu ve ne kadarının ödendiği.

Tutarlar alanları

subtotalnumber

Satırların ekstralarıyla menü fiyatı, kampanyalardan önce. İptal edilen satırlar sayılmaz.

discountnumber

Mekanın kampanyalarının ve indirimlerinin düştüğü tutar.

serviceFeenumber

Mekanın hizmet bedeli; kampanyalardan sonraki yiyecek tutarı üzerinden alınır. Mekan almıyorsa 0.

totalnumber

Siparişin tuttuğu.

paidnumber

Mekanda bunun ne kadarının ödendiği.

remainingnumber

Hala borç olan tutar. Hesap ödendiğinde 0.

currencystring

Tüm tutarların para birimi, ISO 4217 kodu. Her zaman TRY.

createdAtstring · date-time

Siparişin verildiği an (UTC).

closedAtstring · date-timenull olabilir

Mekanın siparişi kapattığı an (UTC). Sipariş açıkken ve iptal edilmiş siparişte null.

İstek örneği

curl "https://api.cibusy.com/public/v1/orders/7c9e6679-7425-40de-944b-e07fc1f90ae7" \
  -H "X-Api-Key: $CIBUSY_API_KEY"

Yanıt örneği

200 OK

{
  "success": true,
  "timestamp": "2026-10-01T09:30:00.123Z",
  "traceId": null,
  "data": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "number": 57,
    "venueId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "Takeaway",
    "status": "Preparing",
    "paymentStatus": "Unpaid",
    "table": null,
    "customer": {
      "name": "Ayşe Yılmaz",
      "phone": "+905321112233",
      "address": null
    },
    "paymentMethod": "Card",
    "note": null,
    "lines": [
      {
        "id": "3b5d7f91-a2c4-4e6f-8b1d-9f3a5c7e1b24",
        "productId": "5d2c8a41-7b0e-4c36-8f1d-9e4a6b3c2d10",
        "productName": "Izgara köfte",
        "portionId": "a8e1f6c3-2d94-4b70-b5a6-1c7d9e0f3a24",
        "portionName": "Porsiyon",
        "quantity": 2,
        "unitPrice": 360,
        "total": 720,
        "status": "Preparing",
        "extras": [
          {
            "id": "f1a2b3c4-d5e6-4f70-8192-a3b4c5d6e7f8",
            "name": "Ekstra peynir",
            "price": 40
          },
          {
            "id": "b4c5d6e7-f8a9-4b1a-8c2d-3e4f5a6b7c8d",
            "name": "İyi pişmiş",
            "price": 0
          }
        ],
        "removedIngredients": [
          {
            "id": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e",
            "name": "Soğan"
          }
        ],
        "note": "Köfteler ayrı paketlensin.",
        "orderedAt": "2026-10-01T09:30:00.000Z"
      }
    ],
    "totals": {
      "subtotal": 720,
      "discount": 0,
      "serviceFee": 0,
      "total": 720,
      "paid": 0,
      "remaining": 720
    },
    "currency": "TRY",
    "createdAt": "2026-10-01T09:30:00.000Z",
    "closedAt": null
  },
  "message": "Operation completed successfully"
}

Hata örneği

404 Not Found

{
  "success": false,
  "userMessage": "Sipariş bulunamadı.",
  "developerMessage": "No order with this id was placed through the API at a venue this key can reach.",
  "errorCode": "PUBLIC_API_ORDER_NOT_FOUND",
  "validationErrors": null,
  "details": null,
  "timestamp": "2026-10-01T09:30:00.123Z",
  "traceId": null
}

Siparişi oku

Parametreler

Yanıtlar

Başarılı yanıtın data alanı

Başarılı yanıtın `data` alanı