Find booking

POST

/v1/functions/hospitality.function.find_booking/invoke

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

• Production API

One booking at a house by its confirmation number, whatever its status: arriving, in house, departed or cancelled. An exact match, so an unknown number returns no bookings and is not an error. Each booking is the row arrivals_board shows: the reservation, its status, the guest (guest_id, guest_name), the stay’s dates and party, deposits, has_special_request, and in rooms each live leg with its id and any assigned room. readiness is present only for a stay still on the board. It carries no contact details. The number and the guest’s name are personal data: a reader not cleared for them finds nothing, however exact the number. Read-only.

Authorizations

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

Request Body^required

Media typeapplication/json

object

params

required

object

confirmation_number

required

The booking's confirmation number, exactly as it was issued

string

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

bookings

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

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

Example

{
  "return_value": {
    "bookings": [
      {
        "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.