Account

APIDescription
POST api/account/authenticateuser

Authenticate a user by Username and Password.

POST api/account/createuser

Create a user with Firstname, Lastname and Email Address.

POST api/account/updateuser

Update a user's Firstname, Lastname or Email Address, from a provided valid User Id.

POST api/account/assignroles

Assigns roles to a specified User using a comma separated string Role Id array and a User Id.

POST api/account/unassignroles

Un-assigns roles from a specified User using a comma separated string Role Id array and a User Id.

POST api/account/assignsites

Assigns Sites to a specified User using a comma separated string Site Id array and a User Id.

POST api/account/unassignsites

Un-assigns Sites from a specified User using a comma separated string Site Id array and a User Id.

POST api/account/assignapplications

Assigns Applications to a specified User using a comma separated string Application Id array and a User Id.

POST api/account/unassignapplications

Un-assigns Applications from a specified User using a comma separated string Application Id array and a User Id.

GET api/account/users?userId={userId}&email={email}

Get a list of Users, or an individual user from a provided valid User Id or Email Address.

GET api/account/userclaims?userId={userId}&email={email}

Get an individual User from a valid User Id or Email Address, and their associated Applications and Sites.

GET api/account/userroles?userId={userId}&email={email}

Get an individual User from a valid User Id or Email Address, and their associated Roles.

GET api/account/roles

Get all roles.

POST api/account/users/disable

Disables an existing user

POST api/account/users/enable

Enables an existing user

Reports

APIDescription
POST api/reports/eod

Update End of Day Report

POST api/reports/waste

A tills waste reocord for each report sent

Grouping

APIDescription
POST api/grouping/groups

Update product groups

POST api/grouping/departments

Update product departments

Token

APIDescription
POST token

Get a bearer token from User Credentials.

Prices

APIDescription
POST api/pricing/prices

Update PLU prices from PLU Price batch

POST api/pricing/modifiers

Updates PLU modifiers (half/dbl/etc)

POST api/pricing/pricebands

Update PLU price bands from PLU Price Band batch

Sales

APIDescription
POST api/sales/eod

Update Till Sales End of Day from batch

POST api/sales/sales

Update Till Sales from batch

APIDescription
GET api/search/products?searchTerm={searchTerm}

No documentation available.

Booking

APIDescription
GET api/bookings/today

Get today's site bookings.

GET api/bookings/daterange?start={start}&end={end}

Get site bookings from a specified date range.

GET api/bookings/posbookings?start={start}&end={end}

Get site POS bookings from a specified date range.

POST api/bookings/bookingpayment

Create a payment for a booking. Select one payment type only, if payment type is Bank Transfer, you may specify a reference. If payment type is a Card Payment, you may specify a Terminal Id.

Boss

APIDescription
POST api/boss/users

Creates a user with roles and applications

POST api/boss/users/update

Updates an existing user

POST api/boss/users/disable

Disables an existing user

POST api/boss/users/enable

Enables an existing user

POST api/boss/users/{id}

Updates an existing users email address

POST api/boss/users/update_permissions

Batch updates a list of users and their corresponding apps/venues

POST api/boss/users/create_rollback

Rollback a created user.

POST api/boss/sites

Creates a JSM site from a boss venue

POST api/boss/sites/update

Updates a JSM site

POST api/boss/wage_percentage

Get the wage percentages from a site..

Email

APIDescription
GET api/email/resend

Resends unsent emails..

POS

APIDescription
GET api/pos/alldata?showMenuItems={showMenuItems}&showPOSItems={showPOSItems}&pluIds={pluIds}&categoryIds={categoryIds}

Get Site data from for a specified site. Optional parameters to show only menu/POS items or filter by a Category Id List/PLU Id List formatted as a comma separated string.

GET api/pos/categories?showMenuItems={showMenuItems}&showPOSItems={showPOSItems}&categoryIds={categoryIds}&categoryTypeId={categoryTypeId}&pluIds={pluIds}

Get Categories for a specified site. Optional parameters to show only menu/POS items or fiter by a Category Id List/PLU Id List formatted as a comma separated string, or a Category Type Id.

