All REST Endpoints

Devices/Kitchen Display Clients

These APIs maintain Kitchen Display Clients

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Kitchen Display Clients
Method: post
Path: /config/sim/v1/devices/KitchenDisplays
Delete Kitchen Display Clients
Method: post
Path: /config/sim/v1/devices/deleteKitchenDisplays
Get Kitchen Display Clients
Method: post
Path: /config/sim/v1/devices/getKitchenDisplays
Update Kitchen Display Clients
Method: post
Path: /config/sim/v1/devices/updateKitchenDisplays
Devices/Kitchen Display Controllers

These APIs maintain Kitchen Display Controllers

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Kitchen Display Controllers
Method: post
Path: /config/sim/v1/devices/KitchenDisplayControllers
Delete Kitchen Display Controllers
Method: post
Path: /config/sim/v1/devices/deleteKitchenDisplayControllers
Get Kitchen Display Controllers
Method: post
Path: /config/sim/v1/devices/getKitchenDisplayControllers
Update Kitchen Display Controllers
Method: post
Path: /config/sim/v1/devices/updateKitchenDisplayControllers
Devices/Order Devices

These APIs maintain Order Devices:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Order Devices
Method: post
Path: /config/sim/v1/devices/getOrderDevices
Update Order Devices
Method: post
Path: /config/sim/v1/devices/updateOrderDevices
Devices/Print Classes

These APIs maintain Print Classes:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Print Classes
Method: post
Path: /config/sim/v1/devices/printerclasses
Delete Print Classes
Method: post
Path: /config/sim/v1/devices/deletePrinterClasses
Get Print Classes
Method: post
Path: /config/sim/v1/devices/getPrinterClasses
Update Print Classes
Method: post
Path: /config/sim/v1/devices/updateprinterClasses
Devices/Printers

These APIs maintain Printers:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Printers
Method: post
Path: /config/sim/v1/devices/printers
Delete Printers
Method: post
Path: /config/sim/v1/devices/deletePrinters
Get Printers
Method: post
Path: /config/sim/v1/devices/getprinters
Update Printers
Method: post
Path: /config/sim/v1/devices/updatePrinters
Devices/Workstation Classes

These APIs maintain Workstation Classes

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Workstation Classes
Method: post
Path: /config/sim/v1/devices/workstationClasses
Delete Workstation Classes
Method: post
Path: /config/sim/v1/devices/deleteWorkstationClasses
Get Workstation Classes
Method: post
Path: /config/sim/v1/devices/getWorkstationClasses
Update Workstation Classes
Method: post
Path: /config/sim/v1/devices/updateWorkstationClasses
Devices/Workstation Devices

These APIs maintain devices configured to work with a workstations such as Barcode Scanners, Payment Devices, Cash Drawers etc.

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Workstation Devices
Method: post
Path: /config/sim/v1/devices/workstations/devices
Delete Workstation Devices
Method: post
Path: /config/sim/v1/devices/workstations/deleteDevices
Get Workstation Devices
Method: post
Path: /config/sim/v1/devices/workstations/getDevices
Update Workstation Devices
Method: post
Path: /config/sim/v1/devices/workstations/updateDevices
Devices/Workstations/SPI Client Certificate

These APIs maintain SPI Client Certificate for a workstation of the organization:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add SPI client certificate
Method: post
Path: /content/sim/v1/devices/workstations/spiClientCertificate
Delete SPI Client Certificate
Method: post
Path: /content/sim/v1/devices/workstations/deleteSPIClientCertificate
Update SPI Client Certificate
Method: post
Path: /content/sim/v1/devices/workstations/updateSPIclientCertificate
Devices/Workstations/SPI Server Certificate

These APIs maintain SPI Server Certificate for a workstation of the organization:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add SPI Server Certificate
Method: post
Path: /content/sim/v1/devices/workstations/spiServerCertificate
Delete SPI server certificate
Method: post
Path: /content/sim/v1/devices/workstations/deleteSPIserverCertificate
Update SPI server certificate
Method: post
Path: /content/sim/v1/devices/workstations/updateSPIserverCertificate
Devices/Workstations/Workstations

These APIs maintain workstations:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Workstations
Method: post
Path: /config/sim/v1/devices/workstations
Delete Workstations
Method: post
Path: /config/sim/v1/devices/deleteworkstations
Get Workstations
Method: post
Path: /config/sim/v1/devices/getWorkstations
Update Workstations
Method: post
Path: /config/sim/v1/devices/updateWorkstations
Employees/Cashiers

These APIs maintain the cashiers:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 This endpoint was added in the API version 23.3.1
Add Cashiers
Method: post
Path: /config/sim/v1/employees/cashiers
Delete Cashiers
Method: post
Path: /config/sim/v1/employees/deleteCashiers
Get Cashiers
Method: post
Path: /config/sim/v1/employees/getCashiers
Update Cashiers
Method: post
Path: /config/sim/v1/employees/updateCashiers
Employees/Employee Class Operators

These APIs maintain the revenue center operator options for the employee classes:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 This endpoint was added in the API version 23.3.1
Get Employee Class Operators
Method: post
Path: /config/sim/v1/employees/classes/getOperators
Update Employee Class Operators
Method: post
Path: /config/sim/v1/employees/classes/updateOperators
Employees/Employee Classes

These APIs maintain Employee Classes:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Employee Classes
Method: post
Path: /config/sim/v1/employees/classes
Delete Employee Classes
Method: post
Path: /config/sim/v1/employees/deleteClasses
Get Employee Classes
Method: post
Path: /config/sim/v1/employees/getClasses
Update Employee Classes
Method: post
Path: /config/sim/v1/employees/updateClasses
Employees/Employee EMC Visibility

