Set meal periods

POST

/v1/actions/hospitality.action.set_outlet_meal_periods/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_outlet_meal_periods/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "meal_periods": [ { "daypart": "breakfast", "days_of_week": [ "monday" ], "end_time": "example", "start_time": "example" } ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.outlet" } }'

• Production API

Set when each meal runs at the outlet, replacing the whole list: each period a daypart, a start_time and end_time in 24-hour HH:MM on the house’s wall clock, and optionally its days_of_week (absent = every day), so a weekday breakfast and a weekend one are two rows. An end_time before the start runs past midnight and belongs to the day it started; the same start and end is a whole day from that time. Periods may not overlap, and that is refused naming both; gaps are allowed. open_check stamps a live check with the period in force unless it is told otherwise; in a gap the check carries no meal, and none is ever refused for its hours. An empty list clears the hours. The same list again changes nothing.

Effects: modify hospitality.outlet.

Authorizations

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

meal_periods

required

The outlet's meal periods, whole; empty clears them

Array<object>

object

daypart

required

string

Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day

days_of_week

Array<string>

Allowed values: monday tuesday wednesday thursday friday saturday sunday

end_time

required

string

start_time

required

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.outlet

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

link_type

required

string

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.