KDS Order Bumped Webhook Event

Overview

This event fires when a new KDS order is bumped. If an order is displayed on multiple screens this event will fire when the order is bumped from each screen.

Body Parameters

Property	Type	Description
triggeredAction	string	value: `KDS Order Bumped`
brand	Brand	brand order belongs to
location	Location	location order belongs to
device	Device	device/screen order was bumped from
kdsOrder	KDS Order	order information
data	Data	order bump information

Brand

Property	Type	Description
id	string	uuid of brand
name	string	name of brand

Location

Property	Type	Description
id	string	uuid of location
name	string	name of location
number	string	user-entered location number

Device

Property	Type	Description
id	string	uuid of device
name	string	name of device

KDS Order

Note: KDS Order contains information about the whole order, while Data contains information specific to the order on the device firing the webhook event

Property	Type	Description
id	string	uuid of the order record
orderId	string	depending on the integration, order id is either generated using a hash of order data or uses the integrator-provided id
name	string	order name/number generated by point of sale automatically or through user input
type	string	order type; possible values `forhere`, `togo`, `pickup`, `curbside`, `delivery`, `drivethru`
items	Items	array of menu items on the order
supplierOrderId	string	the order id provided by the original source; if none is provided supplierOrderId is the same as orderId

Data

Property	Type	Description
id	string	uuid of the order bump record
items	Items	array of menu items displayed for order on this device/screen
orderId	string	order id generated using a hash of order data
deviceId	string	uuid of device bumping order
startsOn	timestamp	timestamp of when order was received on this device/screen in UTC
endsOn	timestamp	timestamp of when order was bumped from this device/screen in UTC
createdOn	timestamp	timestamp of when order bump record was created in UTC
bumpSpeed	string	speed of service status when order was bumped; possible values `fast`, `medium`, `slow`
bumpedFrom	string	which view order was bumped from; possible values `main`, `takeout`
displayStatus	string	display status of order on this device/screen; possible values `displayed`, `partially displayed`, `not displayed`
supplierOrderId	string	the order id provided by the original source; if none is provided supplierOrderId is the same as orderId

Item

Note: Order level special instructions are added as an item where the name is “Special Instructions” and the modifier name is the instruction. Item level special instructions are added as modifiers to the item they are for.

Property	Type	Description
itemId	string	uuid of the menu item in Fresh system; can be null
quantity	integer	quantity of menu item on order
name	string	name of menu item
menuItemId	string	id of the menu item in integrator’s system; can be null
categoryIds	string	id of the menu item’s category; can be null
modifiers	Modifiers	array of modifiers for the item

Modifier

Property	Type	Description
id	string	uuid of the modifier in Fresh system; can be null
name	string	name of the modifier

Example

{
	"triggeredAction": "KDS Order Bumped",
	"brand": {
		"id": "10b4039e-01d2-4399-9d93-52b850fc5751",
		"name": "KDS Test Brand"
	},
	"location": {
		"id": "6c4e879e-3ab5-4e5a-be1d-cf48fe809559",
		"name": "Atlanta",
		"number": "4"
	},
	"device": {
		"id": "d4c9d864-a546-4dbf-9c5c-5d5a86400006",
		"friendly_name": "Cold Drinks"
	},
	"kdsOrder": {
		"id": "b4d64698-4eec-4ba5-99ac-71ac4ed432cf",
		"orderId": "01ff6df10f74761b59090cf7fbbd2225f34615cf",
		"name": "Jennifer FOR HERE",
		"type": "forhere",
		"items": [{
			"itemId": null,
			"quantity": 1,
			"name": "Iced Coffee",
			"menuItemId": null,
			"categoryIds": null,
			"components": [],
			"modifiers": [{
				"id": null,
				"name": "Cream",
				"components": null
			}, {
				"id": null,
				"name": "Caramel",
				"components": null
			}, {
				"id": null,
				"name": "Simple Syrup",
				"components": null
			}, {
				"id": null,
				"name": "- Extra ice",
				"components": null
			}]
		}]
	},
	"data": {
		"id": "447a320d-c8ca-4b3e-ab88-892837e3f00d",
		"items": [{
			"name": "Iced Coffee",
			"itemId": null,
			"quantity": 1,
			"modifiers": [{
				"id": null,
				"name": "Cream",
				"components": null
			}, {
				"id": null,
				"name": "Caramel",
				"components": null
			}, {
				"id": null,
				"name": "Simple Syrup",
				"components": null
			}, {
				"id": null,
				"name": "- Extra ice",
				"components": null
			}],
			"components": [],
			"menuItemId": null,
			"categoryIds": null
		}],
		"orderId": "b4d64698-4eec-4ba5-99ac-71ac4ed432cf",
		"deviceId": "d4c9d864-a546-4dbf-9c5c-5d5a86400006",
		"startsOn": "2023-04-11T18:41:21.000Z",
		"endsOn": "2023-04-11T18:41:59.395Z",
		"createdOn": "2023-04-11T18:42:02.383Z",
		"bumpSpeed": "fast",
		"bumpedFrom": "main",
		"displayStatus": "displayed"
	}
}