Available Oracle Simphony APIs

Tanisha Ray

Updated November 22, 2024 17:18

When you configure an export, import, or other type of flow step using the prebuilt Oracle Simphony connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Oracle Simphony API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Devices: Kitchen display clients	Get kitchen display clients	X
	Add kitchen display clients		X
	Update kitchen display clients		X
	Delete kitchen display clients		X
	Get kitchen display controllers	X
	Add kitchen display controllers		X
	Update kitchen display controllers		X
	Delete kitchen display controllers		X
Devices: Order devices	Get order devices	X
Devices: Order devices	Update order devices		X
Devices: Print classes	Get print classes	X
	Add print classes		X
	Update print classes		X
	Delete print classes		X
Devices: Printers	Get printers	X
	Add printers		X
	Update printers		X
	Delete printers		X
Devices: Workstation classes	Get workstation classes	X
	Add workstation classes		X
	Update workstation classes		X
	Delete workstation classes		X
Devices: Workstation devices	Get workstation devices	X
	Add workstation devices		X
	Update workstation devices		X
	Delete workstation devices		X
Devices: Workstations: SPI client certificate	Add SPI client certificate		X
	Update SPI client certificate		X
	Delete SPI client certificate		X
	Add SPI server certificate		X
	Update SPI server certificate		X
	Delete SPI server certificate		X
Devices: Workstations	Get workstations	X
	Add workstations		X
	Update workstations		X
	Delete workstations		X
Employees: Cashiers	Get cashiers	X
	Add cashiers		X
	Update cashiers		X
	Delete cashiers		X
Employees: Employee class operators	Get employee class operators	X
Employees: Employee class operators	Update employee class operators		X
Employees: Employee classes	Get employee classes	X
	Add employee classes		X
	Update employee classes		X
	Delete employee classes		X
Employees: Employee EMC visibility	Get employee EMC visibility	X
	Add employee EMC visibility		X
	Update employee EMC visibility		X
	Delete employee EMC visibility		X
Employees: Employee job codes	Get employee job codes	X
Employees: Employee properties	Get employee properties	X
	Add employee properties		X
	Update employee properties		X
	Delete employee properties		X
Employees: Employee property operators	Get employee property operators	X
	Add employee property operator		X
	Update employee property operator		X
	Delete employee property operator		X
Employees: Employee roles	Get employee roles	X
	Add employee roles		X
	Update employee roles		X
	Delete employee roles		X
Employees: Employees	Add employee		X
	Pre-delete employees		X
	Delete employees		X
	Get employees	X
	Update employees		X
Employees: Employees 2	Add basic employees		X
	Pre-delete basic employees		X
	Delete basic employees		X
	Get basic employees	X
	Update basic employees		X
Employees: Roles	Get roles	X
	Add roles		X
	Update roles		X
Employees: Roles	Delete roles		X
Hierarchy: Hierarchy	Get hierarchies	X
Hierarchy: Locations: Location parameters	Get location parameters	X
	Add location parameters		X
	Update location parameters		X
	Delete location parameters		X
Hierarchy: Locations	Add locations		X
	Pre-delete locations		X
	Delete locations		X
	Get locations	X
	Update locations		X
Hierarchy: Locations: Parent enterprise levels	Get enterprise levels	X
Hierarchy: Locations: Reporting hierarchy relationships	Get reporting hierarchy levels	X
	Get reporting hierarchy relationships	X
	Update reporting hierarchy relationships		X
	Delete reporting hierarchy relationships		X
Hierarchy: Revenue centers: Revenue center masters	Get revenue center masters	X
	Add revenue center masters		X
	Update revenue center masters		X
Hierarchy: Revenue centers: Revenue center parameters	Get revenue center parameters	X
	Add revenue center parameters		X
	Update revenue center parameters		X
	Delete revenue center parameters		X
Hierarchy: Revenue centers	Get revenue centers	X
	Add revenue centers		X
	Update revenue centers		X
	Delete revenue centers		X
	Checks the existence of references to the object in the database.		X
Hierarchy: Zones	Get zones	X
Menu items: Barcodes	Get barcodes	X
	Add barcodes		X
	Update barcodes		X
	Delete barcodes		X
	Bulk insert barcodes		X
Menu items: Combo meals: Combo meal side group prices	Get combo meal side group prices	X
	Add combo meal side group prices		X
	Update combo meal side group prices		X
	Delete combo meal side group prices		X
Menu items: Combo meals: Combo meal side groups	Get combo meal side groups	X
	Add combo meal side groups		X
	Update combo meal side groups		X
	Delete combo meal side groups		X
Menu items: Combo meals	Get combo meals	X
	Add combo meals		X
	Update combo meals		X
	Delete combo meals		X
	Pre-delete check combo meals		X
	Bulk insert combo meals		X