These APIs maintain the EMC modules visible to the employee:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Employee EMC Visibility
Method: post
Path: /config/sim/v1/employees/emcVisibility
Delete Employee EMC Visibility
Method: post
Path: /config/sim/v1/employees/deleteEmployeeVisibility
Get Employee EMC Visibility
Method: post
Path: /config/sim/v1/employees/getEMCVisibility
Update Employee EMC Visibility
Method: post
Path: /config/sim/v1/employees/updateEmployeeVisibility
Employees/Employee Job Codes

These APIs maintain the job codes at the property assigned to the employee:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Employee Job Codes
Method: post
Path: /config/sim/v1/employees/properties/getJobCodes
Employees/Employee Properties

These APIs maintain the properties assigned to the employee:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Employee Properties
Method: post
Path: /config/sim/v1/employees/properties
Delete Employee Properties
Method: post
Path: /config/sim/v1/employees/deleteProperties
Get Employee Properties
Method: post
Path: /config/sim/v1/employees/getProperties
Update Employee Properties
Method: post
Path: /config/sim/v1/employees/updateProperties
Employees/Employee Property Operators

These APIs maintain the operator records for the property assigned to the employee:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Employee Property Operator
Method: post
Path: /config/sim/v1/employees/properties/operators
Delete Employee Property Operator
Method: post
Path: /config/sim/v1/employees/properties/deleteOperators
Get Employee Property Operators
Method: post
Path: /config/sim/v1/employees/properties/getOperators
Update Employee Property Operator
Method: post
Path: /config/sim/v1/employees/properties/updateOperators
Employees/Employee Roles

These APIs maintain the roles associated with an employee:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Employee Roles
Method: post
Path: /config/sim/v1/employees/employeeRoles
Delete Employee Roles
Method: post
Path: /config/sim/v1/employees/deleteEmployeeRoles
Get Employee Roles
Method: post
Path: /config/sim/v1/employees/getEmployeeRoles
Update Employee Roles
Method: post
Path: /config/sim/v1/employees/updateEmployeeRoles
Employees/Employees

These APIs maintain Employees:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Employee
Method: post
Path: /config/sim/v1/employees/employees
Delete Employees
Method: post
Path: /config/sim/v1/employees/deleteEmployees
Get Employees
Method: post
Path: /config/sim/v1/employees/getEmployees
Pre-Delete Employees
Method: post
Path: /config/sim/v1/employees/preDeleteCheckEmployees
Update Employees
Method: post
Path: /config/sim/v1/employees/updateEmployees
Employees/Employees2

These APIs maintain the basic employees, excluding the information stored in dependent tables that already have supporting API's - employee visibility, employee roles and employee properties.

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 First introduced in this version.
Add basic employees
Method: post
Path: /config/sim/v1/employees/employees2
Delete basic employees
Method: post
Path: /config/sim/v1/employees/deleteEmployees2
Get basic employees
Method: post
Path: /config/sim/v1/employees/getEmployees2
Pre-Delete basic employees
Method: post
Path: /config/sim/v1/employees/preDeleteCheckEmployees2
Update basic employees
Method: post
Path: /config/sim/v1/employees/updateEmployees2
Employees/Roles

These APIs maintain Roles:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Roles
Method: post
Path: /config/sim/v1/employees/roles
Delete Roles
Method: post
Path: /config/sim/v1/employees/deleteRoles
Get Roles
Method: post
Path: /config/sim/v1/employees/getRoles
Update Roles
Method: post
Path: /config/sim/v1/employees/updateRoles
Hierarchy/Hierarchy

These APIs maintain Hierarchy:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Hierarchies
Method: post
Path: /config/sim/v1/hierarchy/getHierarchy
Hierarchy/Location Parameters

These APIs maintain Location Parameters:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Location Parameters
Method: post
Path: /config/sim/v1/hierarchy/locationParameters
Delete Location Parameters
Method: post
Path: /config/sim/v1/hierarchy/deleteLocationParameters
Get Location Parameters
Method: post
Path: /config/sim/v1/hierarchy/getLocationParameters
Update Location Parameters
Method: post
Path: /config/sim/v1/hierarchy/updateLocationParameters
Hierarchy/Locations/Locations

This group of APIs maintains Locations:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1.3 Starting with the API release 23.3.1.3, the Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above.
Add Locations
Method: post
Path: /config/sim/v1/hierarchy/locations
Delete Locations
Method: post
Path: /config/sim/v1/hierarchy/deleteLocations
Get Locations
Method: post
Path: /config/sim/v1/hierarchy/getLocations
Pre-Delete Locations
Method: post
Path: /config/sim/v1/hierarchy/predeletechecklocations
Update Locations
Method: post
Path: /config/sim/v1/hierarchy/updateLocations
Hierarchy/Locations/Parent Enterprise Levels

This API returns the enterprise levels available in an organization

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1.3 First introduced in this version. The Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above.
Get Enterprise Levels
Method: post
Path: /config/sim/v1/hierarchy/locations/getEnterpriseLevels
Hierarchy/Locations/Reporting Hierarchy Relationships

This group of APIs maintains parent enterprise levels assigned to a location within various reporting hierarchies.

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1.3 First introduced in this version. The Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above.
Delete Reporting Hierarchy Relationships
Method: post
Path: /config/sim/v1/hierarchy/locations/deleteReportingHierarchyRelationships
Get Reporting Hierarchy Levels
Method: post
Path: /config/sim/v1/hierarchy/locations/getReportingHierarchyLevels
Get Reporting Hierarchy Relationships
Method: post
Path: /config/sim/v1/hierarchy/locations/getReportingHierarchyRelationships
Update Reporting Hierarchy Relationships
Method: post
Path: /config/sim/v1/hierarchy/locations/updateReportingHierarchyRelationships
Hierarchy/Revenue Center Parameters

