Arrivals board

POST

/v1/functions/hospitality.function.arrivals_board/invoke

curl --request POST \
  --url https://api.aerandil.com/v1/functions/hospitality.function.arrivals_board/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "params": { "date": "2026-04-15" }, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

The house’s arrivals for a date as Ithaca’s arrivals board reads them: every reservation arriving that day that is confirmed, held, modified or already in house. date defaults to the house’s hotel date (hotel_date). Per arrival: the reservation and its confirmation number, its status, the guest (guest_id, guest_name), the stay’s dates and party, any special requests, has_special_request (true when the stay carries a request, whether or not this reader may see the text, which is health-marked), the deposit required and paid, and readiness: unassigned when a room leg has no room, not_ready when no assigned room can take the guest yet, ready when one can, in_house once checked in. Per live room leg in rooms: its id (the target assign_room_for_reservation_room and room_candidates take), the booked room type, and once assigned the room with its number, housekeeping status and occupancy, any status block its window meets, and ready: clean or inspected, vacant, and not out of order for the stay. Ordered as the desk works it: unassigned, then not ready, then ready, then in house, by guest within each. Guest names are personal data: a reader not cleared for them gets the rows without them. Read-only.

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.arrivals_board:invoke

Request Body^required

Media typeapplication/json

object

params

required

object

date

The arrival date to read; the house's hotel date when omitted

string format: date

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.property

Responses

200

Function invoked. The body carries the typed return_value shaped by the function’s declared return_type.

Media typeapplication/json

InvokeFunctionResponse

Envelope returned by the Aerandil function engine. correlation_id is the per-invocation id for trace stitching; return_value is the typed value the function computed (shape declared by the function’s return_type).

object

correlation_id

required

Per-invocation correlation id; appears on log/trace records this function emitted.

string format: uuid

return_value

required

object

arrivals

required

Array<object>

object

adults

integer

arrival_date

string format: date

children

integer

confirmation_number

string

departure_date

string format: date

deposit_paid_amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

deposit_required_amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

guest_id

string format: uuid

guest_name

string

has_special_request

required

boolean

readiness

required

string

Allowed values: unassigned not_ready ready in_house

reservation_id

required

string format: uuid

rooms

required

Array<object>

object

block

string

Allowed values: out_of_order out_of_service

housekeeping_status

string

occupancy

string

ready

required

boolean

reservation_room_id

required

string format: uuid

room_id

string format: uuid

room_number

string

room_type_code

string

room_type_id

string format: uuid

special_requests

string

status

required

string

date

required

string format: date

Example

{
  "return_value": {
    "arrivals": [
      {
        "readiness": "unassigned",
        "rooms": [
          {
            "block": "out_of_order"
          }
        ]
      }
    ]
  }
}

Headers

Cache-Control

string

Always no-store — function results are time-sensitive and never cacheable.

404

Function or target object not found.

422

Parameter validation or domain-rule violation.