Take-Out Status
Type | Base Path | Trigger Name |
---|---|---|
Single entity resource | ~{realm}/locations/{location}/take-out-status | N/A |
Retrieve a location's current take-out order status.
Endpoints
Name | Method | Relative Path | Payload | Response | Description |
---|---|---|---|---|---|
getTakeOutStatus | GET | ~{realm}/locations/{location}/take-out-status | N/A | TakeOutStatus | Returns the location's take-out order status |
Permissions
Permission | Description |
---|---|
show-locations | Client 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;
}
Property | Data Type | Description |
---|---|---|
configured | Boolean | This location has a valid take-out configuration. |
enabled | Boolean | The location's take-out order handling is enabled. |
open | Boolean | According to the schedules and last-order configuration, orders may currently be placed. |
active | Boolean | At least one cash register is actively listening for incoming orders. |