These APIs maintain the parameters associated with a revenue center of a location:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Revenue Center Parameters
Method: post
Path: /config/sim/v1/hierarchy/revenueCenterParameters
Delete Revenue Center Parameters
Method: post
Path: /config/sim/v1/hierarchy/deleteRevenueCenterParameters
Get Revenue Center Parameters
Method: post
Path: /config/sim/v1/hierarchy/getRevenueCenterParameters
Update Revenue Center Parameters
Method: post
Path: /config/sim/v1/hierarchy/updateRevenueCenterParameters
Hierarchy/Revenue Centers

These APIs maintain the revenue centers of a location for a specified organization:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Revenue Centers
Method: post
Path: /config/sim/v1/hierarchy/revenueCenters
Checks the existence of references to the object in the database.
Method: post
Path: /config/sim/v1/hierarchy/preDeleteCheckRevenueCenters
Delete Revenue Centers
Method: post
Path: /config/sim/v1/hierarchy/deleteRevenueCenters
Get Revenue Centers
Method: post
Path: /config/sim/v1/hierarchy/getRevenueCenters
Update Revenue Centers
Method: post
Path: /config/sim/v1/hierarchy/updateRevenueCenters
Hierarchy/Zones

These APIs maintain Zones:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Zones
Method: post
Path: /config/sim/v1/hierarchy/getZones
Menu Items/Barcodes

These APIs maintain Barcodes:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Barcodes
Method: post
Path: /config/sim/v1/menuItems/barcodes
Delete Barcodes
Method: post
Path: /config/sim/v1/menuItems/deleteBarcodes
Get Barcodes
Method: post
Path: /config/sim/v1/menuItems/getBarcodes
Update Barcodes
Method: post
Path: /config/sim/v1/menuItems/updateBarcodes
Menu Items/Combo Meals/Combo Meal Side Group Prices

These APIs maintain the prices of side groups in combo meals for a specified organization:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Combo Meal Side Group Prices
Method: post
Path: /config/sim/v1/menuItems/combomeals/mealsidegroupprices
Delete Combo Meal Side Group Prices
Method: post
Path: /config/sim/v1/menuItems/combomeals/deletemealsidegroupprices
Get Combo Meal Side Group Prices
Method: post
Path: /config/sim/v1/menuItems/combomeals/getmealsidegroupprices
Update Combo Meal Side Group Prices
Method: post
Path: /config/sim/v1/menuItems/combomeals/updatemealsidegroupprices
Menu Items/Combo Meals/Combo Meal Side Groups

These APIs maintain Combo Meal Side Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Combo Meal Side Groups
Method: post
Path: /config/sim/v1/menuItems/combomeals/mealsidegroups
Delete Combo Meal Side Groups
Method: post
Path: /config/sim/v1/menuItems/combomeals/deletemealsidegroups
Get Combo Meal Side Groups
Method: post
Path: /config/sim/v1/menuItems/combomeals/getmealsidegroups
Update Combo Meal Side Groups
Method: post
Path: /config/sim/v1/menuItems/combomeals/updatemealsidegroups
Menu Items/Combo Meals/Combo Meals

These APIs maintain Combo Meals:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Combo Meals
Method: post
Path: /config/sim/v1/menuitems/combomeals
Delete Combo Meals
Method: post
Path: /config/sim/v1/menuitems/deletecombomeals
Get Combo Meals
Method: post
Path: /config/sim/v1/menuitems/getcombomeals
Pre-Delete Check Combo Meals
Method: post
Path: /config/sim/v1/menuitems/predeletecheckcombomeals
Update Combo Meals
Method: post
Path: /config/sim/v1/menuitems/updatecombomeals
Menu Items/Combo Side Groups/Combo Side Group Item

These APIs maintain Combo Meal Side Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Combo Side Group Items
Method: post
Path: /config/sim/v1/menuItems/combosidegroups/sidegroupitems
Delete Combo Side Group Items
Method: post
Path: /config/sim/v1/menuItems/combosidegroups/deletesidegroupitems
Get Combo Side Group Items
Method: post
Path: /config/sim/v1/menuItems/combosidegroups/getsidegroupitems
Update Combo Side Group Items
Method: post
Path: /config/sim/v1/menuItems/combosidegroups/updatesidegroupitems
Menu Items/Combo Side Groups/Combo Side Group Item Prices

These APIs maintain Combo Side Group Item Prices:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Combo Side Group Item Prices
Method: post
Path: /config/sim/v1/menuitems/combosidegroups/sidegroupitemprices
Delete Combo Side Group Item Prices
Method: post
Path: /config/sim/v1/menuitems/combosidegroups/deletesidegroupitemprices
Get Combo Side Group Item Prices
Method: post
Path: /config/sim/v1/menuitems/combosidegroups/getsidegroupitemprices
Update Combo Side Group Item Prices
Method: post
Path: /config/sim/v1/menuitems/combosidegroups/updatesidegroupitemprices
Menu Items/Combo Side Groups/Combo Side Groups

These APIs maintain Combo Meal Side Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Combo Side Groups
Method: post
Path: /config/sim/v1/menuItems/combosidegroups
Delete Combo Side Groups
Method: post
Path: /config/sim/v1/menuItems/deletecombosidegroups
Get Combo Side Groups
Method: post
Path: /config/sim/v1/menuItems/getcombosidegroups
Update Combo Side Groups
Method: post
Path: /config/sim/v1/menuItems/updatecombosidegroups
Menu Items/Condiment Groups

These APIs maintain Condiment Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Condiment Groups
Method: post
Path: /config/sim/v1/menuItems/condimentgroups
Delete Condiment Groups
Method: post
Path: /config/sim/v1/menuItems/deletecondimentgroups
Get Condiment Groups
Method: post
Path: /config/sim/v1/menuItems/getcondimentgroups
Update Condiment Groups
Method: post
Path: /config/sim/v1/menuItems/updatecondimentgroups
Menu Items/Condiment Sets

