Recommend sell limit

POST

/v1/actions/hospitality.action.recommend_sell_limit/apply

const url = 'https://api.aerandil.com/v1/actions/hospitality.action.recommend_sell_limit/apply';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"cadence":"nightly","confidence":"low","confidence_score":"example","end_date":"2026-04-15","expected_walks":"example","expires_at":"2026-04-15T12:00:00Z","expires_on":"2026-04-15","factors_considered":["pickup_pace"],"forecast_snapshot":{},"marginal_rate":{"amount":"example","currency":"example"},"oversell_limit":1,"rationale_text":"example","reset":true,"room_type_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","rooms_on_books":1,"run_id":"example","show_rate":"example","start_date":"2026-04-15","target_horizon_days":1,"walk_cost":{"amount":"example","currency":"example"}},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.property"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.recommend_sell_limit/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "cadence": "nightly", "confidence": "low", "confidence_score": "example", "end_date": "2026-04-15", "expected_walks": "example", "expires_at": "2026-04-15T12:00:00Z", "expires_on": "2026-04-15", "factors_considered": [ "pickup_pace" ], "forecast_snapshot": {}, "marginal_rate": { "amount": "example", "currency": "example" }, "oversell_limit": 1, "rationale_text": "example", "reset": true, "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rooms_on_books": 1, "run_id": "example", "show_rate": "example", "start_date": "2026-04-15", "target_horizon_days": 1, "walk_cost": { "amount": "example", "currency": "example" } }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Emit a typed overbooking recommendation against the target property: for one room type over start_date..=end_date, the oversell headroom it may sell past its sellable rooms (oversell_limit, at least 0), or reset — the explicit return to the operator’s declared limit. Exactly one of the two: a recommendation states the limit, absence never means reset. The reading behind it — the rooms on the books, the share believed to arrive, the walk cost and the marginal rate the limit balances, the walks expected at it — and the forecast snapshot are frozen at issue as a sell_limit_recommendation in suggested state; a still-suggested prior for the same room type and range is superseded. Decision lifecycle flows through apply_sell_limit_recommendation / reject_sell_limit_recommendation / expire_sell_limit_recommendations. Joins an in-progress rate_recommendation_run when run_id is given and opens one otherwise.

Effects: create hospitality.sell_limit_recommendation; modify hospitality.sell_limit_recommendation; create hospitality.rate_recommendation_run; modify hospitality.rate_recommendation_run; link hospitality.link.sell_limit_recommendation_for_room_type; link hospitality.link.sell_limit_recommendation_at_property; link hospitality.link.sell_limit_recommendation_part_of_run; link hospitality.link.run_for_property; link hospitality.link.sell_limit_recommendation_superseded_by.

Authorizations

aerandil_oauth
actions:apply
aerandil_oauth
actions:hospitality.action.recommend_sell_limit:apply

Request Body^required

application/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

cadence

Run cadence (used only when opening a fresh run)

string

Allowed values: nightly intraday hourly event_triggered manual

confidence

required

Confidence ordinal

string

Allowed values: low medium high

confidence_score

Calibrated probability (optional)

string format: decimal

end_date

required

Last night (inclusive)

string format: date

expected_walks

Expected walks

Guests expected to be walked on the first night at the limit

string format: decimal

expires_at

Recommendation expiry (default: issued_at + 4h when absent)

string format: date-time

expires_on

The house business day the recommendation lapses after, in place of `expires_at`: the house's open business date decides expiry, not the wall clock, so a day's recommendations apply on that business day however late it closes

string format: date

factors_considered

required

Signals that drove the recommendation

Array<string>

Allowed values: pickup_pace booking_curve competitive_set event_calendar historical_pattern segment_mix channel_mix length_of_stay_distribution cancellation_rate no_show_rate package_attachment group_displacement weather other

forecast_snapshot

required

Forecast snapshot (struct as JSON; `forecast_kind` and `as_of` required)

object

key

additional properties

any

marginal_rate

Marginal rate

The nightly rate one more sale on the first night would earn

object

amount

required

string format: decimal

currency

required

string format: iso-4217

oversell_limit

Oversell limit

Recommended oversell headroom over the sellable rooms (rooms, at least 0); exclusive with reset

integer

rationale_text

required

Human-readable explanation

string

reset

Reset

Recommend returning to the operator’s declared limit; exclusive with oversell_limit (defaults to false)

boolean

room_type_id

required

Room type

The room type whose availability ledger the limit would move

string format: uuid

rooms_on_books

Rooms on books

Rooms of the type on the books for the first night, at issue time

integer

run_id

Existing run to append to (handler opens one when absent)

string

show_rate

Show rate

Share of the rooms on the books believed to arrive (0..=1)

string format: decimal

start_date

required

First night

string format: date

target_horizon_days

Forecast horizon the run looked over (used only when opening a run)

integer

walk_cost

Walk cost

What walking one arriving guest is believed to cost, past the night’s own revenue

object

amount

required

string format: decimal

currency

required

string format: iso-4217

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

required

string format: uuid

object_type

required

Allowed value: hospitality.property

Responses

200

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

application/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.sell_limit_recommendation_for_room_type hospitality.link.sell_limit_recommendation_at_property hospitality.link.sell_limit_recommendation_part_of_run hospitality.link.run_for_property hospitality.link.sell_limit_recommendation_superseded_by

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

required

string format: uuid

kind

required

Allowed values: created modified

object_type

required

Allowed values: hospitality.sell_limit_recommendation hospitality.rate_recommendation_run

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.

Recommend sell limit

Authorizations

Request Bodyrequired

Responses

200

Example

409

422

Request Body^required