Stay

object
confirmation_numberstringrequired

Example:KH4DEMO01

property_codestringrequired

Example:KTNYC

statusstringrequired

pre_arrival: booked, not yet checked in. checked_in: guest is in house. checked_out: stay complete.

Allowed values:pre_arrivalchecked_inchecked_outno_showcancelled

arrival_datestring(date)
departure_datestring(date)
roomobjectrequired
Show Child Parameters
check_in_timestring

Property’s standard check-in time (local).

Example:15:00

check_out_timestring

Agreed check-out time (local), including any approved late check-out.

Example:11:00

checked_in_atstring | null(date-time)
checked_out_atstring | null(date-time)
actionsobject

What the guest can do right now. Use these instead of re-deriving the rules.

Show Child Parameters
Example

CheckInRequest

object
estimated_arrival_timestringrequired

Match pattern:^\d{2}:\d{2}$

Example:16:30

accept_termsbooleanrequired

Guest accepts the house policies.

room_preferencesarray[string]

Allowed values:high_floorlow_floorquietnear_elevatoraccessible

special_requestsstring | null

<= 500 characters

Example

CheckOutRequest

object
receipt_emailstring | null(email)

Defaults to the email on the reservation.

feedback_scoreinteger | null

>= 1<= 5

Example

LateCheckOutRequest

object
requested_timestringrequired

Match pattern:^\d{2}:\d{2}$

Example:14:00

Example

LateCheckOut

object
requested_timestring

Example:14:00

statusstring

Allowed values:pendingapproveddeclined

feeOne Of

Set once approved, if a fee applies.

Moneystring

Decimal amount in the property currency.

Match pattern:^-?\d+\.\d{2}$

Example:45.00

currencystring | null

Example:USD

Example