Available Revel Systems APIs

Cash management: Bank drop

Return the list of bank drop objects

X

Find bank drop-by ID

X

Add a new bank drop

X

Replace a bank drop object

X

Update details of a bank drop object

X

Cash management: Cashoffice

Return the list of cash office objects

X

Find cash office by ID

X

Add a new cash office

X

Update an existing cash office

X

Cash management: Payout

Return the list of payout objects

X

Find payout by ID

X

Add a new payout

X

Update an existing payout

X

Cash management: Till

Return the list of till objects

X

Find till by ID

X

Add a new till

X

Replace a till object

X

Update till

X

Customers: Customer

Return the list of customer objects

X

Find customers by ID

X

Add a new customer

X

Update customer by ID

X

Overwrite an existing customer

X

Delete an existing customer

X

Customers: Customer address

Return the list of customer address objects

X

Find customer address by ID

X

Add a new customer address

X

Update customer address by ID

X

Overwrite an existing customer address

X

Customers: Customer establishment

Return the list of customer establishment objects

X

Find customer establishment by ID

X

Add a new customer establishment

X

Update customer establishment by ID

X

Overwrite an existing customer establishment

X

Customers: Customer group

Return the list of customer group objects

X

Find customer group by ID

X

Add a new customer group

X

Update a customer group object

X

Update details of a customer group object

X

Customers: Customer group customers

Return the list of customer group customers objects

X

Find customer group customers by ID

X

Return the list of customer history objects

X

Add a new customer group of customers

X

Update a customer group customer object

X

Update details of a customer group customer object

X

Discounts: Discount

Return the list of discount objects

X

Return a single discount object

X

Update a discount object specified by ID

X

Create discount

X

Update details of a discount object specified by ID

X

Discounts: Discount code

Return the list of discount code objects

X

Return a single discount code object

X

Add a new discount code

X

Update a discount code object

X

Update details of a discount code object specified by ID

X

Discounts: Discount level

Return the list of discount-level objects

X

Return a single discount level object specified by ID

X

Employees: Declared tips

Return the list of declared tip objects

X

Return a single declared tips object specified by ID

X

Add a new declared tips

X

Update a declared tips object

X

Update details of a declared tips object

X

Employees: Department

Return the list of department objects

X

Find department by ID

X

Add a new department for the employees

X

Employees: Employee

Return the list of employee objects

X

Find employees by ID

X

Add a new employee

X

Update employee by ID

X

Overwrite an existing employee

X

Employees: Employee role establishment

Return the list of employee role establishment objects

X

Find employee role establishment by ID

X

Add a new employee role establishment

X

Update employee role establishment by ID

X

Overwrite an existing employee role establishment

X

Employees: Permission

Return the list of permission objects

X

Return a single permission object

X

Employees: Role

Return the list of role objects

X

Find role by ID

X

General: address

Return the list of address objects

X

Find address by ID

X

Add a new address

X

Replace an address object

X

Update address

X

General: Business action log

Return the list of business action log objects

X

Find business action log by ID

X

Replace a business action log object

X

General: Business day

Return the list of business-day objects

X

Find business day by ID

X

Add a new business day

X

Replace a business day object

X

Update details of a business day object

X

General: Company

Return the list of company objects

X

Find the company by ID

X

General: Currency

Return the list of currency objects

X

Find currency by ID

X

Add a new currency

X

Replace a currency object

X

Update details of a currency object

X

General: Device

Return the list of device objects

X

Find the device by ID

X

General: Establishment

Return the list of establishment objects

X

Find establishment by ID

X

Replace an establishment object

X

Update details of an establishment object

X

General: POS station

Return the list of POS station objects

X

Find POS station by ID

X

General: Revenue center

Return the list of revenue center objects

X

Find revenue center by ID

X

Add a new revenue center

X

Update an existing revenue center

X

Update an existing revenue center

X

General: System setting

Return the list of system-setting objects

X

Find system setting by ID

X

General: System setting option

Return the list of system setting option objects

X

Return a single system setting option object

X

General: Time table

Return the list of timetable objects

X

Add a new timetable

X

Find timetable by ID

X

Update an existing timetable

X

General: Timetable item

Return the list of timetable item objects

X

Find timetable items by ID

X

Add a new timetable item

X

Update an existing timetable item

X

General: User

Return the list of user objects

X

Find user by ID

X

House accounts: House account

Return the list of house account objects

X

Find house account by ID

X

Update an existing house account

X

House accounts: House account payment

Return the list of house account payment objects

X

Find house account payment by ID

X

Update an existing house account payment

X

House accounts: House account transaction

Return the list of house account transaction objects

X

Find house account transactions by ID

X

Inventory: Current stock

Return the list of current stock objects

X

Inventory: Ingredient Inventory

