Skip to content
aerandil.com
GitHub

Validate Add check line (dry-run)

POST
/v1/actions/hospitality.action.add_check_line/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.add_check_line/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "course_number": 1, "external_ref": "example", "fulfilled_at": "2026-04-15T12:00:00Z", "menu_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "modifiers": [ { "option_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "prefix": "no", "quantity": 1 } ], "notes": "example", "quantity": 1, "seat_number": 1, "variant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.guest_check" } }'

Dry-run of apply_hospitality_action_add_check_line’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

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
course_number
Course (defaults to the item's course_default, then its class's, then 1)
integer
external_ref
Source-system key for replayed / connector-landed lines (replay key)
string
fulfilled_at
When service completed — lands the line already fulfilled (replayed / connector-landed histories; live ordering omits it)
string format: date-time
menu_item_id
required
Menu item ordered
string format: uuid
modifiers
Options chosen: each an option_id from a group the item uses, an optional prefix (no / extra / light / side) and quantity (default 1)
Array<object>
object
option_id
required
string format: uuid
prefix
string
Allowed values: no extra light side
quantity
integer
notes
Kitchen-facing note
string
quantity
Quantity (default 1)
integer
seat_number
Seat the item is for (1–99)
integer
variant_id
Variant ordered (the 175 ml, the bottle) — omit for the item's only or default variant
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.guest_check

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}