İçeriğe geç

Mekanlar

Açık masaları listele

Mekanda şu an hesabı açık olan masalar ve her birinin hesabının tuttuğu; hesabı kim açmış olursa olsun.

GET/public/v1/venues/{venueId}/active-tables
Kimlik doğrulama

X-Api-Key başlığında API anahtarı

Gereken izin
Açık masaları görebilir
Hız sınırı
Anahtar başına dakikada yaklaşık 120 istek

Hesabı açık her masa ve hesabının tuttuğu, hesabı kim açmış olursa olsun: kasadaki çalışan, garson, masanın QR menüsünden sipariş veren misafir ya da sizin yazılımınız. Mekanın kendi ekranları ve çekilişleri için yapılmıştır: mekanda oturan masalar arasında bir çekiliş gibi. Ayrıntılar ve bir çekiliş örneği: Açık masalar.

Hangi masalar. Masa, hesabı açık olduğu sürece listelenir ve mekan hesabı kapattığında listeden düşer. Tamamı ödenmiş bir hesap da o zamana kadar kalır, çünkü misafirler hala masadadır. Oturulmuş ama sipariş verilmemiş bir masanın hesabı yoktur ve listelenmez; her kalemi iptal edilmiş bir hesap da listelenmez. Aynı grup için birleştirilen masalar tek kayıttır: table grubun hesabını taşıyan masadır, mergedTables diğerlerini adlandırır.

Tutarlar. Türk lirası, KDV dahil: kalemler, indirimler düşülmüş ve hizmet bedeli eklenmiş olarak. total ödenmiş kısmı da sayar; hesabının yarısını ödemiş bir grup, hesabın tamamını harcamıştır. Masanın tutarları bills içindeki hesapların toplamıdır.

minTotal. Bütün açık masalar için göndermeyin. Gönderildiğinde yalnız total değeri en az bu kadar olan masalar listelenir: minTotal=500, 500.00 tutan masayı listeler, 499.99 tutanı listelemez.

Misafirler hakkında hiçbir şey. Yanıt masada oturan kimseyi adlandırmaz, telefon numarası vermez, bir misafirin Cibusy hesabı olup olmadığını söylemez. Kazanan masayı adıyla duyurun; hesabı kasada number değeriyle bulun.

Canlı. Hesaplar her çağrıda yeniden okunur ve yanıt Cache-Control: no-store başlığıyla gelir. asOf, tutarların doğru olduğu andır.

Anahtarın "Açık masaları görebilir" izni olmalıdır; mekan bu izni panelinden verir.

Parametreler

venueIdstring · uuidYol parametresizorunlu

Mekanın kimliği, mekan listesinden.

minTotalnumberSorgu parametresi

Bir masanın listelenmesi için total değerinin ulaşması gereken en küçük tutar, TL olarak: 500 gibi. Sıfır ya da daha büyük; bütün açık masalar için göndermeyin.

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

Hesabı açık masalar ve her birinin tuttuğu.

400

minTotal negatif (PUBLIC_API_MIN_TOTAL_INVALID) ya da bir sayı değil (VALIDATION_ERROR).

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: anahtara "Açık masaları görebilir" izni verilmemiş.

404