Return the list of ingredient inventory objects

X

Find ingredient inventory by ID

X

Update details of an ingredient inventory object

X

Inventory: Inventory

Return the list of inventory objects

X

Find inventory by ID

X

Update inventory

X

Inventory: Inventory receipt

Return the list of inventory receipt objects

X

Find inventory receipt by ID

X

Add a new inventory receipt

X

Replace an inventory receipt object

X

Update details of an inventory receipt object

X

Inventory: Inventory unit

Return the list of inventory unit objects

X

Find inventory units by ID

X

Add a new inventory unit

X

Update details of an inventory unit object

X

Inventory: Inventory x ingredient

Return the list of ingredient inventory objects

X

Return a single ingredient's inventory object

X

Receive into ingredient's inventory

X

Inventory: Inventory x product

Return the list of product's inventory objects

X

Return a single product's inventory object

X

Receive into product's inventory

X

Inventory: Physical inventory

Return the list of physical inventory objects

X

Find physical inventory by ID

X

Inventory: Physical inventory item

Return the list of physical inventory item objects

X

Find physical inventory items by ID

X

Inventory: Physical inventory scanned item

Return the list of physical inventory scanned item objects

X

Find physical inventory scanned items by ID

X

Add a new physical inventory scanned item

X

Inventory: Physical inventory section

Return the list of physical inventory section objects

X

Find physical inventory section by ID

X

Replace a physical inventory section object

X

Inventory: Stocktake

Return the list of stocktake objects

X

Find stocktake by ID

X

Inventory: Stocktake item

Return the list of stocktake item objects

X

Find stocktake items by ID

X

Inventory: Stocktake scanned item

Return the list of stocktake scanned item objects

X

Return a single stocktake scanned item object

X

Add a new stocktake scanned item

X

Update details of a stocktake scanned item object

X

Inventory: Stocktake section

Return the list of stocktake section objects

X

Return a single stocktake section object

X

Replace a stock take section object

X

Update details of a stocktake section object

X

Inventory: Transfer

Return a list of transfer objects

X

Inventory: Transfer item

Return the list of transfer item objects

X

Find transfer item by ID

X

Inventory: Transfer receipt

Return the list of transfer receipt objects

X

Find the transfer receipt by ID

X

Inventory: Transfer receipt item

Return the list of transfer receipt item objects

X

Find the transfer receipt item by ID

X

Orders: Applied service fee

Return the list of applied service fee objects

X

Return a single applied service fee object

X

Add a new applied service fee

X

Update an applied service fee object

X

Update details of an applied service fee object

X

Orders: Applied tax order

Return the list of applied tax order objects

X

Return a single applied tax order object

X

Add a new applied tax order

X

Update an applied tax order object

X

Update details of an applied tax order object

X

Orders: Applied tax order item

Return the list of applied tax order item objects

X

Return a single applied tax order item object

X

Add a new applied tax order item

X

Update an applied tax order item object

X

Update details of an applied tax order item object

X

Orders: Custom order option

Return the list of custom order option objects

X

Orders: Custom payment type

Return the list of custom payment-type objects

X

Return a single custom payment type object

X

Orders: Modifier item

Return the list of modifier item objects

X

Return a single modifier item object specified by ID

X

Add a new modifier item

X

Update modifier item

X

Update details of a modifier item object

X

Orders: Order

Return the list of order objects

X

Find order by ID

X

Add a new order

X

Update order by ID

X

Update an existing order

X

Orders: Order data diff

Return the list of order data diff objects

X

Return a single-order data diff object

X

Orders: Order exchange

Get the order exchange list

X

Find order exchange by ID

X

Add a new order exchange

X

Update order exchange by ID

X

Update an existing order exchange

X

Orders: Order exchange item

Return the list of order exchange item objects

X

Return a single order exchange item object

X

Adds new order exchange item object

X

Update an order exchange item object

X

Update details of an order exchange item object

X

Orders: Order history

Return the list of order history objects

X

Find order history by ID

X

Add a new order history

X

Update order history by ID

X

Update an existing order history

X

Orders: Order item

Return the list of order item objects

X

Return a single-order item object

X

Update an order item object

X

Adds new order item object

X

Update an order item object

X

Orders: Order item catering

Return the list of order item catering objects

X

Return a single order item catering object

X

Orders: Order item commission

Return the list of order item commission objects

X

Return a single order item commission object

X

Add a new order item commission

X

Update an order item commission object

X

Update details of an order item commission object

X

Orders: Order item data diff

Return the list of order item data diff objects

X

Find order item data diff by ID

X

Orders: Order tax breakdown

Return the list of order tax breakdown objects

X

Find order tax breakdown by ID

X

Orders: Package

Return the list of package objects

X

Find package by ID

X

Add a new package

X

