Notifications allow the sending of messages to registers in order to notify staff about an order.

This could be used to flag an issue with an order, to notify of new items added to an order, or to signal wait staff to a table.

All notifications will be shown as a banner message across the top of the POS.

A maximum of 5 notifications can be set per order.

If multiple notifications would be triggered at any point, they are displayed sequentially based on their created_time (oldest to newest).

A POS register must be on the orders, products, tables, users, or checkout screens to receive a notification.

Once a "now" notification has been displayed to a register or staff, it is marked as read and will not be displayed to them again.

Add a notification

POST /v1/companies/5678/orders/93824701/notifications Add a new notification to an order

The following are required fields: broadcast_level, alert_colour, message, duration.

  • broadcast_level accepts values of "now" and "order", where "now" alerts immediately, and "order" alerts whenever the order is opened on the POS.
  • alert_colour accepts values of "green", "orange", and "red".
  • message accepts a string up to 300 characters.
  • duration accepts a number between 3 and 60, representing the time in seconds to show the notification on the screen before it is hidden.
  • register_ids is an array of numeric register IDs used to limit the notification to specific registers. An empty value will send it to all registers.
  • staff_ids is an array of numeric staff IDs used to limit the notification to specific staff. An empty value will send it to all staff.
  • expires accepts a DateTime in the format "2018-04-22T13:30:00+10:00" which represents when the notification should no longer be shown.

Update a notification

This should only be used with "order" broadcast_level notifications.

PUT /v1/companies/5678/orders/93824701/notifications/1 Update a notification on an order

Get all notifications

GET /v1/companies/5678/orders/93824701/notifications Get all notifications on an order

Get a notification

GET /v1/companies/5678/orders/93824701/notifications/1 Get a notification on an order