Mekan yok ya da bu anahtar ona ulaşamıyor (PUBLIC_API_VENUE_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ı

Mekanın şu an hesabı açık olan masaları ve her birinin hesabının tuttuğu. Tutarlar TL, KDV dahil, iki ondalığa yuvarlanmış.

venueIdstring · uuid

Masaların bulunduğu mekan.

asOfstring · date-time

Yanıtın hesaplandığı an (UTC). Hesaplar her çağrıda yeniden okunur ve hiçbir şey saklanmaz; tutarlar bu anda doğrudur.

currencystring

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

minTotalnumbernull olabilir

İsteğin sorduğu minTotal: bir masa yalnız total değeri en az bu kadarsa listelenir. Bütün açık masalar istendiyse null.

tablesobject[]

Açık masalar, mekanın kasasında göründükleri sırayla: alan alan, her alanda önce mekanın düzenledikleri, sonra kalanlar adlarına göre, sayılar sayı olarak okunarak (T2, T10'dan önce). Hesabı açık masa yoksa ya da hiçbiri minTotal tutarına ulaşmıyorsa boş.

Açık masa alanları
tableobject

Hesabın bulunduğu masa, mekanın masa listesindeki haliyle. Mekanın sonradan sildiği bir masanın adı Unknown table olur.

Masa alanları
idstring · uuid

Masanın kimliği; masada verilen sipariş bunu kullanır.

namestring

Masanın kasada yazdığı adı.

codestringnull olabilir

Masanın QR kartında yazan kod. Kodu olmayan masada null.

capacityintegernull olabilir

Masanın kaç kişilik olduğu. Mekan belirtmediyse null.

areaobjectnull olabilir

Masanın bulunduğu kat, teras ya da salon. Yalnız mekanın sonradan sildiği bir masada null.

Masanın alanı alanları
idstring · uuid

Alanın kimliği, masa listesindeki alanınkiyle aynı.

namestring

Alanın adı.

mergedTablesobject[]

Aynı grup için bu masayla birleştirilen masalar; siparişleri bu masanın hesabına yazılır. Tek başına bir masada boş.

Masa alanları
idstring · uuid

Masanın kimliği; masada verilen sipariş bunu kullanır.

namestring

Masanın kasada yazdığı adı.

codestringnull olabilir

Masanın QR kartında yazan kod. Kodu olmayan masada null.

capacityintegernull olabilir

Masanın kaç kişilik olduğu. Mekan belirtmediyse null.

openedAtstring · date-time

Masanın açık hesaplarından en eskisinin açıldığı an (UTC).

totalnumber

Masanın açık hesaplarının toplamı: kalemler, indirimler düşülmüş ve hizmet bedeli eklenmiş olarak. İptal edilen kalemler sayılmaz, ödenmiş kısım sayılır. minTotal bununla karşılaştırılır. Her zaman hesapların total değerlerinin toplamıdır.

paidnumber

Masanın açık hesaplarına şimdiye kadar ödenen. Hesapların paid değerlerinin toplamı.

remainingnumber

Masanın açık hesaplarında hala ödenecek tutar. Hesapların remaining değerlerinin toplamı.

paymentStatusstring

Masanın hesaplarının ne kadarının ödendiği. Tamamı ödenmiş bir masa, mekan hesabı kapatana kadar listede kalır.

Unpaid
Masanın hesaplarının hiçbirinde ödeme yok.
PartiallyPaid
Bir kısmı ödendi: en az bir hesapta ödeme var ama her hesap tamamen ödenmedi.
Paid
Her hesap tamamen ödendi. Masa, mekan hesabı kapatana kadar listede kalır.
billsobject[]

Masanın açık hesapları, en eskisi önce. Genellikle bir tane; mekan aynı masa için ayrı hesaplar tutuyorsa daha fazla.

Açık hesap alanları
idstring · uuid

Hesabın kimliği, yani siparişin kimliği. API üzerinden verilmiş bir hesabı GET /orders/{orderId} okur; kasada ya da QR menüden açılmış bir hesap orada okunamaz.

numberinteger

Mekanın hesabı çağırdığı numara, mekan içinde 1'den başlayarak sayılır: mutfak fişinde ve hesapta yazan numara. Çalışanlar hesabı kasada bununla bulur.

openedAtstring · date-time

Hesabın açıldığı an (UTC).

totalnumber

Hesabın tuttuğu: kalemler, indirimler düşülmüş ve hizmet bedeli eklenmiş olarak. İptal edilen kalemler sayılmaz, ödenmiş kısım sayılır.

paidnumber

Hesaba şimdiye kadar ödenen.

remainingnumber

Hesapta hala ödenecek tutar.

paymentStatusstring

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

Unpaid
Hesapta henüz ödeme yok.
PartiallyPaid
Hesabın bir kısmı ödendi.
Paid
Hesap tamamen ödendi; mekan kapatana kadar açık kalır.