Set availability

POST

/v1/actions/hospitality.action.set_availability/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_availability/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "days_of_week": [ "monday" ], "end_date": "2026-04-15", "oversell_ceiling": 1, "oversell_limit": 1, "physical": 1, "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sellable": 1, "sold": 1, "start_date": "2026-04-15" }, "return_modified": false }'

• Production API

Author the inventory ledger for a (property, room_type) pair over a date range, optionally masked to days of the week. Upserts the canonical availability_day rows: an existing row’s physical / sellable / oversell_limit are re-set in place with its sold count untouched (the booking flow owns sold); a missing row is minted with sold from the optional sold parameter (default 0 — pass it only when seeding a ledger under bookings that already exist). The availability_day validator enforces sellable <= physical and 0 <= sold <= sellable + oversell_limit on every write either way. This is the operator’s declaration: oversell_limit is written as the limit in force and as declared_oversell_limit (what a sell-limit recommendation’s reset restores), replacing any applied recommendation’s limit, and oversell_ceiling — the most headroom a recommendation may set — with it; an omitted one clears, as the call states the whole cell.

Effects: create hospitality.availability_day; modify hospitality.availability_day; link hospitality.link.property_has_availability_day; link hospitality.link.room_type_has_availability_day.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.set_availability: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

days_of_week

Days of week the pattern applies to (defaults to all seven)

Array<string>

Allowed values: monday tuesday wednesday thursday friday saturday sunday

end_date

required

End date (inclusive)

string format: date

oversell_ceiling

Oversell ceiling

The most oversell headroom a sell-limit recommendation may set (the guardrail; omitted, the declared oversell_limit is the ceiling)

integer

oversell_limit

Oversell headroom above sellable

integer

physical

required

Physical room count

integer

property_id

required

Property

string format: uuid

room_type_id

required

Room type

string format: uuid

sellable

required

Sellable room count

integer

sold

Initial sold count for rows this call mints (default 0; existing rows keep their own)

integer

start_date

required

Start date

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

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.property_has_availability_day hospitality.link.room_type_has_availability_day

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.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.property_has_availability_day"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.availability_day"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.