Rezervasyonlar
Rezervasyonları listele
API üzerinden alınan rezervasyonlar, sayfa sayfa; açık olanlar en yakın saat önce.
/public/v1/reservationsAnahtarın ulaştığı mekanlarda API'nin aldığı rezervasyonları, mekanın hangi anahtarıyla alındığına bakmadan listeler: yerine yenisi konmuş bir anahtarla alınan rezervasyon da listede yer alır. Mekanın başka bir yoldan aldığı rezervasyonlar (Cibusy uygulamasından, cibusy.com'daki sayfasından ya da telefonla) listede yer almaz. Her öğe GET /reservations/{reservationId} yanıtının gövdesidir.
Sıra, ne istediğinize bağlıdır. open en yakın saat önce gelir: ilk gelecek masa en üsttedir. closed ve all en geç saat önce gelir. Sayfa sayfa okuyun: nextCursor null olmadığı sürece cursor değerini ona eşitleyip yeniden isteyin.
Parametreler
venueIdstring · uuidSorgu parametresiYalnız bu mekanın rezervasyonları. Merkezin anahtarı şubelerinden birini adlandırabilir; anahtarın ulaştığı her mekanın rezervasyonları için vermeyin.
statusstringSorgu parametresiHangi rezervasyonlar: open (bekleyen, onaylanmış ya da misafiri gelmiş; varsayılan), closed (reddedilmiş, iptal edilmiş, tamamlanmış ya da misafiri gelmemiş) ya da all.
Varsayılan: Open
Değerler:OpenClosedAll
cursorintegerSorgu parametresiOkunacak sayfa, 1'den sayılır. Önceki sayfanın nextCursor değerinden alın.
Varsayılan: 1
pageSizeintegerSorgu parametresiSayfa başına rezervasyon: 1 ile 100 arası, varsayılan 50.
Varsayılan: 50
Accept-LanguagestringBaşlıkHata 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
Bir sayfa rezervasyon.
INVALID_PAGE_NUMBER, INVALID_PAGE_SIZE ya da üçünden biri olmayan bir status için VALIDATION_ERROR.
X-Api-Key başlığı yok (PUBLIC_API_KEY_MISSING) ya da anahtar geçersiz veya iptal edilmiş (PUBLIC_API_KEY_INVALID).
PUBLIC_API_SCOPE_MISSING: anahtar "Rezervasyon alabilir" izniyle oluşturulmamış.
PUBLIC_API_VENUE_NOT_FOUND: venueId bu anahtarın ulaşabildiği bir mekan değil.
Anahtarın dakikada yaklaşık 120 isteklik bütçesi doldu; Retry-After kadar saniye bekleyin.
Retry-AfterBeklenecek saniye. Bir sonraki dakikalık pencere bu süre içinde açılır.
Başarılı yanıtın data alanı
API üzerinden alınan rezervasyonların bir sayfası.
itemsobject[]Sayfanın rezervasyonları. En fazla pageSize kadar; son sayfadan sonra boş.
Rezervasyon alanları
idstring · uuidRezervasyonun kimliği. GET /reservations/{reservationId} ile kullanın.
venueIdstring · uuidMasanın ayırtıldığı mekan.
statusstringRezervasyonun geldiği aşama; her okumada yeniden hesaplanır, bu yüzden liste, tek rezervasyon ve webhook olayı aynı rezervasyon için farklı şeyler söyleyemez.
Pending- Mekan henüz yanıtlamadı. Rezervasyonları alındığı anda onaylayan bir mekanda görülmez.
Confirmed- Mekan kabul etti ya da rezervasyonları alındığı anda onaylıyor. Masa bekleniyor.
Declined- Mekan isteği reddetti.
Cancelled- İptal edildi. Kimin iptal ettiğini `cancelledBy` söyler.
Seated- Misafir geldi ve kapıda karşılandı.
Completed- Ziyaret bitti.
NoShow- Mekan kabul etti ama kimse gelmedi.
startsAtstring · date-timeMasanın ne zaman için olduğu, UTC bir an olarak.
guestsintegerKaç kişi geleceği.
customerobjectMasanın kimin için olduğu, mekanda kayıtlı haliyle.
Rezervasyon sahibi alanları
namestringnull olabilirMisafirin adı.
phonestringnull olabilirMisafirin telefon numarası, uluslararası biçimde.
notestringnull olabilirRezervasyonun yapıldığı not. Not yoksa null.
codestringnull olabilirMekanın misafiri kapıda karşılarken kullandığı kod: misafirin söyleyebileceği ya da pageUrl sayfasındaki QR olarak gösterebileceği sekiz karakter. Kodu elinde tutan rezervasyonu görebilir ve iptal edebilir; yalnız misafire verin.
pageUrlstringnull olabilirRezervasyonun cibusy.com'daki kendi sayfası: rezervasyonu ve onaylandıktan sonra mekanın kapıda okuttuğu QR'ı gösterir. Bağlantısını verin ya da misafire gönderin. Herkese açık adresi olmayan mekanda null.
canCancelbooleanRezervasyonun API üzerinden hala iptal edilip edilemeyeceği: geçerli, misafir kapıda karşılanmamış ve saati gelmemiş.
checkedInAtstring · date-timenull olabilirMisafirin kapıda karşılandığı an (UTC). O zamana kadar null.
cancelledAtstring · date-timenull olabilirRezervasyonun iptal edildiği an (UTC). status değeri Cancelled değilse null.
cancelledBystringnull olabilirKimin iptal ettiği. status değeri Cancelled değilse null.
Customer- Misafir: bu API üzerinden, rezervasyonun kendi sayfasından ya da Cibusy uygulamasından.
Venue- Mekan.
System- Cibusy: mekan isteği, rezervasyonun saatine kadar yanıtlamadı.
cancellationReasonstringnull olabilirİptal nedeni olarak söylenen, söyleyenin kendi sözleriyle. status değeri Cancelled değilse null.
createdAtstring · date-timeRezervasyonun yapıldığı an (UTC).
nextCursorintegernull olabilirSonraki sayfa için gönderilecek cursor; bu son sayfaysa null. Bir cursor 1'den sayılan bir sayfa numarasıdır.