GET api/pos/menuitems?showMenuItems={showMenuItems}&showPOSItems={showPOSItems}&menuItemIds={menuItemIds}&pluIds={pluIds}&categoryIds={categoryIds}

Get Menu Items for a specified site. Optional parameters to fiter by a Menu Item Id List/Category Id List/PLU Id List formatted as a comma separated string.

GET api/pos/condiments?condimentIds={condimentIds}&menuItemIds={menuItemIds}&pluIds={pluIds}&categoryIds={categoryIds}

Get Condiment Item data from for a specified site. Optional parameters to fiter by a Condiment Id List/Menu Item Id List/Category Id List/PLU Id List formatted as a comma separated string.

GET api/pos/pricetiers?priceTierIds={priceTierIds}

Get Price Tiers for a specified site. Optional parameters to fiter by a Price Tier Id List formatted as a comma separated string.

GET api/pos/modifiers?showMenuItems={showMenuItems}&showPOSItems={showPOSItems}&modifierIds={modifierIds}

Get Modifiers for a specified site. Optional parameters to fiter by a Modifier Id List formatted as a comma separated string.

GET api/pos/multideals?showMenuItems={showMenuItems}&showPOSItems={showPOSItems}&dealIds={dealIds}

Get Multi Deals for a specified site. Optional parameters to fiter by a Deal Id List formatted as a comma separated string.

POST api/pos/toggleplu

Enable or disable a PLU, or a list of PLU's. A site id, PLU Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/togglecategory

Enable or disable a Category, or a list of Categories. A site id, Category Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/togglemenuitem

Enable or disable a Menu Item, or a list of Menu Items. A site id, Menu Item Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/togglecondiment

Enable or disable a Condiment, or a list of Condiments. A site id, Condiment Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/togglemodifier

Enable or disable a Modifier, or a list of Modifiers. A site id, Modifier Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/togglemultideal

Enable or disable a Multi Deal, or a list of Multi Deals. A site id, Multi Deal Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/togglerewarddeal

Enable or disable a Reward Deal, or a list of Reward Deals. A site id, Reward Deal Id/'s is required, as well as a show in menu/POS flag.

POST api/pos/createsale

Create a Sale.

POST api/pos/createpinentrydevice

Create a Pin Entry Device.

POST api/pos/createterminal

Create a Terminal.

POST api/pos/createoperator

Create a Operator.

POST api/pos/createvoidreason

Create a Void Reason.

POST api/pos/redeemdeposits

Redeemes an array of booking deposits.

POST api/POS

No documentation available.

POST api/POS?siteId={siteId}&dayId={dayId}

No documentation available.

POST api/POS?userId={userId}

No documentation available.

POST api/POS?bookingId={bookingId}&siteLookupId={siteLookupId}&userId={userId}

No documentation available.

Delivery

APIDescription
GET api/delivery/searchproducts

Search for products.

GET api/delivery/orderproducts

Get Products from an Order.

GET api/delivery/openorders

Get all open orders for a site.

GET api/delivery/openordersites

Get all open orders for a site.

GET api/delivery/units

Get Units.

GET api/delivery/categories?CategoryTypeId={CategoryTypeId}&CategoryId={CategoryId}

Get all Categories.

GET api/delivery/suppliers?supplierId={supplierId}

Get all suppliers, or a single supplier.

POST api/delivery/createdeliveryproduct

Create a new delivery product.

POST api/delivery/confirmorderdelivery

Confirm delivery for an Order.

POST api/delivery/confirmproductdelivery

Confirm delivery for a Product.

POST api/delivery/resetdeliveredproduct

Reset delivery for a Product.

POST api/delivery/createproduct

Create a new product. An image can also be uploaded in this call if provided.

POST api/delivery/uploadinvoice

Upload an invoice, a file, order id and supplier id must be provided.

POST api/delivery/uploadproductimage

Upload a product image, a file and product id must be provided.

POST api/delivery/addproductbarcode

Add a barcode to a product.

POST api/delivery/deleteorderproduct

Delete an app created ordered product.