These APIs maintain Condiment Sets:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Condiment Sets
Method: post
Path: /config/sim/v1/menuItems/condimentsets
Delete Condiment Sets
Method: post
Path: /config/sim/v1/menuItems/deletecondimentsets
Get Condiment Sets
Method: post
Path: /config/sim/v1/menuItems/getcondimentsets
Update Condiment Sets
Method: post
Path: /config/sim/v1/menuItems/updatecondimentsets
Menu Items/Condiment Sets/Condiment Set Items

These APIs maintain Condiment Set Items:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Condiment Set Items
Method: post
Path: /config/sim/v1/menuItems/condimentsets/items
Delete Condiment Set Items
Method: post
Path: /config/sim/v1/menuItems/condimentsets/deleteItems
Get Condiment Set Items
Method: post
Path: /config/sim/v1/menuItems/condimentsets/getItems
Update Condiment Set Items
Method: post
Path: /config/sim/v1/menuItems/condimentsets/updateItems
Menu Items/Family Group Consumer Facing Content

These APIs maintain Family Group Consumer Facing Content:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Family Group Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/familyGroups/consumerContent
Delete Family Group Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/familyGroups/deleteConsumerContent
Download Family Group Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/familyGroups/downloadConsumerContent
Get Family Group Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/familyGroups/getConsumerContent
Update Family Group Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/familyGroups/updateConsumerContent
Menu Items/Family Groups

These APIs maintain Family Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Family Groups
Method: post
Path: /config/sim/v1/menuItems/familyGroups
Delete Family Groups
Method: post
Path: /config/sim/v1/menuItems/deleteFamilygroups
Get Family Groups
Method: post
Path: /config/sim/v1/menuItems/getFamilyGroups
Update Family Groups
Method: post
Path: /config/sim/v1/menuItems/updateFamilygroups
Menu Items/Major Groups

These APIs maintain Major Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Major Groups
Method: post
Path: /config/sim/v1/menuItems/majorGroups
Delete Major Groups
Method: post
Path: /config/sim/v1/menuItems/deleteMajorGroups
Get Major Groups
Method: post
Path: /config/sim/v1/menuItems/getMajorGroups
Update Major Groups
Method: post
Path: /config/sim/v1/menuItems/updateMajorGroups
Menu Items/Menu Item 2

These APIs maintain Menu Items:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Menu Items 2
Method: post
Path: /config/sim/v1/menuItems/getMenuItem2
Menu Items/Menu Item Class

These APIs maintain Menu Item Classes:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Classes
Method: post
Path: /config/sim/v1/menuItems/menuItemClasses
Delete Menu Item Classes
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemClasses
Get Menu Item Classes
Method: post
Path: /config/sim/v1/menuItems/getMenuItemClasses
Update Menu Item Classes
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemClasses
Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content

These APIs maintain Menu Item Definition Consumer Facing Content:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Definition Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/menuitemdefinition/consumerContent
Delete Menu Item Definition Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/menuitemdefinition/deleteConsumerContent
Download Menu Item Definition Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/menuitemdefinition/downloadConsumerContent
Get Menu Item Defintion Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/menuitemdefinition/getConsumerContent
Update Menu Item Definition Consumer Facing Content
Method: post
Path: /content/sim/v1/menuitems/menuitemdefinition/updateConsumerContent
Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments

These APIs maintain the default condiments for a given menu item definition:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Delete Menu Item Definition Default Condiments
Method: post
Path: /config/sim/v1/menuItems/menuitemdefinition/deletedefaultcondiments
Get Menu Item Definition Default Condiments
Method: post
Path: /config/sim/v1/menuItems/menuitemdefinition/getdefaultcondiments
Insert Menu Item Definition Default Condiments
Method: post
Path: /config/sim/v1/menuItems/menuitemdefinition/defaultcondiments
Update Menu Item Definition Default Condiments
Method: post
Path: /config/sim/v1/menuItems/menuitemdefinition/updatedefaultcondiments
Menu Items/Menu Item Definitions/Menu Item Definitions

These APIs maintain Menu Item Definitions:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Definitions
Method: post
Path: /config/sim/v1/menuItems/menuItemDefinitions
Delete Menu Item Definitions
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemDefinitions
Get Menu Item Definitions
Method: post
Path: /config/sim/v1/menuItems/getMenuItemDefinitions
Pre-Delete Menu Item Definitions
Method: post
Path: /config/sim/v1/menuItems/preDeleteCheckMenuItemDefinitions
Update Menu Item Definitions
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemDefinitions
Menu Items/Menu Item Groups/Menu Item Group Details

These APIs maintain Menu Item Group Details:

Release Description
23.2.2 This endpoint was added in the API version 23.2.2
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Group Details
Method: post
Path: /config/sim/v1/menuItems/menuItemGroups/details
Delete Menu Item Group Deatils
Method: post
Path: /config/sim/v1/menuItems/MenuItemGroups/deleteDetails
Get Menu Item Group Details
Method: post
Path: /config/sim/v1/menuItems/MenuItemGroups/getDetails
Update Menu Item Group Details
Method: post
Path: /config/sim/v1/menuItems/MenuItemGroups/updateDetails
Menu Items/Menu Item Groups/Menu Item Groups

These APIs maintain Menu Item Groups:

Release Description
23.2 This endpoint was added in the API version 23.2
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Groups
Method: post
Path: /config/sim/v1/menuItems/menuItemGroups
Delete Menu Item Groups
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemGroups
Get Menu Item Groups
Method: post
Path: /config/sim/v1/menuItems/getMenuItemGroups
Update Menu Item Groups
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemGroups
Menu Items/Menu Item Master

