Show menu
Login

till_menu

The till_menu Endpoint

The following attributes may be retrieved with a GET request that specifies venue : xxx. This will return all PLUs available in that venue, including those not on an EPoS menu page.

till_menu Object

Attribute Type Key Description
id smallint unsigned Yes EPoS menu id
name string No EPoS menu name
items array No Array of till_menuitem objects
pages array No Array of till_menupage objects
menu_discount array No Array of till_menudiscount objects

 

till_discount Objects

Attribute Type Key Description
id int unsigned Yes ID
name string No Internal discount name
name string No Public facing discount name
appliesto enum No Order | Item
discounttype enum No A + B (+C) | Any N for FIXED | Any X for Y | Fixed | Percent | Specific N for FIXED | Specific X for Y
autoapply Boolean No Should the EPoS apply this automatically if possible?
spantabs Boolean No Should this discount apply to all orders on a tab?
singleuse Boolean No Should this discount be limited to a single application?
voucherlocked Boolean No Does the customer account need to have a relevant voucher to use this discount?
expireafter int No Validity period in weeks
tax_exempt boolean No Is this a pure discount? False if money has been received in lieu as it is therefore taxable.
when_available enum No all the time | at specific times |except at specific times
availabilities array No Array of availabilities objects

 

till_menuitem Objects

Attribute Type Key Description
id int unsigned Yes menuitem ID
menuid int unsigned No till_menu ID
itemid int unsigned No epos_item ID
pageid int unsigned No till_menupage ID
styleid int unsigned No PLU colour reference
ordering int unsigned No Menu page PLU slot ID
pageid int unsigned No till_menupage ID

 

till_menudiscount Objects

Attribute Type Key Description
discount array No Array of till_discount objects
discount_items array No Array of epos_item IDs that are eligible for this discount
qualify_items array No Array of epos_item IDs that are required to qualify this discount

 

till_menupage Objects

Attribute Type Key Description
id int unsigned Yes till_menupage ID
menuid int unsigned No till_menu ID
pageid int unsigned No till_page ID
style int unsigned No Page colour reference
ordering int unsigned No Page tab ordering
name text No EPoS page name

 

availabilities Objects

Attribute Type Key Description
objectid int unsigned No till_discount ID
mode enum No allow | restrict
datestart SQL date No Discount start date (may be empty)
dateend SQL date No Discount expiry date (may be empty)
day string No CSV list of days of the week in the Mon to Sun format
timestart SQL time No Discount start time – in HH:mm:ss from midnight Monday
timestart SQL time No Discount stop time – in HH:mm:ss from midnight Monday