Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Introduction
  • Oracle Food and Beverage API Design Standards
    • Paths
      • Summary Field
      • Description
      • OperationId
    • Producing application/json
    • Accept header
    • Multiple response formats
    • Errors
    • POST
    • Response Codes
    • Resources
      • Currencies
      • Dates
      • Date-Times
      • Translated String
      • Option String
    • Pre Delete Dependency Checks
    • Audit Trail
• Authentication and Authorization
  • Step 1: Create Simphony Configuration and Content API account
  • Step 2: Authorize with OpenID
  • Step 3: API Account Sign In
  • Step 4: Get/Refresh a Token
  • Step 5: Using the id_token in API Calls
• Search Criteria
  • Include Parameters
    • Include Parameters Considerations
  • Header Parameters
  • Body Parameters
  • Response Parameters
• Hierarchy and Definition Management Concepts
  • Hierarchy
    • Definitions
    • Default Hierarchy
    • Zones
    • Default Hierarchy and Zones
    • HierStrucID and HierUnitid
  • Inheritance
    • Conflicting Definitions
• Status Codes
• API Usage Examples
  • Adding a Menu Item Using Masters, Definitions, and Prices
    • Step 1: Add menu item master
    • Step 2: Add menu item definition
    • Step 3: Add menu item price
    • Step 4: Validate Configuration

Tasks

• Devices
  • Kitchen Display Clients
    • Add Kitchen Display Clients
    • Delete Kitchen Display Clients
    • Get Kitchen Display Clients
    • Update Kitchen Display Clients
  • Kitchen Display Controllers
    • Add Kitchen Display Controllers
    • Delete Kitchen Display Controllers
    • Get Kitchen Display Controllers
    • Update Kitchen Display Controllers
  • Order Devices
    • Get Order Devices
    • Update Order Devices
  • Print Classes
    • Add Print Classes
    • Delete Print Classes
    • Get Print Classes
    • Update Print Classes
  • Printers
    • Add Printers
    • Delete Printers
    • Get Printers
    • Update Printers
  • Workstation Classes
    • Add Workstation Classes
    • Delete Workstation Classes
    • Get Workstation Classes
    • Update Workstation Classes
  • Workstation Devices
    • Add Workstation Devices
    • Delete Workstation Devices
    • Get Workstation Devices
    • Update Workstation Devices
  • Workstations
    • SPI Client Certificate
      • Add SPI client certificate
      • Delete SPI Client Certificate
      • Download SPI Client Certificate
      • Update SPI Client Certificate
    • SPI Server Certificate
      • Add SPI Server Certificate
      • Delete SPI server certificate
      • Download SPI Server Certificate
      • Update SPI server certificate
    • Workstations
      • Add Workstations
      • Delete Workstations
      • Get Workstations
      • Update Workstations
• Employees
  • Employee Class Operators
    • Get Employee Class Operators
    • Update Employee Class Operators
  • Employee Classes
    • Add Employee Classes
    • Delete Employee Classes
    • Get Employee Classes
    • Update Employee Classes
  • Employee EMC Visibility
    • Add Employee EMC Visibility
    • Delete Employee EMC Visibility
    • Get Employee EMC Visibility
    • Update Employee EMC Visibility
  • Employee Job Codes
    • Get Employee Job Codes
  • Employee Properties
    • Add Employee Properties
    • Delete Employee Properties
    • Get Employee Properties
    • Update Employee Properties
  • Employee Property Operators
    • Add Employee Property Operator
    • Delete Employee Property Operator
    • Get Employee Property Operators
    • Update Employee Property Operator
  • Employee Roles
    • Assign Employee Roles
    • Delete Employee Roles
    • Get Employee Roles
    • Update Employee Roles
  • Employees
    • Add Employee
    • Checks the existence of references to the object in the database.
    • Delete Employees
    • Get Employees
    • Update Employees
  • Roles
    • Add Roles
    • Delete Roles
    • Get Roles
    • Update Roles
• Hierarchy
  • Hierarchy
    • Get Hierarchies
  • Location Parameters
    • Add Location Parameters
    • Delete Location Parameters
    • Get Location Parameters
    • Update Location Parameters
  • Locations
    • Add Locations
    • Checks the existence of references to the object in the database.
    • Delete Locations
    • Get Locations
    • Update Locations
  • Revenue Center Parameters
    • Add Revenue Center Parameters
    • Delete Revenue Center Parameters
    • Get Revenue Center Parameters
    • Update Revenue Center Parameters
  • Revenue Centers
    • Add Revenue Centers
    • Checks the existence of references to the object in the database.
    • Delete Revenue Centers
    • Get Revenue Centers
    • Update Revenue Centers
  • Zones
    • Get a list of Zones
