Skip to content

What-if Waitlist reservation request (rollup delta)

POST
/v1/actions/hospitality.action.waitlist_reservation_request/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.waitlist_reservation_request/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "adults": 1, "arrival_date": "2026-04-15", "children": 1, "departure_date": "2026-04-15", "guest_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "priority": "high", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quoted_rate": { "amount": "example", "currency": "example" }, "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "sold_out", "requested_at": "2026-04-15T12:00:00Z", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "telephone": "example" }, "return_modified": false }'

What-if projection of apply_hospitality_action_waitlist_reservation_request — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.waitlist_reservation_request:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
adults
required
Adults
integer
arrival_date
required
Requested arrival
string format: date
children
Children
integer
departure_date
required
Requested departure
string format: date
guest_id
required
Guest
string format: uuid
notes
Desk notes on the request
string
priority
Priority tier (defaults to normal; FIFO applies within a tier)
string
Allowed values: high normal low
property_id
required
Property
string format: uuid
quoted_rate
Rate quoted when the request was taken (indicative only)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
rate_plan_id
required
Rate plan quoted against
string format: uuid
reason
required
Why the request could not be booked
string
Allowed values: sold_out room_type_unavailable rate_unavailable restriction guest_request
requested_at
When the guest asked (defaults to now; must not be in the future)
string format: date-time
room_type_id
required
Room type asked for
string format: uuid
telephone
Number to call when the room frees
string
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json
object
daily_rooms
required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>
object
business_date
required
string format: date
currency

ISO 4217, when the fold observed one.

string
property_id
required
string format: uuid
rooms_revenue_net_delta
required

Decimal, net rooms revenue delta.

string
rooms_sold_delta
required
integer format: int64
total_revenue_net_delta
required

Decimal, net total revenue delta.

string
Examplegenerated
{
"daily_rooms": [
{
"business_date": "2026-04-15",
"currency": "example",
"property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"rooms_revenue_net_delta": "example",
"rooms_sold_delta": 1,
"total_revenue_net_delta": "example"
}
]
}
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

Validation error — the apply would be rejected.