Register outlet

POST

/v1/actions/hospitality.action.register_outlet/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.register_outlet/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "code": "example", "kind": "rooms", "name": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "usali_department": "rooms", "usali_revenue_center_label": "example" }, "return_modified": false }'

• Production API

Register a revenue outlet at property_id under its code, with its name, its USALI department (usali_department) and operational kind; optionally the usali_revenue_center_label a revenue report groups it under (the name when absent). Upsert by code: the same code again restates the outlet in place (an identical restatement writes nothing; a field the call does not carry is left alone); a code already registered at another property is refused. Links the outlet to its property (outlet_at_property) on first registration. A vendor feed’s charges post into the property’s sole outlet in each USALI bucket, so a connector’s provisioning pass registers one outlet per bucket its lines can land in — rooms, food and beverage, spa, miscellaneous income, other operated — before the first folio line arrives. Emits outlet.registered.

Effects: create hospitality.outlet; modify hospitality.outlet; link hospitality.link.outlet_at_property.

Authorizations

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

code

required

The outlet's code (trimmed; the tenant-unique business key)

string

kind

required

The outlet's operational kind

string

Allowed values: rooms restaurant bar lounge room_service banquet catering spa salon wellness_program gym pool golf parking minibar retail activity tour rental business_center laundry telecom package_aggregator other

name

required

The outlet's name

string

property_id

required

The property the outlet belongs to

string format: uuid

usali_department

required

The USALI department the outlet's revenue reports under

string

Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail

usali_revenue_center_label

The revenue-centre label a report groups the outlet under (the name when absent)

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.outlet_at_property

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.outlet

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.