Overwrite an existing package

X

Update package by ID

X

Orders: Payment

Return the list of payment objects

X

Return a single payment object

X

Adds new payment object

X

Update a payment object

X

Update details of a payment object

X

Orders: Payment type

Return the list of payment-type objects

X

Find payment type by ID

X

Add a new payment type

X

Update a payment-type object

X

Update details of a payment-type object

X

Orders: Return

Return the list of returned objects

X

Find return by ID

X

Add a new return

X

Update return by ID

X

Overwrite an existing return

X

Orders: Returned item

Return the list of returned item objects

X

Find returned item by ID

X

Add a new returned item

X

Update returned item by ID

X

Overwrite an existing returned item

X

Products: Attribute

Return the list of attribute objects

X

Find attribute by ID

X

Add a new attribute

X

Update an attribute object

X

Update details of an attribute object

X

Products: Attribute value

Return the list of attribute value objects

X

Find attribute value by ID

X

Add a new attribute value

X

Update an attribute value object

X

Update details of an attribute value object

X

Products: Combo product set

Return the list of combo product set objects

X

Find combo product set by ID

X

Products: Combo product set product

Return the list of combo product set product objects

X

Find combo product set product by ID

X

Products: Custom menu

Return the list of custom menu objects

X

Find custom menu by ID

X

Products: Dynamic combo

Return the list of dynamic combo objects

X

Find dynamic combo by ID

X

Products: Dynamic combo upsell slot

Return the list of dynamic combo upsell slot objects

X

Find dynamic combo upsell slot by ID

X

Products: Ingredient

Return the list of ingredient objects

X

Find ingredients by ID

X

Add a new ingredient

X

Update ingredient by ID

X

Overwrite an existing ingredient

X

Products: Ingredient recipe

Return the list of ingredient recipe objects

X

Find ingredient recipes by ID

X

Add a new ingredient recipe

X

Update ingredient recipe by ID

X

Overwrite an existing ingredient recipe

X

Products: Modifier

Return the list of modifier objects

X

Find modifier by ID

X

Add a new modifier

X

Update modifier by ID

X

Overwrite an existing modifier

X

Products: Modifier class

Return the list of modifier class objects

X

Return a single modifier class objects

X

Add a new modifier class

X

Update a modifier class object

X

Update details of a modifier class object

X

Products: Modifier discount

Return the list of modifier discount objects

X

Return a single modifier discount object

X

Add a new modifier discount

X

Update a modifier discount object

X

Update details of a modifier discount object

X

Products: Modifier recipe

Return the list of modifier recipe objects

X

Find modifier recipe by ID

X

Add a new modifier recipe

X

Update modifier recipe by ID

X

Overwrite an existing modifier recipe

X

Products: Price tier

Return the list of price-tier objects

X

Find price tier by ID

X

Products: Product

Return the list of product objects

X

Return a single product object

X

Update a product object

X

Adds new product object

X

Update details of a product object

X

Products: Product category

Return the list of product category objects

X

Find product category by ID

X

Add a new product category

X

Update product category by ID

X

Update an existing product category

X

Products: Product class

Return the list of product class objects

X

Return a single product class object

X

Adds new product class object

X

Update a product class object

X

Update details of a product class object

X

Products: Product group

Return the list of product group objects

X

Return a single product group object specified by ID

X

Adds new product group object

X

Update a product group object

X

Update details of a product group object

X

Products: Product group action

Return the list of product group action objects

X

Return a single product group action object

X

Adds new product group action object

X

Products: Product modifier

Return the list of product modifier objects

X

Return a single product modifier object

X

Add a new product modifier

X

Update a product modifier object

X

Update details of a product modifier object

X

Products: Product modifier class

Return the list of product modifier class objects

X

Return a single product modifier class object

X

Add a new product modifier class

X

Update a product modifier class object

X

Update details of a product modifier class object

X

Products: Product price life cycle action

Return the list of product price life cycle action objects

X

Find product price life cycle action by ID

X

Add a new product price life cycle action

X

Update product price life cycle action by ID

X

Overwrite an existing product price life cycle action

X

Products: Product price tier price

Return the list of product price tier price objects

X

Find product price tier price by ID

X

Products: Product recipe

Return the list of product recipe objects

X

Find product recipes by ID

X

Add a new product recipe

X

Update product recipe by ID

X

Overwrite an existing product recipe

X

Products: Product Serial

Return the list of product serial objects

X

Find product serial by ID

X

Products: Product variable price

Return the list of product variable price objects

X

Return a single product variable price objects

X

Add a new product variable price

X

Update a product variable price object

X

Update details of a product variable price object

X

Products: Service fee

Return the list of service fee objects

X

Return a single service fee object

X

Add a new service fee

X

Update a service fee object

X

