Booking List API

Bu yöntem, rezervasyonları konaklama tarihi, oluşturma tarihi, rezervasyon referansı veya misafir e-postası ile sorgular.

Booking list aşağıda açıklanan request ve response şeklini kullanır. Tarih filtreleri rezervasyon ve konaklama tarihi alanlarına uygulanır. bookingReferenceID, booking için mevcut referanslarla eşleştirilir. emailId gönderilirse, e-posta bulunan dönen booking verisini filtreler. Sayfalama mevcut sonuç setine uygulanır; limit ve page, istenen sayfa boyutu ve sayfa numarasıdır.

Endpoint

POST {BaseURL}/api/booking/book-list

Özellik	Değer
URI	{BaseURL}/api/booking/book-list
Method	POST
Content-Type	application/json

Yetkilendirme

Authentication sayfasında açıklanan Basic Auth header'ını gönderin.

Request Parametreleri

Parametre	Tip	Açıklama
FromDate	string	Konaklama başlangıç tarihi filtresi. Format: YYYY-MM-DD. ToDate ile birlikte zorunludur.
ToDate	string	Konaklama bitiş tarihi filtresi. Format: YYYY-MM-DD. FromDate ile birlikte zorunludur.
CreatedFrom	string	Opsiyonel rezervasyon oluşturma başlangıç tarihi filtresi. Format: YYYY-MM-DD.
CreatedTo	string	Opsiyonel rezervasyon oluşturma bitiş tarihi filtresi. Format: YYYY-MM-DD.
bookingReferenceID	string	Opsiyonel rezervasyon referansı filtresi. Rezervasyon tanımlayıcısı, onay numarası veya kendi sisteminizin referansı olabilir. Property casing aynen korunmalıdır.
emailId	string	Opsiyonel misafir e-posta filtresi. Gösterilen property casing aynı kalmalıdır.
limit	integer	Sayfalama kullanılırken sayfa başına kayıt sayısı. Varsayılan: 10.
page	integer	Sayfalı rezervasyon listesinde sayfa numarası. Varsayılan: 1.

bookingReferenceID, rezervasyon tanımlayıcısı, onay numarası veya kendi sisteminizin referansı olarak gönderilebilir.

Authorization

Bu endpoint, diğer booking endpoint'leri ile aynı API client credentials kullanılarak Basic Authorization header gerektirir.

Örnek Request

{
  "FromDate": "2030-06-01",
  "ToDate": "2030-06-30",
  "CreatedFrom": "",
  "CreatedTo": "",
  "bookingReferenceID": "",
  "emailId": "",
  "limit": 10,
  "page": 1
}

Örnek veri notu: Yukarıdaki tarihler ve boş filtreler sentetik ve açıklama amaçlıdır. Canlı rezervasyon verisi olarak kopyalamayın.

Başarılı Response

{
  "Status": {
    "Code": 200,
    "Description": ""
  },
  "BookingDetail": [
    {
      "Index": 1,
      "BookingId": "00000000-0000-4000-8000-000000000001",
      "ConfirmationNo": "00000000-0000-4000-8000-000000000001",
      "BookingDate": "15.05.2030",
      "Currency": "USD",
      "AgencyName": "",
      "BookingPrice": "250.5",
      "TripName": "",
      "HotelCode": "99999999",
      "CheckInDate": "2030-06-01",
      "CheckOutDate": "2030-06-05",
      "ClientReferenceNumber": "CLIENT-EXAMPLE-001"
    }
  ]
}

Örnek veri notu: Bu yanıttaki tüm değerler sentetik ve açıklama amaçlıdır. HotelCode, belgelenen alan tipi için sayısal bir string olarak gösterilmiştir. Bu değerleri canlı rezervasyon veya müşteri verisi olarak kopyalamayın.

Response Parametreleri

Parametre	Tip	Açıklama
Status	object	Response status
Status.Code	integer	API durum kodu
Status.Description	string	Response açıklaması
BookingDetail	object list	Eşleşen rezervasyon satırları
BookingDetail[].Index	integer	Satır index'i
BookingDetail[].BookingId	string	Rezervasyon tanımlayıcısı
BookingDetail[].ConfirmationNo	string	Onay numarası
BookingDetail[].BookingDate	string	Rezervasyon işlem tarihi
BookingDetail[].Currency	string	Rezervasyon para birimi
BookingDetail[].AgencyName	string	Varsa acente adı
BookingDetail[].BookingPrice	string	Varsa rezervasyon tutarı
BookingDetail[].TripName	string	Varsa gezi adı
BookingDetail[].HotelCode	string	MescoGo otel kodu
BookingDetail[].CheckInDate	string	Konaklama başlangıç tarihi
BookingDetail[].CheckOutDate	string	Konaklama bitiş tarihi
BookingDetail[].ClientReferenceNumber	string	Varsa müşteri referansı

Hata Durumları

FromDate veya ToDate boş ya da YYYY-MM-DD formatında değilse API HTTP 200 ile aşağıdaki payload'u döner:

{
  "StatusCode": 500,
  "Message": "FromDate and ToDate Field Format should be YYYY-MM-DD",
  "Error": "Error"
}

List/search işleminin bir bölümü başarısız olursa response başarıyla işlenen satırları içerebilir.

Kullanılabilir response hazırlanmadan işlem başarısız olursa API HTTP 200 ile aşağıdaki payload'u döner:

{
  "StatusCode": 500,
  "Message": "An error occurred during processing",
  "Error": "An error occurred during processing"
}

Erişim kapsamı veya yetkilendirme hatası, HTTP durumu 200 kalırken gövde içinde StatusCode 403 gibi bir değerle dönebilir. HTTP durumunu ve gövde alanlarını birlikte işleyin. BookingDate dd.MM.yyyy formatında döner; konaklama tarihleri booking verisinde bulunan tarih formatını kullanır.