Take room out of order

POST

/v1/actions/hospitality.action.take_room_out_of_order/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.take_room_out_of_order/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "end_date": "2026-04-15", "reason": "example", "remarks": "example", "return_status": "dirty", "start_date": "2026-04-15" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.room" } }'

• Production API

Block a room from inventory for a date window — burst pipe, refurbishment, seasonal closure. Deducts the room type’s availability ledger for the blocked dates (the booking ceiling is sellable - out_of_order + oversell_limit) and records exactly which rows it touched, so release restores exactly those; dates already sold past the reduced ceiling are reported as displaced (overbooking exposure), never silently absorbed. Refuses while a guest is (or will still be) in the room — move_room first — and reports pre-check-in assignments into the window as a work list instead of silently unassigning them (check-in refuses an out-of-order room until each is re-roomed). Overlapping active blocks refuse; extend or release the existing block instead.

Effects: create hospitality.room_status_block; link hospitality.link.room_status_block_for_room; modify hospitality.availability_day.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.take_room_out_of_order:apply

Request Body^required

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

end_date

required

Last blocked night (inclusive through-date; the night audit returns the room when this date closes)

string format: date

reason

required

Why the room is blocked

string

remarks

Repair / handover remarks

string

return_status

required

Housekeeping status the room re-enters on release

string

Allowed values: dirty pickup clean inspected

start_date

required

First blocked night

string format: date

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.room

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.room_status_block_for_room

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created modified

object_type

required

Allowed values: hospitality.room_status_block hospitality.availability_day

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.room_status_block_for_room"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.room_status_block"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.