These APIs maintain Menu Item Masters:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Masters
Method: post
Path: /config/sim/v1/menuItems/menuItemMasters
Delete Menu Item Masters
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemMasters
Get Menu Item Masters
Method: post
Path: /config/sim/v1/menuItems/getMenuItemMasters
Pre-Delete Check Menu Item Masters
Method: post
Path: /config/sim/v1/menuItems/preDeleteCheckMenuItemMasters
Update Menu Item Masters
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemMasters
Menu Items/Menu Item Master Effectivity

These APIs maintain Menu Item Effectivity Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 First introduced in this version.
Add Menu Item Master Effectivty Group
Method: post
Path: /config/sim/v1/menuItems/menuItemMasterEffectivity
Delete Menu Item Master Effectivity Group
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemMasterEffectivity
Get Menu Item Master Effectivity Groups
Method: post
Path: /config/sim/v1/menuItems/getMenuItemMasterEffectivity
Update Menu Item Master Effectivity Group
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemMasterEffectivity
Menu Items/Menu Item Master Groups

These APIs maintain Menu Item Master Groups:

Release Description
23.2 This endpoint was added in the API version 23.2
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Master Groups
Method: post
Path: /config/sim/v1/menuItems/menuItemMasterGroups
Delete Menu Item Master Groups
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemMasterGroups
Get Menu Item Master Groups
Method: post
Path: /config/sim/v1/menuItems/getMenuItemMasterGroups
Update Menu Item Master Groups
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemMasterGroups
Menu Items/Menu Item Prices

These APIs maintain Menu Item Prices:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Item Prices
Method: post
Path: /config/sim/v1/menuItems/menuItemPrices
Delete Menu Item Prices
Method: post
Path: /config/sim/v1/menuItems/deleteMenuItemPrices
Get Menu Item Prices
Method: post
Path: /config/sim/v1/menuItems/getMenuItemPrices
Update Menu Item Prices
Method: post
Path: /config/sim/v1/menuItems/updateMenuItemPrices
Menu Items/Menu Items

These APIs maintain Menu Items:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Menu Items
Method: post
Path: /config/sim/v1/menuitems/getMenuItems
Other/ Get Available Object Numbers

This API returns available object numbers:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 First introduced in this version.
Get Available Object Numbers
Method: post
Path: /config/sim/v1/getAvailableObjectNumbers
Other/Clone Configuration

These APIs clone configuration data from one organization to another.

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Create Clone
Method: post
Path: /clones/sim/v1/createConfig
Get Clone Request Status
Method: post
Path: /clones/sim/v1/getStatus
Get Clones
Method: post
Path: /clones/sim/v1/getClones
Import Clone
Method: post
Path: /clones/sim/v1/importConfig
Other/Release Versions

This API returns Version Information:

Release Description
23.2 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get version information
Method: post
Path: /config/sim/v1/getReleaseVersions
Sales/Discount Itemizers

These APIs maintain Discount Itemizers:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Discount Itemizers
Method: post
Path: /config/sim/v1/sales/discountitemizers
Delete Discount Itemizers
Method: post
Path: /config/sim/v1/sales/deletediscountitemizers
Get Discount Itemizers
Method: post
Path: /config/sim/v1/sales/getdiscountitemizers
Update Discount Itemizers
Method: post
Path: /config/sim/v1/sales/updatediscountitemizers
Sales/Discounts/Discount

These APIs maintain Discounts:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Discounts
Method: post
Path: /config/sim/v1/sales/discounts
Delete Discounts
Method: post
Path: /config/sim/v1/sales/deleteDiscounts
Get Discounts
Method: post
Path: /config/sim/v1/sales/getDiscounts
Update Discounts
Method: post
Path: /config/sim/v1/sales/updateDiscounts
Sales/Discounts/Discount Award Groups

These APIs maintain Discount Award Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Discount Award Groups
Method: post
Path: /config/sim/v1/sales/discounts/awardgroups
Delete Discount Award Groups
Method: post
Path: /config/sim/v1/sales/discounts/deleteawardgroups
Get Discount Award Groups
Method: post
Path: /config/sim/v1/sales/discounts/getawardgroups
Update Discount Award Groups
Method: post
Path: /config/sim/v1/sales/discounts/updateawardgroups
Sales/Discounts/Discount Trigger Groups

These APIs maintain Discount Trigger Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Discount Trigger Groups
Method: post
Path: /config/sim/v1/sales/discounts/triggergroups
Delete Discount Trigger Groups
Method: post
Path: /config/sim/v1/sales/discounts/deletetriggergroups
Get Discount Trigger Groups
Method: post
Path: /config/sim/v1/sales/discounts/gettriggergroups
Update Discount Trigger Groups
Method: post
Path: /config/sim/v1/sales/discounts/updatetriggergroups
Sales/Service Charge Groups/Service Charge Group Details

These APIs maintain details of Service Charge Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Service Charge Group Details
Method: post
Path: /config/sim/v1/sales/servicechargegroups/details
Delete Service Charge Group Details
Method: post
Path: /config/sim/v1/sales/servicechargegroups/deletedetails
Get Service Charge Group Details
Method: post
Path: /config/sim/v1/sales/servicechargegroups/getdetails
Update Service Charge Group Details
Method: post
Path: /config/sim/v1/sales/servicechargegroups/updatedetails
Sales/Service Charge Groups/Service Charge Groups

These APIs maintain Service Charge Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Service Charge Groups
Method: post
Path: /config/sim/v1/sales/servicechargegroups
Delete Service Charge Groups
Method: post
Path: /config/sim/v1/sales/deleteservicechargegroups
Get Service Charge Groups
Method: post
Path: /config/sim/v1/sales/getservicechargegroups
Update Service Charge Groups
Method: post
Path: /config/sim/v1/sales/updateservicechargegroups
Sales/Service Charge Itemizers

