edit

Check Booking

Introduction

Check the latest booking status at Ratemark's records by using either booking reference or client reference. You might want to use this resource to gather all the information about your booking whenever desired.

Definition

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

Query Object

Argument Type Required Description
bookingRef string optional* Unique booking identifier
clientRef string optional* Unique booking identifier defined by client

About Optional* Arguments

You should provide either bookingRef or clientRef argument to get your query work.

Example Query Object

1
2
3
{
  "bookingRef": "7616be"
}

Result Object

Result Object Hint

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

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

Argument Type Nullable Description
Result.booking object[Booking] no Booking object
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
{
  "booking": {
    "status": "CONFIRMED",
    "bookingRef": "55cda9",
    "clientRef": "qwerty123456",
    "hotelCode": "d31d12",
    "checkin": "2017-07-22",
    "checkout": "2017-07-25",
    "holder": {
      "firstName": "john",
      "lastName": "doe",
      "email": "[email protected]",
      "phone": "+415000000"
    },
    "occupancies": [
      {
        "occupants": [
          {
            "occupantType": "ADULT",
            "age": null,
            "firstName": "john",
            "lastName": "doe"
          },
          {
            "occupantType": "ADULT",
            "age": null,
            "firstName": "alice",
            "lastName": "wonder"
          }
        ],
        "room": {
          "numberOfAdults": 2,
          "childrenAges": [],
          "roomDescription": "DOUBLE DELUXE CITY VIEW",
          "sequence": 1
        }
      }
    ],
    "creationDate": "2017-05-17T12:00:00Z",
    "rateType": "NET",
    "boardType": "RO",
    "boardName": "Room Only",
    "cancellationPolicies": [
      {
        "amount": 174.13,
        "fromDate": "2017-07-19T23:59:00+03:00"
      }
    ],
    "total": 585.08,
    "currency": "EUR",
    "balance": 522.39,
    "rateKey": "[Q9k|3|USD|US|[[2|[]]]]_[AJ62Fw|ANMdEg|NET|0|Prabrg|[jVOYrg|2|0]]",
    "hotelName": "The Marmara Taksim",
    "destinationCode": "c36ca9",
    "destinationName": "istanbul",
    "countryCode": "TR",
    "nonrefundable": false,
    "cancellationCost": 0,
    "commission": null,
    "hotelRate": null,
    "hotelCurrency": null,
    "specialRequest": null,
    "remarks": "Check-in hour 15:00"
  }
}