Skip to main content

Take-Out Status

TypeBase PathTrigger Name
Single entity resource~{realm}/locations/{location}/take-out-statusN/A

Retrieve a location's current take-out order status.

Endpoints

NameMethodRelative PathPayloadResponseDescription
getTakeOutStatusGET~{realm}/locations/{location}/take-out-statusN/ATakeOutStatusReturns the location's take-out order status

Permissions

PermissionDescription
show-locationsClient is allowed to query the location list and to fetch individual locations.

Entities

Interface TakeOutStatus

interface TakeOutStatus {
'configured': boolean;
'enabled': boolean;
'open': boolean;
'active': boolean;
}
PropertyData TypeDescription
configuredBooleanThis location has a valid take-out configuration.
enabledBooleanThe location's take-out order handling is enabled.
openBooleanAccording to the schedules and last-order configuration, orders may currently be placed.
activeBooleanAt least one cash register is actively listening for incoming orders.