Offer stay

POST

/v1/actions/hospitality.action.offer_stay/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.offer_stay/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "adults": 1, "arrival_date": "2026-04-15", "departure_date": "2026-04-15", "offered_at": "2026-04-15T12:00:00Z", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "session_id": "example", "source": "direct_web", "visitor_id": "example" }, "return_modified": false }'

• Production API

Quote a shopper one room type on one rate plan for a stay and keep the offer — the look a regret is derived from. Priced by the admission gate create_reservation runs and quote_stay reads: refused, with the action’s own refusal verbatim, when the stay could not be booked on the grid; kept with the arrival night’s published rate and the stay total when it could. The first offer of a shopper’s visit opens a session named by its own id; pass that session_id on every later offer of the visit and on the booking, which links to it. visitor_id is the key the house issued for the browser on an earlier visit; omitted, the house issues one — the session’s id. A session that books nothing is a regret (regret_record), never recorded as one. A search stays the read quote_stay is. Holds no inventory.

Effects: create hospitality.stay_offer; link hospitality.link.stay_offer_for_property; link hospitality.link.stay_offer_for_room_type; link hospitality.link.stay_offer_for_rate_plan.

Authorizations

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

adults

required

Adults — the occupancy the grid is priced at

integer

arrival_date

required

Arrival

string format: date

departure_date

required

Departure (the arrival date for a day-use slot)

string format: date

offered_at

When the shopper was quoted (defaults to now; must not be in the future)

string format: date-time

property_id

required

The house quoting

string format: uuid

rate_plan_id

required

Rate plan offered

string format: uuid

room_type_id

required

Room type offered

string format: uuid

session_id

The visit's session — its first offer's id; omit to open one

string

source

Channel the shopper came through (defaults to direct_web)

string

Allowed values: direct_web direct_call property_direct ota gds wholesale corporate walk_in group_block agent loyalty

visitor_id

The key the house issued for this browser; omit to be issued one

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

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.stay_offer_for_property hospitality.link.stay_offer_for_room_type hospitality.link.stay_offer_for_rate_plan

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

object_type

required

Allowed values: hospitality.stay_offer

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.