Skip to content
aerandil.com
GitHub

Validate Open check (dry-run)

POST
/v1/actions/hospitality.action.open_check/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.open_check/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "covers": 1, "daypart": "breakfast", "external_ref": "example", "opened_at": "2026-04-15T12:00:00Z", "order_kind": "dine_in", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "promised_at": "2026-04-15T12:00:00Z", "server_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stay_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

Dry-run of apply_hospitality_action_open_check’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
covers
Covers seated
integer
daypart
Meal period the check rings in (the daypart a price row may be narrowed to)
string
Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day
external_ref
Source-system key for replayed / connector-landed checks (replay key)
string
opened_at
When the check opened — business time, not record time (defaults to now)
string format: date-time
order_kind
required
How the order reaches the guest
string
Allowed values: dine_in takeaway room_service delivery
outlet_id
required
Outlet the check trades under
string format: uuid
promised_at
When the in-room order is promised at the room (room_service only)
string format: date-time
server_id
Owning server
string format: uuid
stay_id
In-house stay the check is for (required on room_service, optional otherwise)
string format: uuid
table_id
Table to seat (dine-in only)
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

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"
}