Skip to content
aerandil.com
GitHub

Set rates

POST
/v1/actions/hospitality.action.set_rates/apply
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_rates/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "bar_anchor_amount": { "amount": "example", "currency": "example" }, "days_of_week": [ "monday" ], "end_date": "2026-04-15", "inclusive_of_tax": true, "occupancy": 1, "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "start_date": "2026-04-15" }, "return_modified": false }'

Author per-date prices for a (rate_plan, room_type, occupancy) tuple over a date range, optionally masked to days of the week. Upserts the canonical rate_per_night rows: an existing row for a matching (rate_plan, room_type, occupancy, date) cell is re-priced in place, a missing one is minted and linked — re-applying the same pattern is an idempotent no-op. The amount must be in the rate plan’s currency, and a bar_grid rate plan requires bar_anchor_amount (the anchor the derivation resolves against is date-varying and lives on the row).

Effects: create hospitality.rate_per_night; modify hospitality.rate_per_night; link hospitality.link.rate_plan_has_rate_per_night; link hospitality.link.room_type_has_rate_per_night.

Step-up when bar_anchor_amount is given: a person (a User principal) needs a fresh desk step-up proof — Moving the BAR anchor re-prices every rate derived from it — or the call is refused 403 step_up_required before anything runs. Re-enter the passcode at POST /v1/desk/sessions/{id}/passcode and retry. Machine principals are not gated.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
amount
required
Amount per night
object
amount
required
string format: decimal
currency
required
string format: iso-4217
bar_anchor_amount
BAR anchor (required for bar_grid rate plans)
object
amount
required
string format: decimal
currency
required
string format: iso-4217
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
inclusive_of_tax
Amount is inclusive of tax
boolean
occupancy
required
Occupancy (adult count this price applies to)
integer
property_id
required
Property the priced rows are scoped to (plans and room types can be brand-standard; prices are always per-property)
string format: uuid
rate_plan_id
required
Rate plan
string format: uuid
room_type_id
required
Room type
string format: uuid
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

Section titled “Responses”

200

Section titled “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.rate_plan_has_rate_per_night hospitality.link.room_type_has_rate_per_night
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.rate_per_night
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.rate_plan_has_rate_per_night"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.rate_per_night"
    }
  ]
}

403

Section titled “403”

step_up_required — a person applied this without a fresh desk step-up proof; nothing ran.

409

Section titled “409”

Conflict — concurrent modification or unique constraint violation.

422

Section titled “422”

Validation error — parameter validation or business-rule violation.