REST API Method: bookings/fetch-details

URL

http://api.bookingmarkets.com/bookings/fetch-details?api_key=your_key

Formats:

• xml
• json

HTTP Method(s):

• POST
• GET (maximum of 2048 characters) 

Requires Authentication:

true

API rate limited:

false

Parameters:

• listing token="XXX". Required. Identifies the listing for which the booking is being fetched. Hosts can get the tokens for their listings by visiting the URL /tokens in any of the sites powered by the BookingMarkets Engine (for example: http://localo.com/tokens). For testing purposes you can use the listingtoken czY2YnRPa0JFOE9QTXJpVU9ma0dWQT09.
• booking id="XXX". Required. Identifies the booking being fetched. You can get a list of confirmed bookings that haven't been fetched yet using the bookings/fetech-new-confirmed method.

Response

• ok. The request was successfully processed.
  • timestamp. Timestamp of the transaction in UnixTime (GMT).
  • booking id. Identifies the booking being fetched.
    • arrival. Date of arrival, YYYY-MM-DD format.
    • departure. Date of departure, YYYY-MM-DD format.
    • numberofguests. Number of guests for this booking. Includes both adults and children.
    • currency. The currency in which the booking was made following the ISO 4217 standard.
    • totalcost. The total price for all units for all nights combined for all guests. Includes all taxes, mandatory fees, and expected gratuity). Doesn't include deposit.
    • deposit. Security deposit refunded to the traveller after departure or when cancelling the booking.
    • advancedpayment. Portion of the totalcost to be paid in advanced for securing this booking.
    • hostremarks. Remarks regarding this booking supplied by the host.
    • guestremarks. Remarks regarding this booking supplied by the traveller.
    • guestname. Name of the guest as provided by the person that created the booking.
    • guestemail. Email address of the guest. The value will be empty if there isn't an available email address.
    • guestphonenumber. Phone number of the guest including country code.
    • status. 1 = Pending confirmation number. 2 = Confirmed. 3 = Cancelled by the BookingMarkets Engine. 4 = Cancelled by host.
    • confirmationnumber. Confirmation number provided by the lodging.  The value will be empty if a confirmation number wasn't provided (even if the booking has been confirmed).
    • unittype id. Multiple occurences possible. One entry for every guest unit booked. If the booking includes two or more guest units of the same type, identical ids will be returned.
      • namelatinchar.  The name of the unit type in latin characters.
      • namenonlatinchar. The name of the unit type in non-latin characters. Only available in listings from countries with official languages that use non-latin characters (for example: China). The value will be empty if there isn't a non-latin name.
• error. The request wasn't successfully processed.
  • errorcode. Error code.
  • errormessage. Error message explaining the issue.

Examples

Request (XML):

Successful Response:

Failed Response:

Sandbox

You can test your application using the following test listing:

• Public listing: BookingMarkets APIs Test Listing in LetMeGo.
• Listing token: czY2YnRPa0JFOE9QTXJpVU9ma0dWQT09
• Booking id: 2127

Have questions or need help? We are eager to help. Contact us!