CheckAvail

POST /api/search/checkAvail

Re-validates a single rate package immediately before booking, confirming that the room is still sellable and that the price has not moved since HotelRates returned it.

This call is the mandatory pre-booking validation step. Skipping it exposes the booking to three failure modes:

• room inventory being consumed between the search and the booking attempt
• price movement that changes what the traveller was quoted
• outright booking failure because the rate package is no longer sellable

When to call it Call it after HotelRates, once the user has picked one specific rate package.

Inputs required

• ratePkgId (request body): the rate package identifier taken from the HotelRates response
• Session-Id (request header): identifies the session for the booking flow

What comes back

• the confirmed availability status
• the final price
• the refreshed rate package detail
• fallback candidates for smart booking (R2 candidates)

Error behaviour

• a price or inventory move is returned in-band: the room comes back AVAILABLE with the refreshed rate package and code 0, carrying a statusRemark such as "price updated by supplier revalidation"

• a rate that has gone entirely comes back UNAVAILABLE with code 0 — CheckAvail never substitutes a bare error code for the re-priced package

• the ARI-changed business code 100001111 is raised by Book, not here: it fires only when the rate moves between this call and the commit, where there is no longer a re-priced package to hand back

Position in the booking flow

1. HotelRates returns the sellable room options
2. the user picks one rate package
3. CheckAvail re-validates that pick (this endpoint)
4. booking proceeds if availability was confirmed
5. a moved price or reduced inventory is reflected in the refreshed package this call returns

Typical uses

• confirming availability ahead of booking
• final price check before taking payment
• preparing the smart-booking fallback
• detecting inventory movement

Request headers

Request body

Example request

{
  "ratePkgId": "rp_8f3c1a7e6b2d40f9a51c"
}

Response

Successful calls return the standard envelope. code is 0 on success — check it rather than the HTTP status alone, because some business failures are delivered with HTTP 200.

Example response

{
  "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": "USD",
            "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": false
      },
      "totalRate": {
        "commissionableRate": {
          "currency": "string",
          "amount": 0
        },
        "netRate": {
          "currency": "string",
          "amount": 0
        },
        "grossRate": {
          "currency": "string",
          "amount": 0
        },
        "respectGrossRate": false
      },
      "rateComment": "string",
      "includesPackaging": false,
      "checkIn": "2026-01-01",
      "checkOut": "2026-01-03",
      "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": {},
            "desc": "string"
          }
        ]
      }
    },
    "exchangeRateSnapshot": {
      "date": "string",
      "usd": {}
    }
  }
}

Failure responses

Every failure uses the { code, msg } envelope. See Error handling for the full business-code table.