Jump to Content

Guides API Reference Changelog

Home Guides API Reference Changelog

Guides API Reference Changelog Log In

API Reference

All

Pages

Start typing to search…

Cash Management

Overview
BankDrop
CashOffice
Payout
Till

Customers

Overview
Customer
CustomerAddress
CustomerEstablishment
CustomerGroup
CustomerGroupCustomers

Discounts

Overview
Discount
DiscountCode
DiscountLevel
- Returns the list of DiscountLevel objectsget
- Returns a single DiscountLevel objectget

Employees

Overview
DeclaredTips
Department
Employee
EmployeeRoleEstablishment
Permission
- Returns the list of Permission objectsget
- Returns a single Permission objectget
Role
- Returns the list of role objectsget
- Find Role by IDget

General

Overview
Address
BusinessActionLog
BusinessDay
Company
- Returns the list of Company objectsget
- Find Company by IDget
Currency
Device
- Returns the list of Device objectsget
- Find Device by IDget
Establishment
PosStation
- Returns the list of PosStation objectsget
- Find PosStation by IDget
RevenueCenter
SystemSetting
- Returns the list of SystemSetting objectsget
- Find SystemSetting by IDget
SystemSettingOption
- Returns the list of SystemSettingOption objectsget
- Find SystemSettingOption by IDget
Timetable
TimetableItem
User
- Returns the list of User objectsget
- Find User by IDget

House Accounts

Overview
HouseAccount
HouseAccountPayment
HouseAccountTransaction
- Returns the list of HouseAccountTransaction objectsget
- Find HouseAccountTransaction by IDget

Inventory

Overview
CurrentStock
- Returns the list of CurrentStock objectsget
IngredientInventory
Inventory
InventoryReceipt
InventoryUnit
InventoryXProduct
InventoryXIngredient
PhysicalInventory
- Returns the list of PhysicalInventory objectsget
- Find PhysicalInventory by IDget
PhysicalInventoryItem
- Returns the list of PhysicalInventoryItem objectsget
- Find PhysicalInventoryItem by IDget
PhysicalInventoryScannedItem
PhysicalInventorySection
Stocktake
- Returns the list of Stocktake objectsget
- Find Stocktake by IDget
StocktakeItem
- Returns the list of StocktakeItem objectsget
- Find StocktakeItem by IDget
StocktakeScannedItem
StocktakeSection
Transfer
- Returns a list of Transfer objectsget
- Returns a list of Transfer objectsget
TransferItem
- Returns the list of TransferItem objectsget
- Find TransferItem by IDget
TransferReceipt
- Returns the list of TransferReceipt objectsget
- Find TransferReceipt by IDget
TransferReceiptItem
- Returns the list of TransferReceiptItem objectsget
- Find TransferReceiptItem by IDget

Orders

Overview
AppliedServiceFee
AppliedTaxOrder
AppliedTaxOrderItem
CustomPaymentType
- Returns the list of CustomPaymentType objectsget
- Returns a single CustomPaymentType objectget
CustomOrderOption
- Returns the list of CustomOrderOption objectsget
ModifierItem
Order
OrderDataDiff
- Returns the list of OrderDataDiff objectsget
- Returns a single OrderDataDiff objectget
OrderExchange
OrderExchangeItem
OrderHistory
OrderItem
OrderItemCatering
- Returns the list of OrderItemCatering objectsget
- Returns a single OrderItemCatering objectget
OrderItemCommission
OrderItemDataDiff
- Returns the list of OrderItemDataDiff objectsget
- Find OrderItemDataDiff by IDget
OrderTaxBreakDown
- Returns the list of OrderTaxBreakDown objectsget
- Find OrderTaxBreakDown by IDget
Package
Payment
PaymentType
Return
ReturnedItem

Products

Overview
Attribute
AttributeValue
ComboProductSet
- Returns the list of ComboProductSet objectsget
- Find ComboProductSet by IDget
ComboProductSetProduct
- Returns the list of ComboProductSetProduct objectsget
- Find ComboProductSetProduct by IDget
CustomMenu
- Returns the list of CustomMenu objectsget
- Find CustomMenu by IDget
DynamicCombo
- Returns the list of DynamicCombo objectsget
- Find DynamicCombo by IDget
DynamicComboUpsellSlot
- Return the list of DynamicComboUpsellSlot objects.get
- Find DynamicComboUpsellSlot by IDget
Ingredient
IngredientRecipe
Modifier
ModifierClass
ModifierDiscount
ModifierRecipe
PriceTier
- Returns the list of PriceTier objectsget
- Find PriceTier by IDget
Product
ProductCategory
ProductClass
ProductGroup
ProductGroupAction
ProductModifier
ProductModifierClass
ProductPriceLifeCycleAction
ProductPriceTierPrice
- Returns the list of ProductPriceTierPrice objectsget
- Find ProductPriceTierPrice by IDget
ProductRecipe
ProductSerial
- Return the list of ProductSerial objects.get
- Find ProductSerial by IDget
ProductVariablePrice
ServiceFee
Surcharge
UnitType

Purchase Orders

Overview
IngredientPurchase
- Returns the list of IngredientPurchase objectsget
- Find IngredientPurchase by IDget
ProductPurchase
- Returns the list of ProductPurchase objectsget
- Returns a single ProductPurchase objectget
ProductPurchaseOrderItem
PurchaseLedger
PurchaseOrder
PurchaseOrderInvoice
PurchaseOrderItem
Vendor
VendorEstablishment
VendorOrderableItem
ViewPurchaseOrder
- Returns a read-only list PurchaseOrder objectsget
- View PurchaseOrder by IDget
ViewPurchaseOrderProduct
- Returns the list of ViewPurchaseOrderProduct objectsget
- Returns a single ViewPurchaseOrderProduct objectget

Scheduling

Overview
TimeSchedule
TimeScheduleRule
- Returns the list of TimeScheduleRule objectsget
- Find TimeScheduleRule by IDget
TimeSheetEntry

Tables

Overview
Table
TableSection
TableTag

Tax

Overview
Tax
TaxAgency
TaxCode
TaxProductGroup
- Returns the list of TaxProductGroup objectsget
- Find TaxProductGroup by IDget
TaxRate
TaxTable

Weborders

Overview
CalculateCart
- Calculates Cart Totalspost
ValidateCart
- Validates Cart and returns Cart objectpost
SubmitCart
- Submits Cart and returns orderpost
Modifiers
- Returns a list of WebordersModifierClass objectsget
Menu
- Returns an entire menuget
ProductCategories
- Returns the list of product categoriesget
Products
- Return a list of productsget
Attributes
- Returns a list of attributes and child products of the parent productget
ProductUpcharge
- Returns info about linked combos attached to productget
ProductSets
- Returns info about group combos attached to productget
SystemSettings
- Returns a list of SystemSettingsget

More Resources

Inventory X
Reporting
- Overview

Powered by

Customers
Customer

Add a new Customer

post

https://api-sandbox-revel.revelup.com/resources/Customer/

Add a new Customer

Language

Credentials

Response

Click Try It! to start a request and see the response here!