CheckAvail

Verify room availability and confirm pricing before booking to prevent inventory and price changes.

This endpoint performs a critical pre-booking validation step to ensure the selected room
rate package is still available and the price hasn't changed since HotelRates was called.
It's essential for preventing booking failures and price discrepancies.

Critical Usage Timing:
MUST be called after HotelRates when user selects a specific rate package for booking.
This step is mandatory to prevent:

Room inventory depletion between search and booking

Price changes that could affect booking decisions

Booking failures due to rate package unavailability

Required Parameters:

ratePkgId: The specific rate package ID selected from HotelRates response

sessionId (in Header): The session ID for tracking the booking process

Response Features:

Confirmed availability status

Final pricing information

Updated rate package details

Smart booking fallback options (R2 candidates)

Error Handling:

Returns ARIChangedErr if inventory or price has changed

Provides updated pricing information when changes occur

Enables smart booking fallback to alternative suppliers

Booking Flow Integration:

Call HotelRates to get available room options

User selects a specific rate package

Call CheckAvail to verify selection ← This step

Proceed with booking if availability confirmed

Handle ARIChangedErr if changes detected

Common Use Cases:

Pre-booking availability confirmation

Final price verification before payment

Smart booking fallback preparation

Inventory change detection

curl --location --request POST 'https://api-test.hotelbyte.com/api/search/checkAvail' \ --header 'Client-Request-Timestamp;' \ --header 'Currency;' \ --header 'IP;' \ --header 'Language;' \ --header 'Request-Id;' \ --header 'Session-Id;' \ --header 'Test;' \ --header 'Timeout-Milliseconds;' \ --header 'Trace-Id;' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data-raw '{ "ratePkgId": "string" }'

{ "code": 0, "msg": "string", "data": { "status": 1, "roomRatePkg": { "ratePkgId": "string", "refundableMode": "full", "refundableUntil": "2006-01-02T15:04:05Z07:00", "cancelFees": [ { "until": "2006-01-02T15:04:05Z07:00", "fee": { "currency": "string", "amount": 0 } } ], "originalRoomNaming": { "id": "string", "name": "string", "supplier": 0 }, "rate": { "commissionableRate": { "currency": "string", "amount": 0 }, "netRate": { "currency": "string", "amount": 0 }, "grossRate": { "currency": "string", "amount": 0 }, "respectGrossRate": true }, "totalRate": { "commissionableRate": { "currency": "string", "amount": 0 }, "netRate": { "currency": "string", "amount": 0 }, "grossRate": { "currency": "string", "amount": 0 }, "respectGrossRate": true }, "rateComment": "string", "includesPackaging": true, "checkIn": "now()", "checkOut": "now()+7", "board": { "boardId": "RO", "boardName": { "en": "string", "zh": "string", "ar": "string" }, "boardDesc": { "en": "string", "zh": "string", "ar": "string" } }, "tax": { "total": { "currency": "string", "amount": 0 }, "items": [ { "taxType": "string", "taxName": "string", "amount": { "currency": "string", "amount": 0 }, "desc": "string" } ] } } } }

Request

Responses