• Menu Items
  • Barcodes
    • Add Barcodes
    • Delete Barcodes
    • Get Barcodes
    • Update Barcodes
  • Combo Meals
    • Combo Meal Side Group Prices
      • Add Combo Meal Side Group Prices
      • Delete Combo Meal Side Group Prices
      • Get Combo Meal Side Group Prices
      • Update Combo Meal Side Group Prices
    • Combo Meal Side Groups
      • Add Combo Meal Side Groups
      • Delete Combo Meal Side Groups
      • Get Combo Meal Side Groups
      • Update Combo Meal Side Groups
    • Combo Meals
      • Add Combo Meals
      • Delete Combo Meals
      • Get Combo Meals
      • Update Combo Meals
  • Combo Side Groups
    • Combo Side Group Item
      • Add Combo Side Group Items
      • Delete Combo Side Group Items
      • Get Combo Side Group Items
      • Update Combo Side Group Items
    • Combo Side Group Item Prices
      • Add Combo Side Group Item Prices
      • Delete Combo Side Group Item Prices
      • Get Combo Side Group Item Prices
      • Update Combo Side Group Item Prices
    • Combo Side Groups
      • Add Combo Side Groups
      • Delete Combo Side Groups
      • Get Combo Side Groups
      • Update Combo Side Groups
  • Condiment Groups
    • Add Condiment Groups
    • Delete Condiment Groups
    • Get Condiment Groups
    • Update Condiment Groups
  • Condiment Set Items
    • Add Condiment Set Items
    • Delete Condiment Set Items
    • Get Condiment Set Items
    • Update Condiment Set Items
  • Condiment Sets
    • Add Condiment Sets
    • Delete Condiment Sets
    • Get Condiment Sets
    • Update Condiment Sets
  • Family Group Consumer Facing Content
    • Add Family Group Consumer Facing Content
    • Delete Family Group Consumer Facing Content
    • Download Family Group Consumer Facing Content
    • Get Family Group Consumer Facing Content
    • Update Family Group Consumer Facing Content
  • Family Groups
    • Add Family Groups
    • Delete Family Groups
    • Get Family Groups
    • Update Family Groups
  • Major Groups
    • Add Major Groups
    • Delete Major Groups
    • Get Major Groups
    • Update Major Groups
  • Menu Item 2
    • Get Integrated Menu Items
  • Menu Item Class
    • Add Menu Item Classes
    • Delete Menu Item Classes
    • Get Menu Item Classes
    • Update Menu Item Classes
  • Menu Item Definitions
    • Menu Item Definition Consumer Facing Content
      • Add Menu Item Definition Consumer Facing Content
      • Delete Menu Item Definition Consumer Facing Content
      • Download Menu Item Definition Consumer Facing Content
      • Get Menu Item Defintion Consumer Facing Content
      • Update Menu Item Definition Consumer Facing Conent
    • Menu Item Definition Default Condiments
      • Delete Menu Item Definition Default Condiments
      • Get Menu Item Definition Default Condiments
      • Insert Menu Item Definition Default Condiments
      • Update Menu Item Definition Default Condiments
    • Menu Item Definitions
      • Add Menu Item Definitions
      • Delete Menu Item Definitions
      • Get Menu Item Definitions
      • preDelete Menu Item Definitions
      • Update Menu Item Definitions
  • Menu Item Master
    • Add Menu Item Masters
    • Delete Menu Item Masters
    • Get Menu Item Masters
    • PreDelete Check Menu Item Masters
    • Update Menu Item Masters
  • Menu Item Prices
    • Add Menu Item Prices
    • Delete Menu Item Prices
    • Get Menu Item Prices
    • Update Menu Item Prices
  • Menu Items
    • Get Menu Items
• Other
  • Clone Configuration
    • Create clone request
    • Get list of successful clone requests
    • Get status of clone request
    • Import configuration data