These APIs maintain Service Charge Itemizers:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Service Charge Itemizers
Method: post
Path: /config/sim/v1/sales/servicechargeitemizers
Delete Service Charge Itemizers
Method: post
Path: /config/sim/v1/sales/deleteservicechargeitemizers
Get Service Charge Itemizers
Method: post
Path: /config/sim/v1/sales/getservicechargeitemizers
Update Service Charge Itemizers
Method: post
Path: /config/sim/v1/sales/updateservicechargeitemizers
Sales/Service Charges

These APIs maintain Service Charges:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Service Charges
Method: post
Path: /config/sim/v1/sales/serviceCharges
Delete Service Charges
Method: post
Path: /config/sim/v1/sales/deleteServicecharges
Get Service Charges
Method: post
Path: /config/sim/v1/sales/getServicecharges
Update Service Charges
Method: post
Path: /config/sim/v1/sales/updateServicecharges
Sales/Tax Classes

These APIs maintain Tax Classes:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Tax Classes
Method: post
Path: /config/sim/v1/sales/taxclasses
Delete Tax Classes
Method: post
Path: /config/sim/v1/sales/deletetaxclasses
Get Tax Classes
Method: post
Path: /config/sim/v1/sales/gettaxclasses
Update Tax Classes
Method: post
Path: /config/sim/v1/sales/updatetaxclasses
Sales/Tax Parameters

These APIs maintain Tax Parameters:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Tax Parameters
Method: post
Path: /config/sim/v1/sales/taxparameters
Delete Tax Parameters
Method: post
Path: /config/sim/v1/sales/deletetaxparameters
Get Tax Parameters
Method: post
Path: /config/sim/v1/sales/gettaxparameters
Update Tax Parameters
Method: post
Path: /config/sim/v1/sales/updatetaxparameters
Sales/Taxes/Tax Breakpoints

These APIs maintain breakpoints for a Tax Rate:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Tax Breakpoints
Method: post
Path: /config/sim/v1/sales/gettaxbreakpoints
Update Tax Breakpoints
Method: post
Path: /config/sim/v1/sales/updatetaxbreakpoints
Sales/Taxes/Tax Rates

These APIs maintain Tax Rates:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Tax Rates
Method: post
Path: /config/sim/v1/sales/taxrates
Delete Tax Rates
Method: post
Path: /config/sim/v1/sales/deletetaxrates
Get Tax Rates
Method: post
Path: /config/sim/v1/sales/gettaxrates
Update Tax Rates
Method: post
Path: /config/sim/v1/sales/updatetaxrates
Sales/Tender Media

These APIs maintain Tender Media:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Tender Media
Method: post
Path: /config/sim/v1/sales/tenderMedia
Delete Tender Media
Method: post
Path: /config/sim/v1/sales/deleteTenderMedia
Get Tender Media
Method: post
Path: /config/sim/v1/sales/getTenderMedia
Update Tender Media
Method: post
Path: /config/sim/v1/sales/updateTenderMedia
Setup/Auto Menu Levels

These APIs maintain Auto Menu Levels:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Auto Menu Levels
Method: post
Path: /config/sim/v1/setup/autoMenuLevels
Delete Auto Menu Levels
Method: post
Path: /config/sim/v1/setup/deleteAutoMenuLevels
Get Auto Menu Levels
Method: post
Path: /config/sim/v1/setup/getAutoMenuLevels
Update Auto Menu Levels
Method: post
Path: /config/sim/v1/setup/updateAutoMenuLevels
Setup/CAL Deployment Schedules

These APIs maintain CAL Deployment Schedules:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add CAL Deployment Schedules
Method: post
Path: /config/sim/v1/setup/cal/deploymentSchedules
Delete CAL Deployment Schedules
Method: post
Path: /config/sim/v1/setup/cal/deleteDeploymentSchedules
Get CAL Deployment Schedules
Method: post
Path: /config/sim/v1/setup/cal/getDeploymentSchedules
Update CAL Deployment Schedules
Method: post
Path: /config/sim/v1/setup/cal/updateDeploymentSchedules
Setup/CAL Packages

These APIs maintain CAL Packages:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get CAL Packages
Method: post
Path: /config/sim/v1/setup/cal/getPackages
Setup/Cash Management Receptacle Templates

These APIs maintain Cash Management Receptacle Templates:

Release Description
23.3 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Cash Management Receptacle Templates
Method: post
Path: /config/sim/v1/setup/cashManagementReceptacleTemplates
Delete Cash Management Receptacle Templates
Method: post
Path: /config/sim/v1/setup/deleteCashManagementReceptacleTemplates
Get Cash Management Receptacle Templates
Method: post
Path: /config/sim/v1/setup/getCashManagementReceptacleTemplates
Update Cash Management Receptacle Templates
Method: post
Path: /config/sim/v1/setup/updateCashManagementReceptacleTemplates
Setup/Currencies

These APIs maintain Currencies:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Currencies
Method: post
Path: /config/sim/v1/setup/currencies
Delete Currencies
Method: post
Path: /config/sim/v1/setup/deleteCurrencies
Get Currencies
Method: post
Path: /config/sim/v1/setup/getCurrencies
Update Currencies
Method: post
Path: /config/sim/v1/setup/updateCurrencies
Setup/Currency Availability

These APIs maintain Currency Availability:

Release Description
23.3 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Currency Availability
Method: post
Path: /config/sim/v1/setup/currencyavailability
Delete Currency Availability
Method: post
Path: /config/sim/v1/setup/deletecurrencyavailability
Get Currency Availability
Method: post
Path: /config/sim/v1/setup/getcurrencyavailability
Update Currency Availability
Method: post
Path: /config/sim/v1/setup/updatecurrencyavailability
Setup/Currency Conversions

These APIs maintain Currency Conversions:

