edit

Check Bookings

Introduction

Check bookings placed between two dates and by their status.

Definition

1
POST https://api.ratemarkt.com/v1/checkbookings

Query Object

Argument Type Required Description
fromDate string yes YYYY-MM-DD (ISO 8601) formatted date string. Eg. 2017-11-12
toDate string yes YYYY-MM-DD (ISO 8601) formatted date string. Eg. 2017-11-12
status string no If not provided all statuses will be retrieved. Possible values are CONFIRMED, CANCELLED and FAILED

Duration between dates

Duration between fromDate to toDate is restricted to 30 days at maximum.

Example Query Object

1
2
3
4
5
{
    "fromDate": "2018-01-01",
    "toDate": "2018-01-10",
    "status": "CONFIRMED"
}

Result Object

Result Object Hint

While Book Rate resource returns a Booking object, this resource also returns exactly the same Booking object as list.

So you may want to reuse the same json parser logic in your client application.

Argument Type Nullable Description
bookings list[Booking] no List of Booking objects.
Booking.status string no Flag indicating the current status of the booking. Available values are:
  • CONFIRMED: Booking confirmed and payment processed successfully.
  • FAILED: Booking failed because of an error.
  • CANCELED: Booking cancelled successfully.
Booking.bookingRef string no Unique booking identifier
Booking.clientRef string no Unique booking identifier issued by the client
Booking.rateKey string no Unique rate identifier
Booking.hotelCode string no Unique hotel identifier
Booking.hotelName string no Hotel name
Booking.destinationCode string no Unique destination identifier
Booking.destinationName string no Destination name
Booking.countryCode string no Two letter country code (ISO 3166-1 alpha-2)
Booking.checkin string no YYYY-MM-DD (ISO 8601) formatted date string. Eg. 2017-11-12
Booking.checkout string no YYYY-MM-DD (ISO 8601) formatted date string. Eg. 2017-11-12
Booking.holder object[Holder] no Holder object contains information who places the booking
Holder.firstName string yes Holder' s first name
Holder.lastName string yes Holder' s last name
Holder.email string no Holder' s email address
Holder.phone string no Holder' s phone number
Booking.occupancies list[Occupancy] no Occupancy object contains information of individual occupants who will accomodate in the specified room.
Occupancy.occupants list[Occupant] no List of Occupant objects contains information about personal occupant information.
Occupant.occupantType string no Occupant type. Value can be either ADULT or CHILD
Occupant.firstName string no Occupant's first name
Occupant.lastName string no Occupant's last name
Occupant.age integer no Occupant's age
room object[Room] no Room object
Room.numberOfAdults integer no Number of adults can fit into the room
Room.childrenAges integer no Children with specified ages can be accepted for this room.
Room.roomDescription integer no Room description describing the type of room.
Room.sequence integer no Identifies the selected room for specified occupants.
Booking.creationDate integer no Offset date time string in YYYY-MM-DDThh:mmTZD (ISO 8601) format indicating when the booking made.
Booking.total decimal no Total amount of booked rate in specified currency in Booking.currency field
Booking.currency string no Two letter country code (ISO 3166-1 alpha-2) of the amount for booked rate.
Booking.cancellationCost decimal yes Charged penalty amount when the booking is cancelled. If no penalty charged, this value should be 0.00
Booking.balance decimal no if booking cancelled and any penalty applied, this field indicates the final amount after the penalty amount deducted from total amount. If booking is not cancelled this field should be equal to Booking.total amount.
Booking.specialRequest string no Special requests asked by the holder
Booking.rateKey string no Unique identifier of the booked rate. Refer to Check Rate documentation for further information.
Booking.rateType string no Type of booked rate. Refer to Check Rate documentation for further information.
Booking.boardType string no Board type code of booked rate. Refer to Check Rate documentation for further information.
Booking.boardName string no Board type name of booked rate. Refer to Check Rate documentation for further information.
Booking.nonrefundable string no Flag indicating wheter the booking is refundable or not.

Refer to Check Rate documentation for further information.
Booking.cancellationPolicies list[CancellationPolicy] no List of CancellationPolicy objects.

Refer to Check Rate documentation for further information.
Booking.commission decimal yes Amount of comission specified for commissionable rates.

Refer to Check Rate documentation for further information.
Booking.hotelRate decimal yes Total amount of booking should be payed at hotel.

Refer to Check Rate documentation for further information.
Booking.hotelCurrency string yes Currency value for Booking.hotelRate.

Refer to Check Rate documentation for further information.
Booking.remarks string yes Comments from hotelier related to your booking.

Refer to Check Rate documentation for further information.

