Define stock store

POST

/v1/actions/hospitality.action.define_stock_store/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_stock_store/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allow_negative": true, "code": "example", "is_default": true, "kind": "main_store", "name": "example", "room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Define one of the house’s stock stores under its code — the stores room, a floor cupboard, the minibar cart, a room’s minibar (room_minibar, which names its room_id; one per room), the laundry, the workshop. Defining a code the house already holds re-states the store in place, so the call is replay-safe; an identical re-statement changes nothing. is_default makes it the house’s store of its kind that work draws from when it names none (a minibar task in a room with no minibar of its own, a laundry task, a fault’s material line) — the previous default of the kind stops being one. allow_negative lets its stock go below zero (an uncounted store); it cannot be switched off while a level is negative. The store is linked to its house (stock_store_at_property); re-stating a store defined before that edge existed writes it. A store is kept by the role whose store it is (2026-10-17): an engineer’s session keeps the workshop only, a housekeeping supervisor’s any store but a workshop — held to the kind the code had and the kind it is given, so neither re-kinds, defaults or loosens the other’s store (403); the desk and agents are held to none.

Effects: create hospitality.stock_store; modify hospitality.stock_store; link hospitality.link.stock_store_in_room; unlink hospitality.link.stock_store_in_room; link hospitality.link.stock_store_at_property.

Authorizations

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

allow_negative

Let its stock go below zero (defaults to false)

boolean

code

required

The house's code for the store

string

is_default

Make it the house's store of its kind that work draws from

boolean

kind

required

What kind of store it is

string

Allowed values: main_store floor_store minibar_cart room_minibar laundry workshop

name

required

The store in words

string

room_id

The room whose minibar it is (room_minibar only, and required there)

string format: uuid

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

id

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.

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 unlinked end_dated

link_type

required

Allowed values: hospitality.link.stock_store_in_room hospitality.link.stock_store_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.stock_store

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.