Menu API (v1.0)

Download OpenAPI specification:Download

Menu API

Get Menu by Name

By passing in the appropriate options, you can search for available Menu in the system.

path Parameters

menuName

required

string

Menu Name

header Parameters

X-Store

required

string

Responses

Response samples

200

Content type

application/json

{"data": {"displayName": "string",
"maxModifierLevels": 4,
"deliveryOptions": {"deliveryFeeType": "Amount",
"displayName": "string",
"deliveryFeeValue": 0,
"deliveryFeeTaxType": {"id": "string"
}
},
"groups": [{"displayName": "string",
"name": "string",
"description": "string",
"imageId": "string",
"sequence": 0,
"items": [{"displayName": "string",
"name": "string",
"description": "string",
"stockItemId": "string",
"sequence": 0,
"isAvailable": true,
"taxType": {"id": "string"
},
"priceInfo": {"price": 0,
"originalPrice": 0,
"halfPrice": 0,
"originalHalfPrice": 0,
"orderTypePrices": [{"orderType": {"id": "string",
"orderTypeCategory": "None"
},
"price": 0
}
],
"tierPrices": [{"quantityAndAbove": 0,
"price": 0
}
]
},
"allowHalf": false,
"modifierCredit": 0,
"modifiers": [{"displayName": "string",
"name": "string",
"stockItemId": "string",
"sequence": 0,
"allowHalf": false,
"minimumModifiers": 0,
"maximumModifiers": 0,
"modifiers": [{"displayName": "string",
"modifierHash": "string",
"name": "string",
"stockItemId": "string",
"isAvailable": true,
"sequence": 0,
"isDefault": false,
"allowHalf": false,
"allowSide": false,
"allowLite": false,
"noSubstitutionCredit": true,
"allowModifierCredit": true,
"modifierCredit": 0,
"minimumQuantity": 1,
"maximumQuantity": 1,
"modifierpriceInfo": {"price": 0,
"originalPrice": 0,
"halfPrice": 0,
"originalHalfPrice": 0,
"orderTypePrices": [{"orderType": {"id": "string",
"orderTypeCategory": "None"
},
"price": 0
}
],
"tierPrices": [{"quantityAndAbove": 0,
"price": 0
}
]
},
"modifiers": [{ }
],
"id": "string"
}
],
"id": "string"
}
],
"id": "string"
}
],
"operationPeriods": [{"dayOfWeek": "Sunday",
"startTime": "strin",
"endTime": "strin"
}
],
"id": "string"
}
],
"taxTypes": [{"displayName": "string",
"taxIncluded": false,
"isAlcohol": false,
"taxRateInfo": {"taxRate": 0,
"orderTypeTaxes": [{"orderTypeId": "string",
"taxRate": 100
}
]
},
"id": "string"
}
],
"orderTypes": [{"displayName": "string",
"isDelivery": true,
"deferPrepMinutes": 0,
"minOrderPrice": 0,
"operationPeriods": [{"dayOfWeek": "Sunday",
"startTime": "strin",
"endTime": "strin"
}
],
"id": "string",
"orderTypeCategory": "None"
}
],
"availableDiscounts": [{"id": "string",
"displayName": "string",
"description": "string",
"isDeal": true,
"requireApproval": true,
"minimumOrderPrice": 0,
"discountScope": "Order",
"limit": 1,
"combinable": false,
"validationCodeRequired": false,
"validFromDate": "string",
"validToDate": "string",
"validWeekdays": 0,
"startTime": "string",
"endTime": "string",
"discountType": "AmountOff",
"discountValue": 0,
"conditions": [{"menuGroups": [{"id": "string"
}
],
"menuGroupRequirments": 1,
"items": [{"id": "string"
}
],
"itemRequirments": 1,
"modifiers": [{"id": "string"
}
],
"modifierRequirments": 0
}
],
"orderTypes": [{"id": "string",
"orderTypeCategory": "None"
}
],
"validationCodes": [{"code": "string",
"hasExpireDate": true,
"expireDate": "2019-08-24",
"lastUpdateUser": "string",
"lastUpdateDateTime": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string"
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Patch Menu by Name

Properties will be merged with exisitng Menu. Limited list of properties.

path Parameters

menuName

required

string

Menu Name

header Parameters

X-Store

required

string

Request Body schema: application/json

Menu Patch

Array of objects (Operation)

Operations

Array

op	string Operation: replace, add, remove, copy, move, test
path	string example: /foo
value	object Value

Responses

Request samples

Payload

Content type

application/json

{"operation": [{"op": "string",
"path": "string",
"value": { }
}
]
}

Get Menus

By passing in the appropriate options, you can search for available Menu in the system.

query Parameters

serviceType

required

string (ServiceType)

Enum: "None" "GrubHubEMail" "DoorDash" "GrubHub" "UberEats" "GoogleOrdering" "Menufy" "Kanekt365"

pass an optional search to lookup by serviceType

header Parameters

X-Store

required

string

Responses

Response samples

200

Content type

application/json

{"data": {"id": "Dec2014",
"displayName": "Dec2014",
"maxModifierLevels": 8,
"deliveryOptions": {"deliveryFeeType": "Percent",
"deliveryFeeValue": 300,
"deliveryFeeTaxType": {"id": "None"
}
},
"groups": [{"displayName": "Pizza ",
"items": [{"description": "Our Build Your Own is served with Pizza Sauce and Our Wisconsin Cheese Blend. Pick your Crust, Sauce, Meats, and Veggies",
"isAvailable": true,
"taxType": {"id": "None"
},
"priceInfo": {"price": 0
},
"displayName": "Build Your Own",
"isDefault": false,
"allowHalf": true,
"allowSide": false,
"minimumQuantity": 1,
"maximumQuantity": 1,
"minimumModifiers": 0,
"maximumModifiers": 0
}
]
}
]
}
}

Post Menu

Adds an item to the system

header Parameters

X-Store

required

string

Request Body schema: application/json

Menu item to add

object (Menu)

Menu

displayName required	string Menu display text
maxModifierLevels	integer <= 4 Default: 4 Max number of modifier levels
	object (DeliveryOptions) Delivery options
	Array of objects (MenuGroup) List of Menu groups
	Array of objects (TaxType) List of tax types
	Array of objects (OrderType) List of order types
	Array of objects (AvailableDiscount) List of discounts
id required	string Unique identifier for the menu group (aka MenuName)

Responses

Request samples

Payload

Content type

application/json

{"data": {"displayName": "string",
"maxModifierLevels": 4,
"deliveryOptions": {"deliveryFeeType": "Amount",
"displayName": "string",
"deliveryFeeValue": 0,
"deliveryFeeTaxType": {"id": "string"
}
},
"groups": [{"displayName": "string",
"name": "string",
"description": "string",
"imageId": "string",
"sequence": 0,
"items": [{"displayName": "string",
"name": "string",
"description": "string",
"stockItemId": "string",
"sequence": 0,
"isAvailable": true,
"taxType": {"id": "string"
},
"priceInfo": {"price": 0,
"originalPrice": 0,
"halfPrice": 0,
"originalHalfPrice": 0,
"orderTypePrices": [{"orderType": {"id": "string",
"orderTypeCategory": "None"
},
"price": 0
}
],
"tierPrices": [{"quantityAndAbove": 0,
"price": 0
}
]
},
"allowHalf": false,
"modifierCredit": 0,
"modifiers": [{"displayName": "string",
"name": "string",
"stockItemId": "string",
"sequence": 0,
"allowHalf": false,
"minimumModifiers": 0,
"maximumModifiers": 0,
"modifiers": [{"displayName": "string",
"modifierHash": "string",
"name": "string",
"stockItemId": "string",
"isAvailable": true,
"sequence": 0,
"isDefault": false,
"allowHalf": false,
"allowSide": false,
"allowLite": false,
"noSubstitutionCredit": true,
"allowModifierCredit": true,
"modifierCredit": 0,
"minimumQuantity": 1,
"maximumQuantity": 1,
"modifierpriceInfo": {"price": 0,
"originalPrice": 0,
"halfPrice": 0,
"originalHalfPrice": 0,
"orderTypePrices": [{"orderType": {"id": "string",
"orderTypeCategory": "None"
},
"price": 0
}
],
"tierPrices": [{"quantityAndAbove": 0,
"price": 0
}
]
},
"modifiers": [{ }
],
"id": "string"
}
],
"id": "string"
}
],
"id": "string"
}
],
"operationPeriods": [{"dayOfWeek": "Sunday",
"startTime": "strin",
"endTime": "strin"
}
],
"id": "string"
}
],
"taxTypes": [{"displayName": "string",
"taxIncluded": false,
"isAlcohol": false,
"taxRateInfo": {"taxRate": 0,
"orderTypeTaxes": [{"orderTypeId": "string",
"taxRate": 100
}
]
},
"id": "string"
}
],
"orderTypes": [{"displayName": "string",
"isDelivery": true,
"deferPrepMinutes": 0,
"minOrderPrice": 0,
"operationPeriods": [{"dayOfWeek": "Sunday",
"startTime": "strin",
"endTime": "strin"
}
],
"id": "string",
"orderTypeCategory": "None"
}
],
"availableDiscounts": [{"id": "string",
"displayName": "string",
"description": "string",
"isDeal": true,
"requireApproval": true,
"minimumOrderPrice": 0,
"discountScope": "Order",
"limit": 1,
"combinable": false,
"validationCodeRequired": false,
"validFromDate": "string",
"validToDate": "string",
"validWeekdays": 0,
"startTime": "string",
"endTime": "string",
"discountType": "AmountOff",
"discountValue": 0,
"conditions": [{"menuGroups": [{"id": "string"
}
],
"menuGroupRequirments": 1,
"items": [{"id": "string"
}
],
"itemRequirments": 1,
"modifiers": [{"id": "string"
}
],
"modifierRequirments": 0
}
],
"orderTypes": [{"id": "string",
"orderTypeCategory": "None"
}
],
"validationCodes": [{"code": "string",
"hasExpireDate": true,
"expireDate": "2019-08-24",
"lastUpdateUser": "string"
}
]
}
],
"id": "string"
}
}

Response samples

422

Content type

application/json

{"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Get Menu Discounts By ServiceType

By passing in the appropriate options, you can search for available Menu in the system.

query Parameters

serviceType

required

string (ServiceType)

Enum: "None" "GrubHubEMail" "DoorDash" "GrubHub" "UberEats" "GoogleOrdering" "Menufy" "Kanekt365"

pass an optional search to lookup by serviceType

header Parameters

X-Store

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"displayName": "string",
"description": "string",
"isDeal": true,
"requireApproval": true,
"minimumOrderPrice": 0,
"discountScope": "Order",
"limit": 1,
"combinable": false,
"validationCodeRequired": false,
"validFromDate": "string",
"validToDate": "string",
"validWeekdays": 0,
"startTime": "string",
"endTime": "string",
"discountType": "AmountOff",
"discountValue": 0,
"conditions": [{"menuGroups": [{"id": "string"
}
],
"menuGroupRequirments": 1,
"items": [{"id": "string"
}
],
"itemRequirments": 1,
"modifiers": [{"id": "string"
}
],
"modifierRequirments": 0
}
],
"orderTypes": [{"id": "string",
"orderTypeCategory": "None"
}
],
"validationCodes": [{"code": "string",
"hasExpireDate": true,
"expireDate": "2019-08-24",
"lastUpdateUser": "string",
"lastUpdateDateTime": "2019-08-24T14:15:22Z"
}
]
}
],
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Get Menu OutOfStock

By passing in the appropriate options, you can search for available OutOfStock in the system.

path Parameters

menuName

required

string

Menu Name

header Parameters

X-Store

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"stockItemId": "123"
},
{"stockItemId": "456"
},
{"stockItemId": "789"
}
]
}

Get OutOfStock

By passing in the appropriate options, you can search for available OutOfStock in the system.

query Parameters

serviceType

required

string (ServiceType)

Enum: "None" "GrubHubEMail" "DoorDash" "GrubHub" "UberEats" "GoogleOrdering" "Menufy" "Kanekt365"

pass an optional search to lookup by serviceType

header Parameters

X-Store

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"stockItemId": "123"
},
{"stockItemId": "456"
},
{"stockItemId": "789"
}
]
}