F&B room-service board

POST

/v1/functions/hospitality.function.fnb_room_service_board/invoke

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

• Production API

The target outlet’s in-room dining orders still on the dispatch sheet — every room_service check whose delivery_status is not yet cleared, a settled one whose tray is still upstairs included — ordered by promised_at (then by when it opened). checks, per order: the check (id) and its number and status (open or settled), daypart, covers, the room, the stay and its guests’ names, when it opened and was promised, where it is (delivery_status, dispatched_at, delivered_at, the runner_id and the conveyance), late (promised and passed, not yet delivered), and its total_due / balance_due in currency. Narrowed in the store to the orders on the sheet, so the board never ships the cleared history. The target is the outlet, so a till reads its own outlet’s board only. Read-only.

Authorizations

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

Request Body^required

Media typeapplication/json

object

params

required

object

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.outlet

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

checks

required

Array<object>

object

balance_due

string

conveyance

string

Allowed values: tray trolley

covers

integer

currency

string

daypart

string

Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day

delivered_at

string format: date-time

delivery_status

required

string

Allowed values: taken dispatched delivered cleared

dispatched_at

string format: date-time

guest_names

required

Array<string>

id

required

string format: uuid

late

required

boolean

number

required

string

opened_at

required

string format: date-time

promised_at

string format: date-time

room

string

runner_id

string format: uuid

status

required

string

Allowed values: open settled

stay_id

string format: uuid

total_due

string

outlet_id

required

string format: uuid

Example

{
  "return_value": {
    "checks": [
      {
        "conveyance": "tray",
        "daypart": "breakfast",
        "delivery_status": "taken",
        "status": "open"
      }
    ]
  }
}

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.