Release Description
23.3 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Currency Conversion.
Method: post
Path: /config/sim/v1/setup/currencyconversion
Delete currency conversion.
Method: post
Path: /config/sim/v1/setup/deletecurrencyconversion
Get currency conversions.
Method: post
Path: /config/sim/v1/setup/getcurrencyconversion
Update currency conversion.
Method: post
Path: /config/sim/v1/setup/updatecurrencyconversion
Setup/Currency Parameters

These APIs maintain Currency Parameters:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Currency Parameters
Method: post
Path: /config/sim/v1/setup/currencyparameters
Delete Currency Parameters
Method: post
Path: /config/sim/v1/setup/deletecurrencyparameters
Get Currency Parameters
Method: post
Path: /config/sim/v1/setup/getcurrencyparameters
Update Currency Parameters
Method: post
Path: /config/sim/v1/setup/updatecurrencyparameters
Setup/Custom Content

These APIs maintain Custom Content:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Custom Content
Method: post
Path: /content/sim/v1/setup/customContent
Delete Custom Content
Method: post
Path: /content/sim/v1/setup/deleteCustomContent
Download Custom Content.
Method: post
Path: /content/sim/v1/setup/downloadCustomContent
Get Custom Content
Method: post
Path: /content/sim/v1/setup/getCustomContent
Update Custom Content
Method: post
Path: /content/sim/v1/setup/updateCustomContent
Setup/Data Extensions

These APIs maintain Data Extensions:

Release Description
23.2 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Data Extensions
Method: post
Path: /config/sim/v1/setup/DataExtensions
Delete Data Extensions
Method: post
Path: /config/sim/v1/setup/deleteDataExtensions
Get Data Extensions
Method: post
Path: /config/sim/v1/setup/getDataExtensions
Update Data Extensions
Method: post
Path: /config/sim/v1/setup/updateDataExtensions
Setup/Effectivity Groups/Effectivity Groups

These APIs maintain Effectivity Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Effectivity Groups
Method: post
Path: /config/sim/v1/setup/effectivitygroups
Delete Effectivity Groups
Method: post
Path: /config/sim/v1/setup/deleteeffectivitygroups
Get Effectivity Groups
Method: post
Path: /config/sim/v1/setup/geteffectivitygroups
Update Effectivity Groups
Method: post
Path: /config/sim/v1/setup/updateeffectivitygroups
Setup/Effectivity Groups/Enable Effectivity Groups

These APIs can be used to enable or disable inherited effectivity groups at each location.

The User will require access to the 'Effectivity Groups' module to be able to access this API

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 First introduced in this version.
Add Enable Effectivity Groups.
Method: post
Path: /config/sim/v1/setup/effectivityGroups/enableEffectivityGroups
Delete Enable Effectivity Groups.
Method: post
Path: /config/sim/v1/setup/effectivityGroups/deleteEnableEffectivityGroups
Get Enable Effectivity Groups.
Method: post
Path: /config/sim/v1/setup/effectivitygroups/getEnableEffectivityGroups
Update Enable Effectivity Groups.
Method: post
Path: /config/sim/v1/setup/effectivityGroups/updateEnableEffectivityGroups
Setup/Headers Trailers

These APIs maintain Headers and Trailers:

Release Description
23.3 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Headers/Trailers
Method: post
Path: /config/sim/v1/setup/headerstrailers
Delete Header/Trailer
Method: post
Path: /config/sim/v1/setup/deleteheaderstrailers
Get Headers/Trailers
Method: post
Path: /config/sim/v1/setup/getheaderstrailers
Update Headers/Trailers
Method: post
Path: /config/sim/v1/setup/updateheaderstrailers
Setup/Languages

These APIs maintain Languages:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Languages
Method: post
Path: /config/sim/v1/setup/languages
Delete Languages
Method: post
Path: /config/sim/v1/setup/deleteLanguages
Get Languages
Method: post
Path: /config/sim/v1/setup/getLanguages
Update Languages
Method: post
Path: /config/sim/v1/setup/updateLanguages
Setup/Locale

These APIs maintain Locales:

Release Description
23.2 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Locales
Method: post
Path: /config/sim/v1/setup/locales
Delete locales
Method: post
Path: /config/sim/v1/setup/deleteLocales
Get Locales
Method: post
Path: /config/sim/v1/setup/getLocales
Update Locales
Method: post
Path: /config/sim/v1/setup/updateLocales
Setup/Menu Levels/Menu Level Entries

These APIs maintain Menu Level Entries for a Menu Level Set:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Level Entries
Method: post
Path: /config/sim/v1/setup/menulevels/menuLeveleEtries
Delete Menu Level Entries
Method: post
Path: /config/sim/v1/setup/menulevels/deleteMenuLevelEntries
Get Menu Level Entries
Method: post
Path: /config/sim/v1/setup/menulevels/getMenuLevelEntries
Update Menu Level Entries
Method: post
Path: /config/sim/v1/setup/menulevels/updateMenuLevelEntries
Setup/Menu Levels/Menu Levels

These APIs maintain Menu Levels

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Menu Levels
Method: post
Path: /config/sim/v1/setup/menulevels
Delete Menu Levels
Method: post
Path: /config/sim/v1/setup/deletemenulevels
Get Menu Levels
Method: post
Path: /config/sim/v1/setup/getmenulevels
Update Menu Levels
Method: post
Path: /config/sim/v1/setup/updatemenulevels
Setup/Order Channels/Order Channel Parameters

These APIs maintain Order Channel parameters.

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 First introduced in this version.
Add Order Channel Parameters
Method: post
Path: /config/sim/v1/setup/orderchannelparameters
Delete Order Channel Parameters
Method: post
Path: /config/sim/v1/setup/deleteorderchannelparameters
Get Order Channel Parameters
Method: post
Path: /config/sim/v1/setup/getorderchannelparameters
Update Order Channel Parameters
Method: post
Path: /config/sim/v1/setup/updateorderchannelparameters
Setup/Order Channels/Order Channels