Menu items: Combo side groups: Combo side group item	Get combo side group items	X
	Add combo side group items		X
	Update combo side group items		X
	Delete combo side group items		X
	Bulk insert combo side group items		X
Menu items: Combo side groups: Combo side group item prices	Get combo side group item prices	X
	Add combo side group item prices		X
	Update combo side group item prices		X
	Delete combo side group item prices		X
Menu items: Combo side groups	Get combo side groups	X
	Add combo side groups		X
	Update combo side groups		X
	Delete combo side groups		X
	Bulk insert combo side groups		X
Menu items: Condiment groups	Get condiment groups	X
	Add condiment groups		X
	Update condiment groups		X
	Delete condiment groups		X
Menu items: Condiment sets	Get condiment sets	X
	Add condiment sets		X
	Update condiment sets		X
	Delete condiment sets		X
Menu items: Condiment sets: Condiment set items	Get condiment set items	X
	Add condiment set items		X
	Update condiment set items		X
	Delete condiment set items		X
Menu items: Family group consumer-facing content	Get family group consumer-facing content	X
	Add family group consumer-facing content		X
	Update family group consumer-facing content		X
	Delete family group consumer-facing content		X
	Download family group consumer-facing content		X
Menu items: Family groups	Get family groups	X
	Add family groups		X
	Update family groups		X
	Delete family groups		X
	Get major groups	X
	Add major groups		X
	Update major groups		X
	Delete major groups		X
Menu items: Menu item 2	Get menu items 2	X
Menu items: Menu item class	Get menu item classes	X
	Add menu item classes		X
	Update menu item classes		X
	Delete menu item classes		X
Menu items: Menu item definitions: Menu item definition consumer-facing content	Get menu item definition consumer-facing content	X
	Add menu item definition consumer-facing content		X
	Update menu item definition consumer-facing content		X
	Delete menu item definition consumer-facing content		X
	Download menu item definition consumer-facing content		X
Menu items: Menu item definitions: Menu item definition default condiments	Get menu item definition default condiments	X
	Insert menu item definition default condiments		X
	Update menu item definition default condiments		X
	Delete menu item definition default condiments		X
Menu items: Menu item definitions	Get menu item definitions	X
	Add menu item definitions		X
	Update menu item definitions		X
	Delete menu item definitions		X
	Pre-delete menu item definitions		X
	Bulk insert menu item definitions		X
Menu items: Menu item groups: Menu item group details	Add menu item group details		X
	Delete menu item group details		X
	Get menu item group details	X
	Update menu item group details		X
	Bulk insert menu item group details		X
Menu items: Menu item groups	Add menu item groups		X
	Delete menu item groups		X
	Get menu item groups	X
	Update menu item groups		X
	Bulk insert menu item groups		X
Menu items: Menu item master	Get menu item masters	X
	Add menu item masters		X
	Update menu item masters		X
	Delete menu item masters		X
	Pre-delete check menu item masters		X
	Bulk insert menu item master		X
Menu items: Menu item master effectivity	Get menu item master effectivity groups	X
	Add menu item master effectivity group		X
	Update menu item master effectivity group		X
	Delete menu item master effectivity group		X
Menu items: Menu item master groups	Add menu item master groups		X
	Delete menu item master groups		X
	Get menu item master groups	X
	Update menu item master groups		X
Menu items: Menu item prices	Get menu item prices	X
	Add menu item prices		X
	Update menu item prices		X
	Delete menu item prices		X
	Bulk insert menu item prices		X
Menu items: Menu items	Get menu items	X
Other: Bulk request status	Gets the status of a bulk processing request	X
Other: Clone configuration	Create clone		X
	Get clone request status	X
	Get clones	X
	Import clone		X
Other: Get available object numbers	Get available object numbers	X
Other: Release versions	Get version information	X
Sales: Discount itemizers	Get discount itemizers	X
	Add discount itemizers		X
	Update discount itemizers		X
	Delete discount itemizers		X
Sales: Discounts: Discount	Get discounts	X
	Add discounts		X
	Update discounts		X
	Delete discounts		X
Sales: Discounts: Discount award groups	Get discount award groups	X
	Add discount award groups		X
	Update discount award groups		X
	Delete discount award groups		X
	Get discount trigger groups	X
	Add discount trigger groups		X
	Update discount trigger groups		X
	Delete discount trigger groups		X
Sales: Service charge groups: Service charge group details	Get service charge group details	X
	Add service charge group details		X
	Update service charge group details		X
	Delete service charge group details		X
Sales: Service charge groups	Get service charge groups	X
	Add service charge groups		X
	Update service charge groups		X
	Delete service charge groups		X
Sales: Service charge itemizers	Get service charge itemizers	X
	Add service charge itemizers		X
	Update service charge itemizers		X
	Delete service charge itemizers		X
Sales: Service charges	Get service charges	X
	Add service charges		X
	Update service charges		X
	Delete service charges		X
