How to Retrieve Resort Booking Details
After creating a booking, you can retrieve its full details at any time using the booking reference number. This endpoint returns comprehensive information including the booking status, fare breakdown, traveler details, property information, and property policies.
Endpoint
GET {{apihost}}/resorts/api/v2/booking/{referencenumber}
Required Headers
| Header | Value | Required |
|---|
x-api-key | Your API key | Yes |
x-correlation-id | Unique correlation identifier | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|
reference_number | string | Yes | The booking reference number returned when the booking was created |
Example Request
GET {{api_host}}/resorts/api/v2/booking/XRN-2026040100123
Example Response
JSON
{
"status": 200,
"data": {
"booking_status": "CONFIRMED",
"booking_date": "2026-03-15T14:30:00Z",
"checkin_date": "2026-04-01",
"checkout_date": "2026-04-07",
"checkin_time": "16:00",
"checkout_time": "11:00",
"fare_breakup": {
"base_rate": 245,
"taxesandfees": 38.5,
"total_rate": 1710,
"currency": "USD",
"published_price": 1850
},
"traveler_details": {
"first_name": "Jane",
"middle_name": "",
"last_name": "Doe",
"email": "guest@example.com",
"phone": "+1-555-123-4567",
"address": "456 Palm Avenue",
"city": "Los Angeles",
"state": "CA",
"zip_code": "90001",
"country": "US"
},
"property_details": {
"name": "Oceanfront Paradise Resort & Spa",
"address": {
"line_1": "100 Beachfront Drive",
"city": "Kailua-Kona",
"state": "HI",
"country": "US",
"postal_code": "96740"
},
"urgent_info": {
"mandatory_fees": [
{
"description": "Resort fee",
"amount": 25,
"currency": "USD",
"frequency": "per night"
}
],
"policy_restrictions": {
"pets": "No pets allowed.",
"smoking": "Non-smoking property. Smoking is prohibited in all rooms and common areas.",
"minimum_age": 21,
"resort_fees": "A mandatory resort fee of $25.00 per night is charged at check-in. This fee covers pool access, Wi-Fi, and fitness center."
}
}
}
}
}
Response Fields
Top-Level Booking Fields
| Field | Type | Description |
|---|
bookingstatus | string | Current status of the booking (e.g., HOLD, CONFIRMED, RELEASED) |
bookingdate | string | ISO 8601 timestamp of when the booking was created |
checkindate | string | Check-in date |
checkoutdate | string | Check-out date |
checkintime | string | Check-in time (24-hour format) |
checkouttime | string | Check-out time (24-hour format) |
fare_breakup
| Field | Type | Description |
|---|
baserate | number | Nightly base rate |
taxesandfees | number | Total taxes and fees for the stay |
totalrate | number | Total cost for the entire stay |
currency | string | Currency code |
published_price | number | Original published rack rate |
traveler_details
| Field | Type | Description |
|---|
firstname | string | Guest's first name |
middlename | string | Guest's middle name |
lastname | string | Guest's last name |
email | string | Guest's email address |
phone | string | Guest's phone number |
address | string | Guest's street address |
city | string | Guest's city |
state | string | Guest's state or province |
zipcode | string | Guest's postal code |
country | string | Guest's country code |
property_details
| Field | Type | Description |
|---|
name | string | Name of the resort property |
address | object | Full property address |
propertydetails.urgentinfo
This section contains critical information that should be surfaced to the guest before or at check-in.
mandatory_fees
An array of fees charged at the property, not included in the booking rate.
| Field | Type | Description |
|---|
description | string | Description of the fee |
amount | number | Fee amount |
currency | string | Currency code |
frequency | string | How often the fee is charged (e.g., "per night", "per stay") |
policy_restrictions
| Field | Type | Description |
|---|
pets | string | Pet policy description |
smoking | string | Smoking policy description |
minimumage | number | Minimum age requirement for check-in |
resortfees | string | Detailed description of mandatory resort fees |
Use Cases
- Booking confirmation page — Display the full booking summary after a successful booking.
- Booking management — Let guests view their upcoming reservation details.
- Pre-arrival communication — Surface check-in times, mandatory fees, and policy restrictions before the guest arrives.
- Status tracking — Monitor booking status changes over time.
Best Practices
- Surface urgent info prominently — Mandatory fees and policy restrictions under
urgent_info are critical for guest expectations. Display these clearly in confirmation emails and booking detail pages. - Highlight mandatory fees — Resort fees and other mandatory charges are often not included in the booking rate. Make sure guests understand the total cost of their stay.
- Display check-in/out times — Show both the date and time for check-in and check-out to help guests plan their arrival and departure.