Example Result Object

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
{
    "bookings": [
        {
            "bookingRef": "4087b2",
            "status": "CONFIRMED",
            "total": 709.28,
            "currency": "USD",
            "hotelCode": "11a5e2",
            "checkin": "2018-03-21",
            "checkout": "2018-03-25",
            "holder": {
                "firstName": "John",
                "lastName": "Doe",
                "email": null,
                "phone": null
            },
            "creationDate": "2018-01-09T23:59:43.088134Z",
            "cancellationPolicies": [
                {
                    "amount": 709.28,
                    "fromDate": "2018-03-17T00:00:00Z"
                }
            ],
            "nonrefundable": false,
            "clientRef": "CRL-QZVIEFLSNRHHM4L5",
            "rateType": "NET",
            "occupancies": [
                {
                    "occupants": [
                        {
                            "occupantType": "ADULT",
                            "age": 30,
                            "firstName": "John",
                            "lastName": "Doe"
                        }
                    ],
                    "room": {
                        "numberOfAdults": 1,
                        "childrenAges": [],
                        "roomDescription": "Single",
                        "sequence": 1
                    }
                }
            ],
            "balance": 709.28,
            "boardType": "RO",
            "boardName": "Room Only",
            "rateKey": "[RMs|4|EUR|ca|[[1|[]]]]~[AOz-8w|EaXi|NET|0|RO|[Z3dCAQ|1|[]]]",
            "hotelName": "B Ocean Resort",
            "destinationCode": "10c967",
            "destinationName": "Fort Lauderdale",
            "countryCode": "US",
            "cancellationCost": null,
            "commission": null,
            "hotelRate": null,
            "hotelCurrency": null,
            "specialRequest": "",
            "remarks": "",
            "meta": null
        },
        {
            "bookingRef": "abbca9",
            "status": "FAILED",
            "total": 1536.35,
            "currency": "USD",
            "hotelCode": "10d1bd",
            "checkin": "2018-08-04",
            "checkout": "2018-08-09",
            "holder": {
                "firstName": "Mary",
                "lastName": "Moyes",
                "email": null,
                "phone": null
            },
            "creationDate": "2018-01-09T21:29:08.537106Z",
            "cancellationPolicies": [
                {
                    "amount": 1536.35,
                    "fromDate": "2018-01-08T21:29:08.35Z"
                }
            ],
            "nonrefundable": true,
            "clientRef": "CRL-UNONHKXF4IGSAHYL",
            "rateType": "NET",
            "occupancies": [
                {
                    "occupants": [
                        {
                            "occupantType": "ADULT",
                            "age": 30,
                            "firstName": "Diana",
                            "lastName": "Bauke"
                        },
                        {
                            "occupantType": "ADULT",
                            "age": 30,
                            "firstName": "Mary",
                            "lastName": "Moyes"
                        }
                    ],
                    "room": {
                        "numberOfAdults": 2,
                        "childrenAges": [],
                        "roomDescription": "Double",
                        "sequence": 1
                    }
                }
            ],
            "balance": 1536.35,
            "boardType": "RO",
            "boardName": "Room Only",
            "rateKey": "[RVM|5|EUR|us|[[2|[]]]]~[AOz-8w|ENG9|NET|1|RO|[98iC/A|2|[]]]",
            "hotelName": "Fraser Suites Edinburgh",
            "destinationCode": "10b373",
            "destinationName": "Edinburgh",
            "countryCode": "GB",
            "cancellationCost": null,
            "commission": null,
            "hotelRate": null,
            "hotelCurrency": null,
            "specialRequest": null,
            "remarks": "<b>Fees</b> . The following fees and deposits are charged by the property at time of service, check-in, or check-out.   Fee for continental breakfast: GBP 10.00 per person (approximately)                              The above list may not be comprehensive. Fees and deposits may not include tax and are subject to change. <b>Mandatory Fees and Taxes</b> . You'll be asked to pay the following charges at the property: Deposit: GBP 50 per stay We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book. Extra-person charges may apply and vary depending on property policy. . Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. . Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. . 1 Double Bed. 248 sq feet (23 sq meters). . <b>Internet</b> - Free WiFi .  <b>Entertainment</b> - LCD television, digital channels, and iPod dock. <b>Food & Drink</b> - Kitchenette with refrigerator, microwave, dishwasher, and cookware/dishware. <b>Sleep</b> - Egyptian cotton linens and a pillow menu . <b>Bathroom</b> - Private bathroom, designer toiletries, and a shower/tub combination with a rainfall showerhead. <b>Practical</b> - Laptop-compatible safe, iron/ironing board, and desk. <b>Comfort</b> - Daily housekeeping. Smoking/Non Smoking. &nbsp;",
            "meta": null
        },
        {
            "bookingRef": "3759a3",
            "status": "CONFIRMED",
            "total": 389.69,
            "currency": "USD",
            "hotelCode": "12052f",
            "checkin": "2018-01-15",
            "checkout": "2018-01-19",
            "holder": {
                "firstName": "Dany",
                "lastName": "Pryde",
                "email": null,
                "phone": null
            },
            "creationDate": "2018-01-09T21:14:19.298893Z",
            "cancellationPolicies": [
                {
                    "amount": 389.69,
                    "fromDate": "2018-01-11T00:00:00Z"
                }
            ],
            "nonrefundable": false,
            "clientRef": "CRL-DWKRYZLPFFBZTRUM",
            "rateType": "NET",
            "occupancies": [
                {
                    "occupants": [
                        {
                            "occupantType": "ADULT",
                            "age": 30,
                            "firstName": "Dany",
                            "lastName": "Pryde a"
                        },
                        {
                            "occupantType": "ADULT",
                            "age": 30,
                            "firstName": "Dany",
                            "lastName": "Pryde"
                        }
                    ],
                    "room": {
                        "numberOfAdults": 2,
                        "childrenAges": [],
                        "roomDescription": "Double",
                        "sequence": 1
                    }
                }
            ],
            "balance": 389.69,
            "boardType": "RO",
            "boardName": "Room Only",
            "rateKey": "[RIo|4|USD|us|[[2|[]]]]~[AOz-8w|EgUv|NET|0|RO|[98iC/A|2|[]]]",
            "hotelName": "Hilton Garden Inn Washington DC/US Capitol",
            "destinationCode": "118f52",
            "destinationName": "Washington",
            "countryCode": "US",
            "cancellationCost": null,
            "commission": null,
            "hotelRate": null,
            "hotelCurrency": null,
            "specialRequest": "",
            "remarks": "",
            "meta": null
        }
    ]
}