These APIs maintain Order Channels.

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
23.3.1 First introduced in this version.
Add Order Channels
Method: post
Path: /config/sim/v1/setup/orderchannels
Get Order Channels
Method: post
Path: /config/sim/v1/setup/getorderchannels
Update Order Channels
Method: post
Path: /config/sim/v1/setup/updateorderchannels
Setup/Order Types/Order Type Names

These APIs maintain Order Types:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Order Types
Method: post
Path: /config/sim/v1/setup/ordertypenames
Delete Order Types
Method: post
Path: /config/sim/v1/setup/deleteordertypenames
Get Order Types
Method: post
Path: /config/sim/v1/setup/getordertypenames
Update Order Types
Method: post
Path: /config/sim/v1/setup/updateordertypenames
Setup/Order Types/Order Type Parameters

These APIs maintain Order Type Parameters:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Order Type Parameters
Method: post
Path: /config/sim/v1/setup/orderTypeParameters
Delete Order Type Parameters
Method: post
Path: /config/sim/v1/setup/deleteOrdertypeParameters
Get Order Types Parameters
Method: post
Path: /config/sim/v1/setup/getOrderTypeParameters
Update Order Type Parameters
Method: post
Path: /config/sim/v1/setup/updateOrdertypeParameters
Setup/Payment Drivers/Payment Driver Configurations

These APIs maintain Payment Driver Configurations:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Get Payment Driver Configuration
Method: post
Path: /config/sim/v1/setup/getpaymentdriverconfiguration
Update Payment Driver Configuration
Method: post
Path: /config/sim/v1/setup/updatepaymentdriverconfiguration
Setup/Payment Drivers/Payment Drivers

These APIs maintain Payment Drivers:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Payment Drivers
Method: post
Path: /content/sim/v1/setup/paymentdrivers
Delete Payment Drivers
Method: post
Path: /content/sim/v1/setup/deletepaymentdrivers
Download Payment Drivers
Method: post
Path: /content/sim/v1/setup/downloadpaymentdrivers
Get Payment Drivers
Method: post
Path: /content/sim/v1/setup/getpaymentdrivers
Update Payment Drivers
Method: post
Path: /content/sim/v1/setup/updatepaymentdrivers
Setup/Print Logos

These APIs maintain Print Logos:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Print Logos
Method: post
Path: /content/sim/v1/setup/printLogos
Delete Print Logos
Method: post
Path: /content/sim/v1/setup/deletePrintLogos
Download Print Logos
Method: post
Path: /content/sim/v1/setup/downloadPrintLogos
Get Print Logos
Method: post
Path: /content/sim/v1/setup/getPrintLogos
Update Print Logos
Method: post
Path: /content/sim/v1/setup/updatePrintLogos
Setup/Report Groups

These APIs maintain Report Groups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Report Groups
Method: post
Path: /config/sim/v1/setup/reportGroups
Delete Report Groups
Method: post
Path: /config/sim/v1/setup/deleteReportGroups
Get Report Groups
Method: post
Path: /config/sim/v1/setup/getReportGroups
Update Report Groups
Method: post
Path: /config/sim/v1/setup/updateReportGroups
Setup/Sales Itemizers

These APIs maintain Sales Itemizers:

Release Description
23.2 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Sales Itemizers
Method: post
Path: /config/sim/v1/setup/salesitemizers
Delete Sales Itemizers
Method: post
Path: /config/sim/v1/setup/deletesalesitemizers
Get Sales Itemizers
Method: post
Path: /config/sim/v1/setup/getsalesitemizers
Update Sales Itemizers
Method: post
Path: /config/sim/v1/setup/updatesalesitemizers
Setup/Screen Look Ups/Screen Look Up Consumer Facing Content

These APIs maintain SLU Consumer Facing Content:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add SLU Consumer Facing Content
Method: post
Path: /content/sim/v1/setup/screenlookups/consumercontent
Delete SLU Consumer Facing Content
Method: post
Path: /content/sim/v1/setup/screenlookups/deleteconsumercontent
Download SLU Consumer Facing Content
Method: post
Path: /content/sim/v1/setup/screenlookups/downloadconsumercontent
Get SLU Consumer Facing Content
Method: post
Path: /content/sim/v1/setup/screenlookups/getconsumercontent
Update SLU Consumer Facing Content
Method: post
Path: /content/sim/v1/setup/screenlookups/updateconsumercontent
Setup/Screen Look Ups/Screen Look Ups

These APIs maintain Screen Look Ups:

Release Description
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Screen Look Ups
Method: post
Path: /config/sim/v1/setup/screenlookups
Delete Screen Look Ups
Method: post
Path: /config/sim/v1/setup/deletescreenlookups
Get Screen Look Ups
Method: post
Path: /config/sim/v1/setup/getscreenlookups
Update Screen Look Ups
Method: post
Path: /config/sim/v1/setup/updatescreenlookups
Setup/Tag Groups

These APIs maintain Tag Groups:

Release Description
23.2 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Tag Groups
Method: post
Path: /config/sim/v1/setup/tagGroups
Delete Tag Groups
Method: post
Path: /config/sim/v1/setup/deleteTagGroups
Get Tag Groups
Method: post
Path: /config/sim/v1/setup/getTagGroups
Update Tag Groups
Method: post
Path: /config/sim/v1/setup/updateTagGroups
Setup/Tags

These APIs maintain Tags:

Release Description
23.2 First introduced in this version.
23.3 Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to.
Add Tags
Method: post
Path: /config/sim/v1/setup/tags
Delete Tags
Method: post
Path: /config/sim/v1/setup/deleteTags
Get Tags
Method: post
Path: /config/sim/v1/setup/getTags
Update Tags
Method: post
Path: /config/sim/v1/setup/updateTags