Fresh KDS APIs

KDS Order Notifications

KDS Order Notifications

Routes

There are three routes available to post notifications to KDS They are:

Route Description
POST Customer Arrived Displays customer arrival notification on the takeout view
POST Estimated Arrival Update Updates the estimated time to arrival on the takeout view
POST Send Message Displays a pop-up notification on the KDS screen

Customer Arrived Notification

Request

POST /integrators/kds-notifications/customer-arrived

Required Headers

x-integration-token: {token}

x-location-id: {locationId}

x-device-ids: {deviceId}

For device ids you can pass a single device id, a list of device ids separated by commas, or ‘all’ to send the notification to all the location’s devices

Body Parameters

Property Required Type Description
id yes string unique id identifying the KDS order
retry no Retry retry logic if screen is no connected when notification is sent

Retry

Property Required Type Description
notificationUrl no string URL to POST final success or failure to
expiration no date timestamp of when retries should cease in ISO 8601 format; default is 2 minutes after submission time

Estimated Arrival Update

Request

POST /integrators/kds-notifications/estimated-arrival-update

Required Headers

x-integration-token: {token}

x-location-id: {locationId}

x-device-ids: {deviceId}

For device ids you can pass a single device id, a list of device ids separated by commas, or ‘all’ to send the notification to all the location’s devices

Body Parameters

Property Required Type Description
id yes string unique id identifying the KDS order
minutes yes int minutes until estimated arrival
retry no Retry retry logic if screen is no connected when notification is sent

Send Message

Request

POST /integrators/kds-notifications/send-message

Required Headers

x-integration-token: {token}

x-location-id: {locationId}

x-device-ids: {deviceId}

For device ids you can pass a single device id, a list of device ids separated by commas, or ‘all’ to send the message to all the location’s devices

Body Parameters

Property Required Type Description
message yes string message to display on the KDS screens