Sales: Tax classes	Get tax classes	X
	Add tax classes		X
	Update tax classes		X
	Delete tax classes		X
Sales: Tax parameters	Get tax parameters	X
	Add tax parameters		X
	Update tax parameters		X
	Delete tax parameters		X
Sales: Taxes: Tax breakpoints	Get tax breakpoints	X
Sales: Taxes: Tax breakpoints	Update tax breakpoints		X
Sales: Taxes: Tax rates	Get tax rates	X
	Add tax rates		X
	Update tax rates		X
	Delete tax rates		X
Sales: Tender media	Get tender media	X
	Add tender media		X
	Update tender media		X
	Delete tender media		X
Setup: Auto menu levels	Get auto menu levels	X
	Add auto menu levels		X
	Update auto menu levels		X
	Delete auto menu levels		X
Setup: Cal deployment schedules	Get cal deployment schedules	X
	Add cal deployment schedules		X
	Update cal deployment schedules		X
	Delete cal deployment schedules		X
Setup: Cal packages	Get cal packages	X
Setup: Cash management receptacle templates	Get cash management receptacle templates	X
	Add cash management receptacle templates		X
	Delete cash management receptacle templates		X
	Update cash management receptacle templates		X
Setup: Currencies	Add currencies		X
	Delete currencies		X
	Get currencies	X
	Update currencies		X
Setup: Currency availability	Get currency availability	X
	Add currency availability		X
	Update currency availability		X
	Delete currency availability		X
Setup: Currency conversions	Get currency conversions	X
	Add currency conversion		X
	Update currency conversion		X
	Delete currency conversion		X
Setup: Currency parameters	Get currency parameters	X
	Add currency parameters		X
	Update currency parameters		X
	Delete currency parameters		X
Setup: Custom content	Get custom content	X
	Add custom content		X
	Update custom content		X
	Delete custom content		X
	Download custom content		X
Setup: Data extensions	Add data extensions		X
	Delete data extensions		X
	Get data extensions	X
	Update data extensions		X
Setup: Effectivity groups	Get effectivity groups	X
	Add effectivity groups		X
	Update effectivity groups		X
	Delete effectivity groups		X
Setup: Effectivity groups: Enable effectivity groups	Get enable effectivity groups	X
	Add enable effectivity groups		X
	Update enable effectivity groups		X
	Delete enable effectivity groups		X
Setup: Headers trailers	Get headers/trailers	X
	Add headers/trailers		X
	Update headers/trailers		X
	Delete header/trailer		X
Setup: Languages	Get languages	X
	Add languages		X
	Update languages		X
	Delete languages		X
Setup: Locale	Add locales		X
	Delete locales		X
	Get locales	X
	Update locales		X
Setup: Menu levels: Menu-level entries	Get menu-level entries	X
	Add menu-level entries		X
	Update menu-level entries		X
	Delete menu-level entries		X
Setup: Menu levels	Get menu levels	X
	Add menu levels		X
	Update menu levels		X
	Delete menu levels		X
Setup: Order channels: Order channel parameters	Get order channel parameters	X
	Add order channel parameters		X
	Update order channel parameters		X
	Delete order channel parameters		X
Setup: Order channels	Get order channels	X
	Add order channels		X
	Update order channels		X
Setup: Order types: Order type names	Get order types	X
	Add order types		X
	Update order types		X
	Delete order types		X
Setup: Order types: Order type parameters	Get order type parameters	X
	Add order type parameters		X
	Update order type parameters		X
	Delete order type parameters		X
Setup: Payment drivers: Payment driver configurations	Get payment driver configuration	X
Setup: Payment drivers: Payment driver configurations	Update payment driver configuration		X
Setup: Payment drivers: Payment drivers	Get payment drivers	X
	Add payment drivers		X
	Update payment drivers		X
	Delete payment drivers		X
	Download payment drivers		X
Setup: Print logos	Get print logos	X
	Add print logos		X
	Update print logos		X
	Delete print logos		X
	Download print logos		X
Setup: Report groups	Get report groups	X
	Add report groups		X
	Update report groups		X
	Delete report groups		X
Setup: Sales itemizers	Add sales itemizers		X
	Delete sales itemizers		X
	Get sales itemizers	X
	Update sales itemizers		X
Setup: Screen look UPS: Screen look up consumer facing content	Get SLU consumer-facing content	X
	Add SLU consumer-facing content		X
	Update SLU consumer-facing content		X
	Delete SLU consumer-facing content		X
	Download SLU consumer-facing content		X
Setup: Screen look-ups	Get screen look-ups	X
	Add screen look-ups		X
	Update screen look-ups		X
	Delete screen look-ups		X
Setup: Tag groups	Add tag groups		X
	Delete tag groups		X
	Get tag groups	X
	Update tag groups		X
Setup: Tags	Add tags		X
	Delete tags		X
	Get tags	X
	Update tags		X