Booking List API

This method queries bookings by stay date, creation date, booking reference, or guest email.

Booking list uses the request and response shape described below. Date filters are applied to booking and stay-date fields. bookingReferenceID is matched against the references available for a booking. If emailId is sent, it filters the returned booking data when an email is available. Pagination is applied to the available result set; limit and page define the requested page size and page number.

Endpoint

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

Property	Value
URI	{BaseURL}/api/booking/book-list
Method	POST
Content-Type	application/json

Authorization

Send the Basic Auth header described in Authentication.

Request Parameters

Parameter	Type	Description
FromDate	string	Stay start date filter. Format: YYYY-MM-DD. Required with ToDate.
ToDate	string	Stay end date filter. Format: YYYY-MM-DD. Required with FromDate.
CreatedFrom	string	Optional booking creation start date filter. Format: YYYY-MM-DD.
CreatedTo	string	Optional booking creation end date filter. Format: YYYY-MM-DD.
bookingReferenceID	string	Optional booking reference filter. It can be a booking identifier, confirmation number, or reference supplied by your system. Keep the exact property casing shown here.
emailId	string	Optional guest email filter. Keep the exact property casing shown here.
limit	integer	Records per page when pagination is used. Default: 10.
page	integer	Page number for the paginated booking list. Default: 1.

bookingReferenceID can be sent as a booking identifier, confirmation number, or client-system reference.

Authorization

This endpoint requires a Basic Authorization header, using the same API client credentials as the other booking endpoints.

Example Request

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

Example data note: The dates and empty filters above are synthetic and illustrative. Do not copy them as live booking data.

Successful 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"
    }
  ]
}

Example data note: All values in this response are synthetic and illustrative. HotelCode is shown as a numeric string for the documented field type. Do not copy these values as live booking or customer data.

Response Parameters

Parameter	Type	Description
Status	object	Response status
Status.Code	integer	API status code
Status.Description	string	Response description
BookingDetail	object list	Matching booking rows
BookingDetail[].Index	integer	Row index
BookingDetail[].BookingId	string	Booking identifier
BookingDetail[].ConfirmationNo	string	Confirmation number
BookingDetail[].BookingDate	string	Booking process date
BookingDetail[].Currency	string	Booking currency
BookingDetail[].AgencyName	string	Agency name when available
BookingDetail[].BookingPrice	string	Booking price when available
BookingDetail[].TripName	string	Trip name when available
BookingDetail[].HotelCode	string	MescoGo hotel code
BookingDetail[].CheckInDate	string	Stay start date
BookingDetail[].CheckOutDate	string	Stay end date
BookingDetail[].ClientReferenceNumber	string	Client reference when available

Error Cases

If FromDate or ToDate is empty or not in YYYY-MM-DD format, the API returns HTTP 200 with the payload below:

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

If a list/search request fails for part of the available result set, the response can still include rows that were processed successfully.

When processing fails before a usable response can be prepared, the API returns HTTP 200 with:

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

An access-scope or authorization failure can also be represented by a body-level StatusCode such as 403, while the HTTP status remains 200. Handle the HTTP status and the body fields together. BookingDate is formatted as dd.MM.yyyy; stay dates are returned in the date format supplied by the booking data.