Update details of a service fee object

X

Products: Surcharge

Return the list of surcharge objects

X

Find surcharge by ID

X

Add a new surcharge

X

Update surcharge by ID

X

Overwrite an existing surcharge

X

Products: Unit type

Return the list of unit-type objects

X

Find unit type by ID

X

Add a new unit type

X

Update unit type by ID

X

Overwrite an existing unit type

X

Purchase orders: Ingredient purchase

Return the list of ingredient purchase objects

X

Find ingredient purchase by ID

X

Purchase orders: Product purchase

Return the list of product purchase objects

X

Return a single product purchase object

X

Purchase orders: Product purchase order item

Return the list of product purchase order item objects

X

Return a single product purchase order item object

X

Update a product purchase order item object

X

Update details of a product purchase order item object

X

Purchase orders: Purchase ledger

Return the list of purchase ledger objects

X

Return a single purchase ledger object specified by ID

X

Create a purchase ledger object

X

Update a purchase ledger object

X

Partial update of a product ledger's details

X

Purchase orders: Purchase order

Return the list of purchase order objects

X

Find purchase order by ID

X

Add a new purchase order

X

Replace a purchase order object

X

Update details of a purchase order object

X

Purchase orders: Purchase order invoice

Return the list of purchase order invoice objects

X

Find purchase order invoice by ID

X

Add a new purchase order invoice

X

Replace a purchase order invoice object

X

Update details of a purchase order invoice object

X

Purchase orders: Purchase order item

Return the list of purchase order item objects

X

Add a new purchase order item

X

Find purchase order items by ID

X

Replace a purchase order item object

X

Update details of a purchase order item object

X

Purchase orders: Vendor

Return the list of vendor objects

X

Find vendor by ID

X

Add a new vendor

X

Update an existing vendor

X

Purchase orders: Vendor establishment

Return the list of vendor establishment objects

X

Find vendor establishment by ID

X

Add a new vendor establishment

X

Replace a vendor establishment object

X

Update details of a vendor establishment object

X

Purchase orders: Vendor orderable item

Return the list of vendor-orderable item objects

X

Find vendor-orderable items by ID

X

Add a new vendor-orderable item

X

Update details of a vendor-orderable item object

X

Purchase orders: View purchase order

Return a read-only list of purchase order objects

X

View purchase order by ID

X

Purchase orders: View purchase order product

Return the list of view purchase order product objects

X

Return a single-view purchase order product object

X

Scheduling: Time schedule

Return the list of time schedule objects

X

Find time schedule by ID

X

Add a new time schedule

X

Update an existing time schedule

X

Delete time schedule

X

Scheduling: Time schedule rule

Return the list of time schedule rule objects

X

Find time schedule rule by ID

X

Scheduling: Timesheet entry

Return the list of timesheet entry objects

X

Find timesheet entry by ID

X

Add a new timesheet entry

X

Update an existing timesheet entry

X

Tables: Table

Return the list of table objects

X

Find table by ID

X

Replace a table object

X

Tables: Table section

Return the list of table section objects

X

Find the table section by ID

X

Add a new table section

X

Update a table section object

X

Update details of a table section object

X

Tables: Table tag

Return the list of table tag objects

X

Find table tag by ID

X

Add a new table tag

X

Update a table tag object

X

Update details of a table tag object

X

Tax: Tax

Return the list of tax objects

X

Find tax by ID

X

Add a new tax

X

Replace a tax object

X

Update tax

X

Tax: Tax agency

Return the list of tax agency objects

X

Find tax agency by ID

X

Add a new tax agency

X

Replace a tax agency object

X

Update details of a tax agency object

X

Tax: Tax code

Return the list of tax code objects

X

Find tax code by ID

X

Add a new tax code

X

Update an existing tax code

X

Tax: Tax product group

Return the list of tax product group objects

X

Find tax product group by ID

X

Tax: Tax rate

Return the list of tax rate objects

X

Find tax rate by ID

X

Add a new tax rate

X

Replace a tax rate object

X

Update details of a tax rate object

X

Tax: Tax table

Return the list of tax table objects

X

Find tax table by ID

X

Add a new tax table

X

Weborders: Attributes

Return a list of attributes and child products of the parent product

X

Weborders: Calculate cart

Calculates cart totals

X

Weborders: Menu

Return an entire menu

X

Weborders: Modifiers

Weborders modifier class

X

Weborders: Product categories

Return the list of product categories

X

Weborders: Products

Return a list of products

X

Weborders: Product sets

Return info about group combos attached to the product

X

Weborders: Product upcharge

Return info about linked combos attached to the product

X

Weborders: Submit cart

Submits cart and Return order

X

Weborders: System settings

Return a list of system settings

X

Weborders: Validate cart

Validates cart and Return cart object

X