Order status card

Category: Food and drink. Tags: Queues and waits, Restaurants and cafes, Stores.

Previews

Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.

Card views, themes and publishing. Browse the gallery.

Data and privacy

This card uses its configured properties and live card data.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

Name	Type	Default	Values and limits	Description
`title`	string	`"Order status"`	maxLength: `40`
`preparingLabel`	string	`"Preparing"`	maxLength: `24`
`readyLabel`	string	`"Ready"`	maxLength: `24`
`expireMinutes`	integer	`10`	minimum: `0`; maximum: `240`	A ready order leaves the board this many minutes after readyAt. 0 keeps it until the data removes it.
`chime`	boolean	`true`		The host plays the ready cue; the card flashes an order that became ready under 20 s ago.

Dynamic properties

Name	Type	Default	Values and limits	Description
`preparing`	array	`[]`	minItems: `0`; maxItems: `60`	Order numbers being prepared, oldest first. An order that is also ready shows as ready.
`ready`	array	`[]`	minItems: `0`; maxItems: `60`	Orders ready to collect. The newest ready order comes first.
`ready[].order`	string		minLength: `1`; maxLength: `12`; Required
`ready[].readyAt`	string	`""`	maxLength: `40`	ISO 8601 instant the order became ready. Drives the fresh flash, the newest-first order and the expiry.
`footnote`	string	`""`	maxLength: `120`

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "order-status",
  "primitive": "card",
  "card": "order-status",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "order-status-main"
}

Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/order-status-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"preparing":[],"ready":[],"footnote":""}}'