• Sales
  • Discounts
    • Discount
      • Add Discounts
      • Delete Discounts
      • Get Discounts
      • Update Discounts
    • Discount Award Groups
      • Add Discount Award Groups
      • Delete Discount Award Groups
      • Get Discount Award Groups
      • Update Discount Award Groups
    • Discount Itemizers
      • Add Discount Itemizers
      • Delete Discount Itemizers
      • Get Discount Itemizers
      • Update Discount Itemizers
    • Discount Trigger Groups
      • Add Discount Trigger Groups
      • Delete Discount Trigger Groups
      • Get Discount Trigger Groups
      • Update Discount Trigger Groups
  • Service Charge Groups
    • Service Charge Group Details
      • Add Service Charge Group Details
      • Delete Service Charge Group Details
      • Get Service Charge Group Details
      • Update Service Charge Group Details
    • Service Charge Groups
      • Add Service Charge Groups
      • Delete Service Charge Groups
      • Get Service Charge Groups
      • Update Service Charge Groups
  • Service Charge Itemizers
    • Add Service Charge Itemizers
    • Delete Service Charge Itemizers
    • Get Service Charge Itemizers
    • Update Service Charge Itemizers
  • Service Charges
    • Add Service Charges
    • Delete Service Charges
    • Get Service Charges
    • Update Service Charges
  • Tax Classes
    • Add Tax Classes
    • Delete Tax Classes
    • Get Tax Classes
    • Update Tax Classes
  • Tax Parameters
    • Add Tax Parameters
    • Delete Tax Parameters
    • Get Tax Parameters
    • Update Tax Parameters
  • Taxes
    • Tax Breakpoints
      • Get Tax Breakpoints
      • Update Tax Breakpoints
    • Tax Rates
      • Add Tax Rates
      • Delete Tax Rates
      • Get Tax Rates
      • Update Tax Rates
  • Tender Media
    • Add Tender Media
    • Delete Tender Media
    • Get Tender Media
    • Update Tender Media
• Setup
  • Auto Menu Levels
    • Add Auto Menu Levels
    • Delete Auto Menu Levels
    • Get Auto Menu Levels
    • Update Auto Menu Levels
  • CAL Deployment Schedules
    • Add CAL Deployment Schedules
    • Delete CAL Deployment Schedules
    • Get CAL Deployment Schedules
    • Update CAL Deployment Schedules
  • CAL Packages
    • Get CAL Packages
  • Currencies
    • Add Currencies
    • Delete Currencies
    • Get Currencies
    • Update Currencies
  • Currency Parameters
    • Add a Currency Parameter.
    • Delete the currency parameter.
    • Gets all the currencies.
    • Update the currency parameter.
  • Custom Content
    • Add Custom Content
    • Delete Custom Content
    • Download Custom Content.
    • Get Custom Content
    • Update Custom Content
  • Effectivity Groups
    • Add Effectivity Groups
    • Delete Effectivity Groups
    • Get Effectivity Groups
    • Update Effectivity Groups
  • Languages
    • Add Languages
    • Delete Languages
    • Get Languages
    • Update Languages
  • Menu Levels
    • Menu Level Entries
      • Add Menu Level Entries
      • Delete Menu Level Entries
      • Get Menu Level Entries
      • Update Menu Level Entries
    • Menu Levels
      • Add Menu Levels
      • Delete Menu Levels
      • Get Menu Levels
      • Update Menu Levels
  • Order Types
    • Order Type Names
      • Add Order Types
      • Delete Order Types
      • Get Order Types
      • Update Order Types
    • Order Type Parameters
      • Add Order Type Parameters
      • Delete Order Type Parameters
      • Get Order Types Parameters
      • Update Order Type Parameters
  • Payment Drivers
    • Payment Driver Configurations
      • Get Payment Driver Configuration
      • Update Payment Driver Configuration
    • Payment Drivers
      • Add Payment Drivers
      • Delete Payment Drivers
      • Download Payment Drivers
      • Get Payment Drivers
      • Update Payment Drivers
  • Print Logos
    • Add Print Logos
    • Delete Print Logos
    • Download Print Logos
    • Get Print Logos
    • Update Print Logos
  • Report Groups
    • Add Report Groups
    • Delete Report Groups
    • Get Report Groups
    • Update Report Groups
  • Screen Look Ups (SLUs)
    • Screen Look Up Consumer Facing Content
      • Add SLU Consumer Facing Content
      • Delete SLU Consumer Facing Content
      • Download SLU Consumer Facing Content
      • Get SLU Consumer Facing Content
      • Update SLU Consumer Facing Content
    • Screen Look Ups(SLUs)
      • Add SLUs
      • Delete SLUs
      • Get SLUs
      • Update SLUs