Search Parameters

Search parameters provided by the user during the booking process.

Example object:

{
  "checkInTime": "2022-10-27",
  "checkOutTime": "2022-10-28",
  "numAdults": 1,
  "numChildren": 3,
  "numRooms": 1,
  "promoCode": "thisIsAPromoCode"
}

checkInTime

Date of first night of the booking.

Type: string Format: YYYY-M-D

checkOutTime

Date of the day after the last night of booking.

Type: UUID Format: YYYY-M-D

numAdults

The number of adults specified in this booking.

Type: number

numChildren

The number of children specified in this booking.

Type: number

numRooms

The number of rooms specified in this booking. Defaults to 1.

Type: number

promoCode

Promotional code currently applied to the basket

Type: string