Get Bookings

Last Update Date	13.07.2023

Request Url

http://api.stage.paximum.com/v1/booking/getbookings

Request Model

Attribute	Type	Required	Description
From	DateTime	No	Booking createtion from date
To	DateTime	No	Booking createtion to date
CheckInFrom	DateTime	No	Booking checkin from date
CheckInTo	DateTime	No	Booking checkin to date
AgencyReferenceNumber	String	No	Your reference number
GetAllBookingsOfUserAccount	Bool	No	Send true for get all bookings of user account

Request Samples

{
  "from":"2023-07-13",
  "to":"2023-07-14",
  "GetAllBookingsOfUserAccount": true
}

{
  "checkinfrom":"2016-10-01",
  "checkinto":"2016-11-08",
  "GetAllBookingsOfUserAccount": false
}

{
  "agencyReferenceNumber":"d546d4fdsf6"
}

Response Model

Attribute	Type	Description
Bookings	Array (Object)	Requested bookings
Attribute Type Description BookingId String Booking Id Creation Datetime Booking creation date CheckIn DateTime Booking checkin date CheckOut DateTime Booking checkout date Amount Object Booking price Attribute Type Description Amount Decimal Price amount Currency String Price currency Status String Bookig status(Confirmed,OnRequest,Rejected,Cancelled,Pending) Notes Array (String) Service provider notes OrderNumber String BookingNumber String HotelId String Nationality String CancellationPolicy Object Booking cancellation policy Attribute Type Description PermitedDate String Penalty start date Fee Object Penalty Fee Attribute Type Description Amount Decimal Currency String

Response Sample

{
    "bookings": [
        {
            "bookingId": "58a47e23-8e35-4f3b-b7d9-be69e6315cb2",
            "creation": "2023-07-13T13:05:08.971Z",
            "checkin": "2023-09-02T00:00:00Z",
            "checkout": "2023-09-03T00:00:00Z",
            "amount": {
                "amount": 104.1433,
                "currency": "EUR"
            },
            "status": "Confirmed",
            "notes": [
                "This rate is not applicable to United Arab Emirates market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival.  Estimated total amount of taxes & fees for this booking:20.00 Utd. Arab Emir. Dirham payable on arrival.  Car park YES (With additional debit notes).Check-in hour 14:00-05:30.Children get free accommodation, meals payable on the spot 0 11.Identification card at arrival.Children share the bed with parents 1.Deposit on arrival.",
                "Conditions:",
                "1. If you have any active booking or cancelled and rebook with new price hotel will not confirm the last booking (TR: Aynı otelde aktif yada iptal edilip yeni fiyatla tekrar yapılan rezervasyon olması durumunda konfirme edilmeyecektir)",
                "2. Late Check-in. Some hotels do not have 24 hour reception service. If you are going to arrive to property after 08:00 pm or later please contact to hotel and inform them your arrival time. In case you'll arrive to hotel after midnight and didn't inform hotel could result cancelling your room by hotel and no-show.",
                "3. Requests. Bedding types for Double/Twin rooms, Specific room types cannot be guaranteed and are subject to availability at the time of check in. Extra bed depends on bedding type or condition of the hotel , there will be an additional charge for extra beds.",
                "4. Hotel surcharges. Resort fees, city taxes or any other surcharges due to the country regulations must be paid to the hotel directly. Our agency is not responsible for any extra hotel fees.",
                "5. Early check in & Late Check out. Hotels in general check the guests in to property after 02:00 pm and Check Out could be latest 11:00 am.  Hotel could charge extra for the special requests."
            ],
            "orderNumber": "148471",
            "bookingNumber": "158725",
            "hotelId": "326105",
            "boardCategories": [
                "Breakfast"
            ],
            "cancellationPolicies": [
                {
                    "permittedDate": "2023-08-29T10:00:00Z",
                    "feeType": "Amount",
                    "fee": {
                        "amount": 104.1433,
                        "currency": "EUR"
                    }
                }
            ],
            "nationality": "DE"
        }
    ]
}