All REST Endpoints
These APIs maintain Kitchen Display Clients
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Kitchen Display Clients
- Method: postPath:
/config/sim/v1/devices/KitchenDisplays
- Delete Kitchen Display Clients
- Method: postPath:
/config/sim/v1/devices/deleteKitchenDisplays
- Get Kitchen Display Clients
- Method: postPath:
/config/sim/v1/devices/getKitchenDisplays
- Update Kitchen Display Clients
- Method: postPath:
/config/sim/v1/devices/updateKitchenDisplays
These APIs maintain Kitchen Display Controllers
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Kitchen Display Controllers
- Method: postPath:
/config/sim/v1/devices/KitchenDisplayControllers
- Delete Kitchen Display Controllers
- Method: postPath:
/config/sim/v1/devices/deleteKitchenDisplayControllers
- Get Kitchen Display Controllers
- Method: postPath:
/config/sim/v1/devices/getKitchenDisplayControllers
- Update Kitchen Display Controllers
- Method: postPath:
/config/sim/v1/devices/updateKitchenDisplayControllers
These APIs maintain Order Devices:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Order Devices
- Method: postPath:
/config/sim/v1/devices/getOrderDevices
- Update Order Devices
- Method: postPath:
/config/sim/v1/devices/updateOrderDevices
These APIs maintain Print Classes:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Print Classes
- Method: postPath:
/config/sim/v1/devices/printerclasses
- Delete Print Classes
- Method: postPath:
/config/sim/v1/devices/deletePrinterClasses
- Get Print Classes
- Method: postPath:
/config/sim/v1/devices/getPrinterClasses
- Update Print Classes
- Method: postPath:
/config/sim/v1/devices/updateprinterClasses
These APIs maintain Printers:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Printers
- Method: postPath:
/config/sim/v1/devices/printers
- Delete Printers
- Method: postPath:
/config/sim/v1/devices/deletePrinters
- Get Printers
- Method: postPath:
/config/sim/v1/devices/getprinters
- Update Printers
- Method: postPath:
/config/sim/v1/devices/updatePrinters
These APIs maintain Workstation Classes
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Workstation Classes
- Method: postPath:
/config/sim/v1/devices/workstationClasses
- Delete Workstation Classes
- Method: postPath:
/config/sim/v1/devices/deleteWorkstationClasses
- Get Workstation Classes
- Method: postPath:
/config/sim/v1/devices/getWorkstationClasses
- Update Workstation Classes
- Method: postPath:
/config/sim/v1/devices/updateWorkstationClasses
These APIs maintain devices configured to work with a workstations such as Barcode Scanners, Payment Devices, Cash Drawers etc.
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Workstation Devices
- Method: postPath:
/config/sim/v1/devices/workstations/devices
- Delete Workstation Devices
- Method: postPath:
/config/sim/v1/devices/workstations/deleteDevices
- Get Workstation Devices
- Method: postPath:
/config/sim/v1/devices/workstations/getDevices
- Update Workstation Devices
- Method: postPath:
/config/sim/v1/devices/workstations/updateDevices
These APIs maintain SPI Client Certificate for a workstation of the organization:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add SPI client certificate
- Method: postPath:
/content/sim/v1/devices/workstations/spiClientCertificate
- Delete SPI Client Certificate
- Method: postPath:
/content/sim/v1/devices/workstations/deleteSPIClientCertificate
- Update SPI Client Certificate
- Method: postPath:
/content/sim/v1/devices/workstations/updateSPIclientCertificate
These APIs maintain SPI Server Certificate for a workstation of the organization:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add SPI Server Certificate
- Method: postPath:
/content/sim/v1/devices/workstations/spiServerCertificate
- Delete SPI server certificate
- Method: postPath:
/content/sim/v1/devices/workstations/deleteSPIserverCertificate
- Update SPI server certificate
- Method: postPath:
/content/sim/v1/devices/workstations/updateSPIserverCertificate
These APIs maintain workstations:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Workstations
- Method: postPath:
/config/sim/v1/devices/workstations
- Delete Workstations
- Method: postPath:
/config/sim/v1/devices/deleteworkstations
- Get Workstations
- Method: postPath:
/config/sim/v1/devices/getWorkstations
- Update Workstations
- Method: postPath:
/config/sim/v1/devices/updateWorkstations
These APIs maintain the cashiers:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | This endpoint was added in the API version 23.3.1 |
- Add Cashiers
- Method: postPath:
/config/sim/v1/employees/cashiers
- Delete Cashiers
- Method: postPath:
/config/sim/v1/employees/deleteCashiers
- Get Cashiers
- Method: postPath:
/config/sim/v1/employees/getCashiers
- Update Cashiers
- Method: postPath:
/config/sim/v1/employees/updateCashiers
These APIs maintain the revenue center operator options for the employee classes:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version |
- Get Employee Class Operators
- Method: postPath:
/config/sim/v1/employees/classes/getOperators
- Update Employee Class Operators
- Method: postPath:
/config/sim/v1/employees/classes/updateOperators
These APIs maintain Employee Classes:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Employee Classes
- Method: postPath:
/config/sim/v1/employees/classes
- Delete Employee Classes
- Method: postPath:
/config/sim/v1/employees/deleteClasses
- Get Employee Classes
- Method: postPath:
/config/sim/v1/employees/getClasses
- Update Employee Classes
- Method: postPath:
/config/sim/v1/employees/updateClasses
These APIs maintain the EMC modules visible to the employee:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Employee EMC Visibility
- Method: postPath:
/config/sim/v1/employees/emcVisibility
- Delete Employee EMC Visibility
- Method: postPath:
/config/sim/v1/employees/deleteEmployeeVisibility
- Get Employee EMC Visibility
- Method: postPath:
/config/sim/v1/employees/getEMCVisibility
- Update Employee EMC Visibility
- Method: postPath:
/config/sim/v1/employees/updateEMCVisibility
These APIs maintain the job codes at the property assigned to the employee:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Employee Job Codes
- Method: postPath:
/config/sim/v1/employees/properties/getJobCodes
These APIs maintain the properties assigned to the employee:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Employee Properties
- Method: postPath:
/config/sim/v1/employees/properties
- Delete Employee Properties
- Method: postPath:
/config/sim/v1/employees/deleteProperties
- Get Employee Properties
- Method: postPath:
/config/sim/v1/employees/getProperties
- Update Employee Properties
- Method: postPath:
/config/sim/v1/employees/updateProperties
These APIs maintain the operator records for the property assigned to the employee:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Employee Property Operator
- Method: postPath:
/config/sim/v1/employees/properties/operators
- Delete Employee Property Operator
- Method: postPath:
/config/sim/v1/employees/properties/deleteOperators
- Get Employee Property Operators
- Method: postPath:
/config/sim/v1/employees/properties/getOperators
- Update Employee Property Operator
- Method: postPath:
/config/sim/v1/employees/properties/updateOperators
These APIs maintain the roles associated with an employee:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Employee Roles
- Method: postPath:
/config/sim/v1/employees/employeeRoles
- Delete Employee Roles
- Method: postPath:
/config/sim/v1/employees/deleteEmployeeRoles
- Get Employee Roles
- Method: postPath:
/config/sim/v1/employees/getEmployeeRoles
- Update Employee Roles
- Method: postPath:
/config/sim/v1/employees/updateEmployeeRoles
These APIs maintain Employees:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.5 | Reactivate Employees v1 introduced |
- Add Employee
- Method: postPath:
/config/sim/v1/employees/employees
- Delete Employees
- Method: postPath:
/config/sim/v1/employees/deleteEmployees
- Get Employees
- Method: postPath:
/config/sim/v1/employees/getEmployees
- Pre-Delete Employees
- Method: postPath:
/config/sim/v1/employees/preDeleteCheckEmployees
- Reactivate Employee
- Method: postPath:
/config/sim/v1/employees/reactivateEmployee
- Update Employees
- Method: postPath:
/config/sim/v1/employees/updateEmployees
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 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version. |
- Add basic employees
- Method: postPath:
/config/sim/v1/employees/employees2
- Delete basic employees
- Method: postPath:
/config/sim/v1/employees/deleteEmployees2
- Get basic employees
- Method: postPath:
/config/sim/v1/employees/getEmployees2
- Pre-Delete basic employees
- Method: postPath:
/config/sim/v1/employees/preDeleteCheckEmployees2
- Update basic employees
- Method: postPath:
/config/sim/v1/employees/updateEmployees2
These APIs maintain Roles:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Roles
- Method: postPath:
/config/sim/v1/employees/roles
- Delete Roles
- Method: postPath:
/config/sim/v1/employees/deleteRoles
- Get Roles
- Method: postPath:
/config/sim/v1/employees/getRoles
- Update Roles
- Method: postPath:
/config/sim/v1/employees/updateRoles
These APIs maintain Hierarchy:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Hierarchies
- Method: postPath:
/config/sim/v1/hierarchy/getHierarchy
These APIs maintain Location Parameters:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Location Parameters
- Method: postPath:
/config/sim/v1/hierarchy/locationParameters
- Delete Location Parameters
- Method: postPath:
/config/sim/v1/hierarchy/deleteLocationParameters
- Get Location Parameters
- Method: postPath:
/config/sim/v1/hierarchy/getLocationParameters
- Update Location Parameters
- Method: postPath:
/config/sim/v1/hierarchy/updateLocationParameters
This group of APIs maintains Locations:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
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: postPath:
/config/sim/v1/hierarchy/locations
- Delete Locations
- Method: postPath:
/config/sim/v1/hierarchy/deleteLocations
- Get Locations
- Method: postPath:
/config/sim/v1/hierarchy/getLocations
- Pre-Delete Locations
- Method: postPath:
/config/sim/v1/hierarchy/predeletechecklocations
- Update Locations
- Method: postPath:
/config/sim/v1/hierarchy/updateLocations
This API returns the enterprise levels available in an organization
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
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: postPath:
/config/sim/v1/hierarchy/locations/getEnterpriseLevels
This group of APIs maintains parent enterprise levels assigned to a location within various reporting hierarchies.
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
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: postPath:
/config/sim/v1/hierarchy/locations/deleteReportingHierarchyRelationships
- Get Reporting Hierarchy Levels
- Method: postPath:
/config/sim/v1/hierarchy/locations/getReportingHierarchyLevels
- Get Reporting Hierarchy Relationships
- Method: postPath:
/config/sim/v1/hierarchy/locations/getReportingHierarchyRelationships
- Update Reporting Hierarchy Relationships
- Method: postPath:
/config/sim/v1/hierarchy/locations/updateReportingHierarchyRelationships
These APIs maintain the parameters associated with a revenue center of a location:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Revenue Center Parameters
- Method: postPath:
/config/sim/v1/hierarchy/revenueCenterParameters
- Delete Revenue Center Parameters
- Method: postPath:
/config/sim/v1/hierarchy/deleteRevenueCenterParameters
- Get Revenue Center Parameters
- Method: postPath:
/config/sim/v1/hierarchy/getRevenueCenterParameters
- Update Revenue Center Parameters
- Method: postPath:
/config/sim/v1/hierarchy/updateRevenueCenterParameters
These APIs maintain the revenue centers of a location for a specified organization:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Starting with API release 23.4, a new field rvcMasterObjNum has been introduced which links a Revenue Center to Revenue Center Master. |
23.4.1.6 | The field rvcMasterObjNum has been removed. |
- Add Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/revenueCenters
- Delete Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/deleteRevenueCenters
- Get Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/getRevenueCenters
- Pre-Delete Check Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/preDeleteCheckRevenueCenters
- Update Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/updateRevenueCenters
These APIs maintain Zones:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Zones
- Method: postPath:
/config/sim/v1/hierarchy/getZones
These APIs maintain Barcodes:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Barcodes
- Method: postPath:
/config/sim/v1/menuItems/barcodes
- Bulk Insert Barcodes
- Method: postPath:
/config/sim/v1/menuItems/bulkInsertBarcodes
- Delete Barcodes
- Method: postPath:
/config/sim/v1/menuItems/deleteBarcodes
- Get Barcodes
- Method: postPath:
/config/sim/v1/menuItems/getBarcodes
- Update Barcodes
- Method: postPath:
/config/sim/v1/menuItems/updateBarcodes
These APIs maintain the prices of side groups in combo meals for a specified organization:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v1/menuItems/combomeals/mealsidegroupprices
- Delete Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v1/menuItems/combomeals/deletemealsidegroupprices
- Get Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v1/menuItems/combomeals/getmealsidegroupprices
- Update Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v1/menuItems/combomeals/updatemealsidegroupprices
These APIs maintain Combo Meal Side Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Combo Meal Side Groups
- Method: postPath:
/config/sim/v1/menuItems/combomeals/mealsidegroups
- Delete Combo Meal Side Groups
- Method: postPath:
/config/sim/v1/menuItems/combomeals/deletemealsidegroups
- Get Combo Meal Side Groups
- Method: postPath:
/config/sim/v1/menuItems/combomeals/getmealsidegroups
- Update Combo Meal Side Groups
- Method: postPath:
/config/sim/v1/menuItems/combomeals/updatemealsidegroups
These APIs maintain Combo Meals:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/combomeals
- Bulk Insert Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/bulkinsertcombomeals
- Delete Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/deletecombomeals
- Get Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/getcombomeals
- Pre-Delete Check Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/predeletecheckcombomeals
- Update Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/updatecombomeals
These APIs maintain Combo Meal Side Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Combo Side Group Items
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups/sidegroupitems
- Bulk Insert Combo Side Group Items
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups/bulkinsertsidegroupitems
- Delete Combo Side Group Items
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups/deletesidegroupitems
- Get Combo Side Group Items
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups/getsidegroupitems
- Update Combo Side Group Items
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups/updatesidegroupitems
These APIs maintain Combo Side Group Item Prices:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Combo Side Group Item Prices
- Method: postPath:
/config/sim/v1/menuitems/combosidegroups/sidegroupitemprices
- Delete Combo Side Group Item Prices
- Method: postPath:
/config/sim/v1/menuitems/combosidegroups/deletesidegroupitemprices
- Get Combo Side Group Item Prices
- Method: postPath:
/config/sim/v1/menuitems/combosidegroups/getsidegroupitemprices
- Update Combo Side Group Item Prices
- Method: postPath:
/config/sim/v1/menuitems/combosidegroups/updatesidegroupitemprices
These APIs maintain Combo Meal Side Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Combo Side Groups
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups
- Bulk Insert Combo Side Groups
- Method: postPath:
/config/sim/v1/menuItems/bulkinsertcombosidegroups
- Delete Combo Side Groups
- Method: postPath:
/config/sim/v1/menuItems/deletecombosidegroups
- Get Combo Side Groups
- Method: postPath:
/config/sim/v1/menuItems/getcombosidegroups
- Update Combo Side Groups
- Method: postPath:
/config/sim/v1/menuItems/updatecombosidegroups
These APIs maintain Condiment Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Condiment Groups
- Method: postPath:
/config/sim/v1/menuItems/condimentgroups
- Delete Condiment Groups
- Method: postPath:
/config/sim/v1/menuItems/deletecondimentgroups
- Get Condiment Groups
- Method: postPath:
/config/sim/v1/menuItems/getcondimentgroups
- Update Condiment Groups
- Method: postPath:
/config/sim/v1/menuItems/updatecondimentgroups
These APIs maintain Condiment Sets:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Condiment Sets
- Method: postPath:
/config/sim/v1/menuItems/condimentsets
- Delete Condiment Sets
- Method: postPath:
/config/sim/v1/menuItems/deletecondimentsets
- Get Condiment Sets
- Method: postPath:
/config/sim/v1/menuItems/getcondimentsets
- Update Condiment Sets
- Method: postPath:
/config/sim/v1/menuItems/updatecondimentsets
These APIs maintain Condiment Set Items:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Condiment Set Items
- Method: postPath:
/config/sim/v1/menuItems/condimentsets/items
- Delete Condiment Set Items
- Method: postPath:
/config/sim/v1/menuItems/condimentsets/deleteItems
- Get Condiment Set Items
- Method: postPath:
/config/sim/v1/menuItems/condimentsets/getItems
- Update Condiment Set Items
- Method: postPath:
/config/sim/v1/menuItems/condimentsets/updateItems
These APIs maintain Family Group Consumer Facing Content:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/familyGroups/consumerContent
- Delete Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/familyGroups/deleteConsumerContent
- Download Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/familyGroups/downloadConsumerContent
- Get Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/familyGroups/getConsumerContent
- Update Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/familyGroups/updateConsumerContent
These APIs maintain Family Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Starting with the API release 23.4, Insert & Update operations for Family Groups are allowed only at Enterprise. |
- Add Family Groups
- Method: postPath:
/config/sim/v1/menuItems/familyGroups
- Delete Family Groups
- Method: postPath:
/config/sim/v1/menuItems/deleteFamilygroups
- Get Family Groups
- Method: postPath:
/config/sim/v1/menuItems/getFamilyGroups
- Update Family Groups
- Method: postPath:
/config/sim/v1/menuItems/updateFamilygroups
These APIs maintain Major Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Starting with the API release 23.4, Insert & Update operations for Major Groups are allowed only at Enterprise. |
- Add Major Groups
- Method: postPath:
/config/sim/v1/menuItems/majorGroups
- Delete Major Groups
- Method: postPath:
/config/sim/v1/menuItems/deleteMajorGroups
- Get Major Groups
- Method: postPath:
/config/sim/v1/menuItems/getMajorGroups
- Update Major Groups
- Method: postPath:
/config/sim/v1/menuItems/updateMajorGroups
These APIs maintain Menu Items:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Menu Items 2
- Method: postPath:
/config/sim/v1/menuItems/getMenuItem2
These APIs maintain Menu Item Classes:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.5.0.2 | Starting from API release 23.5.0.2, it is recommended to use Menu Item Classes 2 instead of Menu Item Class. |
- Add Menu Item Classes
- Method: postPath:
/config/sim/v1/menuItems/menuItemClasses
- Delete Menu Item Classes
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemClasses
- Get Menu Item Classes
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemClasses
- Update Menu Item Classes
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemClasses
These APIs maintain Menu Item Definition Consumer Facing Content:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/menuitemdefinition/consumerContent
- Delete Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/menuitemdefinition/deleteConsumerContent
- Download Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/menuitemdefinition/downloadConsumerContent
- Get Menu Item Defintion Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/menuitemdefinition/getConsumerContent
- Update Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v1/menuitems/menuitemdefinition/updateConsumerContent
These APIs maintain the default condiments for a given menu item definition:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Delete Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v1/menuItems/menuitemdefinition/deletedefaultcondiments
- Get Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v1/menuItems/menuitemdefinition/getdefaultcondiments
- Insert Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v1/menuItems/menuitemdefinition/defaultcondiments
- Update Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v1/menuItems/menuitemdefinition/updatedefaultcondiments
These APIs maintain Menu Item Definitions:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/menuItemDefinitions
- Bulk Insert Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/bulkInsertMenuItemDefinitions
- Delete Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemDefinitions
- Get Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemDefinitions
- Pre-Delete Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/preDeleteCheckMenuItemDefinitions
- Update Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemDefinitions
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 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Menu Item Group Details
- Method: postPath:
/config/sim/v1/menuItems/menuItemGroups/details
- Bulk Insert Menu Item Group Details
- Method: postPath:
/config/sim/v1/menuItems/MenuItemGroups/bulkInsertDetails
- Delete Menu Item Group Deatils
- Method: postPath:
/config/sim/v1/menuItems/MenuItemGroups/deleteDetails
- Get Menu Item Group Details
- Method: postPath:
/config/sim/v1/menuItems/MenuItemGroups/getDetails
- Update Menu Item Group Details
- Method: postPath:
/config/sim/v1/menuItems/MenuItemGroups/updateDetails
These APIs maintain Menu Item Groups:
Release | Description |
---|---|
23.2 | This endpoint was added in the API version 23.2 |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
- Add Menu Item Groups
- Method: postPath:
/config/sim/v1/menuItems/menuItemGroups
- Bulk Insert Menu Item Groups
- Method: postPath:
/config/sim/v1/menuItems/bulkInsertMenuItemGroups
- Delete Menu Item Groups
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemGroups
- Get Menu Item Groups
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemGroups
- Update Menu Item Groups
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemGroups
These APIs maintain Menu Item Masters:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 |
|
23.5 | Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8 |
- Add Menu Item Masters
- Method: postPath:
/config/sim/v1/menuItems/menuItemMasters
- Bulk Insert Menu Item Master
- Method: postPath:
/config/sim/v1/menuItems/bulkInsertMenuItemMasters
- Delete Menu Item Masters
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemMasters
- Get Menu Item Masters
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemMasters
- Pre-Delete Check Menu Item Masters
- Method: postPath:
/config/sim/v1/menuItems/preDeleteCheckMenuItemMasters
- Update Menu Item Masters
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemMasters
These APIs maintain Menu Item Effectivity Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version. |
- Add Menu Item Master Effectivty Group
- Method: postPath:
/config/sim/v1/menuItems/menuItemMasterEffectivity
- Delete Menu Item Master Effectivity Group
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemMasterEffectivity
- Get Menu Item Master Effectivity Groups
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemMasterEffectivity
- Update Menu Item Master Effectivity Group
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemMasterEffectivity
These APIs maintain Menu Item Master Groups:
Release | Description |
---|---|
23.2 | This endpoint was added in the API version 23.2 |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Menu Item Master Groups
- Method: postPath:
/config/sim/v1/menuItems/menuItemMasterGroups
- Delete Menu Item Master Groups
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemMasterGroups
- Get Menu Item Master Groups
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemMasterGroups
- Update Menu Item Master Groups
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemMasterGroups
These APIs maintain Menu Item Prices:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 | Added bulk insert endpoint |
23.5 | Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8 |
- Add Menu Item Prices
- Method: postPath:
/config/sim/v1/menuItems/menuItemPrices
- Bulk Insert Menu Item Prices
- Method: postPath:
/config/sim/v1/menuItems/bulkInsertMenuItemPrices
- Delete Menu Item Prices
- Method: postPath:
/config/sim/v1/menuItems/deleteMenuItemPrices
- Get Menu Item Prices
- Method: postPath:
/config/sim/v1/menuItems/getMenuItemPrices
- Update Menu Item Prices
- Method: postPath:
/config/sim/v1/menuItems/updateMenuItemPrices
These APIs maintain Menu Items:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Menu Items
- Method: postPath:
/config/sim/v1/menuitems/getMenuItems
This API returns available object numbers:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version. |
- Get Available Object Numbers
- Method: postPath:
/config/sim/v1/getAvailableObjectNumbers
Use this API to obtain bulk processing request status updates.
Release | Description |
---|---|
23.4 | First introduced in this version |
- Gets the status of a bulk processing request
- Method: postPath:
/config/sim/v1/bulkStatusRequest
These APIs clone configuration data from one organization to another.
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Create Clone
- Method: postPath:
/clones/sim/v1/createConfig
- Get Clone Request Status
- Method: postPath:
/clones/sim/v1/getStatus
- Get Clones
- Method: postPath:
/clones/sim/v1/getClones
- Import Clone
- Method: postPath:
/clones/sim/v1/importConfig
This API returns Version Information:
Release | Description |
---|---|
23.2 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get version information
- Method: postPath:
/config/sim/v1/getReleaseVersions
These APIs maintain Discount Itemizers:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Discount Itemizers
- Method: postPath:
/config/sim/v1/sales/discountitemizers
- Delete Discount Itemizers
- Method: postPath:
/config/sim/v1/sales/deletediscountitemizers
- Get Discount Itemizers
- Method: postPath:
/config/sim/v1/sales/getdiscountitemizers
- Update Discount Itemizers
- Method: postPath:
/config/sim/v1/sales/updatediscountitemizers
These APIs maintain Discounts:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.4 |
|
23.5 | Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8 |
- Add Discounts
- Method: postPath:
/config/sim/v1/sales/discounts
- Delete Discounts
- Method: postPath:
/config/sim/v1/sales/deleteDiscounts
- Get Discounts
- Method: postPath:
/config/sim/v1/sales/getDiscounts
- Update Discounts
- Method: postPath:
/config/sim/v1/sales/updateDiscounts
These APIs maintain Discount Award Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Discount Award Groups
- Method: postPath:
/config/sim/v1/sales/discounts/awardgroups
- Delete Discount Award Groups
- Method: postPath:
/config/sim/v1/sales/discounts/deleteawardgroups
- Get Discount Award Groups
- Method: postPath:
/config/sim/v1/sales/discounts/getawardgroups
- Update Discount Award Groups
- Method: postPath:
/config/sim/v1/sales/discounts/updateawardgroups
These APIs maintain Discount Trigger Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Discount Trigger Groups
- Method: postPath:
/config/sim/v1/sales/discounts/triggergroups
- Delete Discount Trigger Groups
- Method: postPath:
/config/sim/v1/sales/discounts/deletetriggergroups
- Get Discount Trigger Groups
- Method: postPath:
/config/sim/v1/sales/discounts/gettriggergroups
- Update Discount Trigger Groups
- Method: postPath:
/config/sim/v1/sales/discounts/updatetriggergroups
These APIs maintain details of Service Charge Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Service Charge Group Details
- Method: postPath:
/config/sim/v1/sales/servicechargegroups/details
- Delete Service Charge Group Details
- Method: postPath:
/config/sim/v1/sales/servicechargegroups/deletedetails
- Get Service Charge Group Details
- Method: postPath:
/config/sim/v1/sales/servicechargegroups/getdetails
- Update Service Charge Group Details
- Method: postPath:
/config/sim/v1/sales/servicechargegroups/updatedetails
These APIs maintain Service Charge Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Service Charge Groups
- Method: postPath:
/config/sim/v1/sales/servicechargegroups
- Delete Service Charge Groups
- Method: postPath:
/config/sim/v1/sales/deleteservicechargegroups
- Get Service Charge Groups
- Method: postPath:
/config/sim/v1/sales/getservicechargegroups
- Update Service Charge Groups
- Method: postPath:
/config/sim/v1/sales/updateservicechargegroups
These APIs maintain Service Charge Itemizers:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Service Charge Itemizers
- Method: postPath:
/config/sim/v1/sales/servicechargeitemizers
- Delete Service Charge Itemizers
- Method: postPath:
/config/sim/v1/sales/deleteservicechargeitemizers
- Get Service Charge Itemizers
- Method: postPath:
/config/sim/v1/sales/getservicechargeitemizers
- Update Service Charge Itemizers
- Method: postPath:
/config/sim/v1/sales/updateservicechargeitemizers
These APIs maintain Service Charges:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.5 | Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8 |
- Add Service Charges
- Method: postPath:
/config/sim/v1/sales/serviceCharges
- Delete Service Charges
- Method: postPath:
/config/sim/v1/sales/deleteServicecharges
- Get Service Charges
- Method: postPath:
/config/sim/v1/sales/getServicecharges
- Update Service Charges
- Method: postPath:
/config/sim/v1/sales/updateServicecharges
These APIs maintain Tax Classes:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Tax Classes
- Method: postPath:
/config/sim/v1/sales/taxclasses
- Delete Tax Classes
- Method: postPath:
/config/sim/v1/sales/deletetaxclasses
- Get Tax Classes
- Method: postPath:
/config/sim/v1/sales/gettaxclasses
- Update Tax Classes
- Method: postPath:
/config/sim/v1/sales/updatetaxclasses
These APIs maintain Tax Parameters:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.5 | Added 2 new option bits - 19 & 20, under internationalOptions |
- Add Tax Parameters
- Method: postPath:
/config/sim/v1/sales/taxparameters
- Delete Tax Parameters
- Method: postPath:
/config/sim/v1/sales/deletetaxparameters
- Get Tax Parameters
- Method: postPath:
/config/sim/v1/sales/gettaxparameters
- Update Tax Parameters
- Method: postPath:
/config/sim/v1/sales/updatetaxparameters
These APIs maintain breakpoints for a Tax Rate:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Tax Breakpoints
- Method: postPath:
/config/sim/v1/sales/gettaxbreakpoints
- Update Tax Breakpoints
- Method: postPath:
/config/sim/v1/sales/updatetaxbreakpoints
These APIs maintain Tax Rates:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Tax Rates
- Method: postPath:
/config/sim/v1/sales/taxrates
- Delete Tax Rates
- Method: postPath:
/config/sim/v1/sales/deletetaxrates
- Get Tax Rates
- Method: postPath:
/config/sim/v1/sales/gettaxrates
- Update Tax Rates
- Method: postPath:
/config/sim/v1/sales/updatetaxrates
These APIs maintain Tender Media:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.5 | Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8 |
- Add Tender Media
- Method: postPath:
/config/sim/v1/sales/tenderMedia
- Delete Tender Media
- Method: postPath:
/config/sim/v1/sales/deleteTenderMedia
- Get Tender Media
- Method: postPath:
/config/sim/v1/sales/getTenderMedia
- Update Tender Media
- Method: postPath:
/config/sim/v1/sales/updateTenderMedia
These APIs maintain Auto Menu Levels:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Auto Menu Levels
- Method: postPath:
/config/sim/v1/setup/autoMenuLevels
- Delete Auto Menu Levels
- Method: postPath:
/config/sim/v1/setup/deleteAutoMenuLevels
- Get Auto Menu Levels
- Method: postPath:
/config/sim/v1/setup/getAutoMenuLevels
- Update Auto Menu Levels
- Method: postPath:
/config/sim/v1/setup/updateAutoMenuLevels
These APIs maintain CAL Deployment Schedules:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add CAL Deployment Schedules
- Method: postPath:
/config/sim/v1/setup/cal/deploymentSchedules
- Delete CAL Deployment Schedules
- Method: postPath:
/config/sim/v1/setup/cal/deleteDeploymentSchedules
- Get CAL Deployment Schedules
- Method: postPath:
/config/sim/v1/setup/cal/getDeploymentSchedules
- Update CAL Deployment Schedules
- Method: postPath:
/config/sim/v1/setup/cal/updateDeploymentSchedules
These APIs maintain CAL Packages:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get CAL Packages
- Method: postPath:
/config/sim/v1/setup/cal/getPackages
These APIs maintain Cash Management Receptacle Templates:
Release | Description |
---|---|
23.3 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v1/setup/cashManagementReceptacleTemplates
- Delete Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v1/setup/deleteCashManagementReceptacleTemplates
- Get Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v1/setup/getCashManagementReceptacleTemplates
- Update Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v1/setup/updateCashManagementReceptacleTemplates
These APIs maintain Currencies:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Currencies
- Method: postPath:
/config/sim/v1/setup/currencies
- Delete Currencies
- Method: postPath:
/config/sim/v1/setup/deleteCurrencies
- Get Currencies
- Method: postPath:
/config/sim/v1/setup/getCurrencies
- Update Currencies
- Method: postPath:
/config/sim/v1/setup/updateCurrencies
These APIs maintain Currency Availability:
Release | Description |
---|---|
23.3 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Currency Availability
- Method: postPath:
/config/sim/v1/setup/currencyavailability
- Delete Currency Availability
- Method: postPath:
/config/sim/v1/setup/deletecurrencyavailability
- Get Currency Availability
- Method: postPath:
/config/sim/v1/setup/getcurrencyavailability
- Update Currency Availability
- Method: postPath:
/config/sim/v1/setup/updatecurrencyavailability
These APIs maintain Currency Conversions:
Release | Description |
---|---|
23.3 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Currency Conversion.
- Method: postPath:
/config/sim/v1/setup/currencyconversion
- Delete currency conversion.
- Method: postPath:
/config/sim/v1/setup/deletecurrencyconversion
- Get currency conversions.
- Method: postPath:
/config/sim/v1/setup/getcurrencyconversion
- Update currency conversion.
- Method: postPath:
/config/sim/v1/setup/updatecurrencyconversion
These APIs maintain Currency Parameters:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.6 | The fields altCurrObjNum and altCurrObjName have been removed. |
- Add Currency Parameters
- Method: postPath:
/config/sim/v1/setup/currencyparameters
- Delete Currency Parameters
- Method: postPath:
/config/sim/v1/setup/deletecurrencyparameters
- Get Currency Parameters
- Method: postPath:
/config/sim/v1/setup/getcurrencyparameters
- Update Currency Parameters
- Method: postPath:
/config/sim/v1/setup/updatecurrencyparameters
These APIs maintain Custom Content:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Custom Content
- Method: postPath:
/content/sim/v1/setup/customContent
- Delete Custom Content
- Method: postPath:
/content/sim/v1/setup/deleteCustomContent
- Download Custom Content.
- Method: postPath:
/content/sim/v1/setup/downloadCustomContent
- Get Custom Content
- Method: postPath:
/content/sim/v1/setup/getCustomContent
- Update Custom Content
- Method: postPath:
/content/sim/v1/setup/updateCustomContent
These APIs maintain Data Extensions:
Release | Description |
---|---|
23.2 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Data Extensions
- Method: postPath:
/config/sim/v1/setup/DataExtensions
- Delete Data Extensions
- Method: postPath:
/config/sim/v1/setup/deleteDataExtensions
- Get Data Extensions
- Method: postPath:
/config/sim/v1/setup/getDataExtensions
- Update Data Extensions
- Method: postPath:
/config/sim/v1/setup/updateDataExtensions
These APIs maintain Effectivity Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Effectivity Groups
- Method: postPath:
/config/sim/v1/setup/effectivitygroups
- Delete Effectivity Groups
- Method: postPath:
/config/sim/v1/setup/deleteeffectivitygroups
- Get Effectivity Groups
- Method: postPath:
/config/sim/v1/setup/geteffectivitygroups
- Update Effectivity Groups
- Method: postPath:
/config/sim/v1/setup/updateeffectivitygroups
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 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version. |
- Add Enable Effectivity Groups.
- Method: postPath:
/config/sim/v1/setup/effectivityGroups/enableEffectivityGroups
- Delete Enable Effectivity Groups.
- Method: postPath:
/config/sim/v1/setup/effectivityGroups/deleteEnableEffectivityGroups
- Get Enable Effectivity Groups.
- Method: postPath:
/config/sim/v1/setup/effectivitygroups/getEnableEffectivityGroups
- Update Enable Effectivity Groups.
- Method: postPath:
/config/sim/v1/setup/effectivityGroups/updateEnableEffectivityGroups
These APIs maintain Headers and Trailers:
Release | Description |
---|---|
23.3 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Headers/Trailers
- Method: postPath:
/config/sim/v1/setup/headerstrailers
- Delete Header/Trailer
- Method: postPath:
/config/sim/v1/setup/deleteheaderstrailers
- Get Headers/Trailers
- Method: postPath:
/config/sim/v1/setup/getheaderstrailers
- Update Headers/Trailers
- Method: postPath:
/config/sim/v1/setup/updateheaderstrailers
These APIs maintain Languages:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Languages
- Method: postPath:
/config/sim/v1/setup/languages
- Delete Languages
- Method: postPath:
/config/sim/v1/setup/deleteLanguages
- Get Languages
- Method: postPath:
/config/sim/v1/setup/getLanguages
- Update Languages
- Method: postPath:
/config/sim/v1/setup/updateLanguages
These APIs maintain Locales:
Release | Description |
---|---|
23.2 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Locales
- Method: postPath:
/config/sim/v1/setup/locales
- Delete locales
- Method: postPath:
/config/sim/v1/setup/deleteLocales
- Get Locales
- Method: postPath:
/config/sim/v1/setup/getLocales
- Update Locales
- Method: postPath:
/config/sim/v1/setup/updateLocales
These APIs maintain Menu Level Entries for a Menu Level Set:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Menu Level Entries
- Method: postPath:
/config/sim/v1/setup/menulevels/menuLevelEntries
- Delete Menu Level Entries
- Method: postPath:
/config/sim/v1/setup/menulevels/deleteMenuLevelEntries
- Get Menu Level Entries
- Method: postPath:
/config/sim/v1/setup/menulevels/getMenuLevelEntries
- Update Menu Level Entries
- Method: postPath:
/config/sim/v1/setup/menulevels/updateMenuLevelEntries
These APIs maintain Menu Levels
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Menu Levels
- Method: postPath:
/config/sim/v1/setup/menulevels
- Delete Menu Levels
- Method: postPath:
/config/sim/v1/setup/deletemenulevels
- Get Menu Levels
- Method: postPath:
/config/sim/v1/setup/getmenulevels
- Update Menu Levels
- Method: postPath:
/config/sim/v1/setup/updatemenulevels
These APIs maintain Order Channel parameters.
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version. |
- Add Order Channel Parameters
- Method: postPath:
/config/sim/v1/setup/orderchannelparameters
- Delete Order Channel Parameters
- Method: postPath:
/config/sim/v1/setup/deleteorderchannelparameters
- Get Order Channel Parameters
- Method: postPath:
/config/sim/v1/setup/getorderchannelparameters
- Update Order Channel Parameters
- Method: postPath:
/config/sim/v1/setup/updateorderchannelparameters
These APIs maintain Order Channels.
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.3.1 | First introduced in this version. |
- Add Order Channels
- Method: postPath:
/config/sim/v1/setup/orderchannels
- Get Order Channels
- Method: postPath:
/config/sim/v1/setup/getorderchannels
- Update Order Channels
- Method: postPath:
/config/sim/v1/setup/updateorderchannels
These APIs maintain Order Types:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
23.5 | Starting from Simphony version 19.8, Add Order Types API will no longer be available and Update Order Types API will no longer add records. |
- Add Order Types
- Method: postPath:
/config/sim/v1/setup/ordertypenames
- Delete Order Types
- Method: postPath:
/config/sim/v1/setup/deleteordertypenames
- Get Order Types
- Method: postPath:
/config/sim/v1/setup/getordertypenames
- Update Order Types
- Method: postPath:
/config/sim/v1/setup/updateordertypenames
These APIs maintain Order Type Parameters:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Order Type Parameters
- Method: postPath:
/config/sim/v1/setup/orderTypeParameters
- Delete Order Type Parameters
- Method: postPath:
/config/sim/v1/setup/deleteOrdertypeParameters
- Get Order Types Parameters
- Method: postPath:
/config/sim/v1/setup/getOrderTypeParameters
- Update Order Type Parameters
- Method: postPath:
/config/sim/v1/setup/updateOrdertypeParameters
These APIs maintain Payment Driver Configurations:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Get Payment Driver Configuration
- Method: postPath:
/config/sim/v1/setup/getpaymentdriverconfiguration
- Update Payment Driver Configuration
- Method: postPath:
/config/sim/v1/setup/updatepaymentdriverconfiguration
These APIs maintain Payment Drivers:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Payment Drivers
- Method: postPath:
/content/sim/v1/setup/paymentdrivers
- Delete Payment Drivers
- Method: postPath:
/content/sim/v1/setup/deletepaymentdrivers
- Download Payment Drivers
- Method: postPath:
/content/sim/v1/setup/downloadpaymentdrivers
- Get Payment Drivers
- Method: postPath:
/content/sim/v1/setup/getpaymentdrivers
- Update Payment Drivers
- Method: postPath:
/content/sim/v1/setup/updatepaymentdrivers
These APIs maintain Print Logos:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Print Logos
- Method: postPath:
/content/sim/v1/setup/printLogos
- Delete Print Logos
- Method: postPath:
/content/sim/v1/setup/deletePrintLogos
- Download Print Logos
- Method: postPath:
/content/sim/v1/setup/downloadPrintLogos
- Get Print Logos
- Method: postPath:
/content/sim/v1/setup/getPrintLogos
- Update Print Logos
- Method: postPath:
/content/sim/v1/setup/updatePrintLogos
These APIs maintain Report Groups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Report Groups
- Method: postPath:
/config/sim/v1/setup/reportGroups
- Delete Report Groups
- Method: postPath:
/config/sim/v1/setup/deleteReportGroups
- Get Report Groups
- Method: postPath:
/config/sim/v1/setup/getReportGroups
- Update Report Groups
- Method: postPath:
/config/sim/v1/setup/updateReportGroups
These APIs maintain Sales Itemizers:
Release | Description |
---|---|
23.2 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Sales Itemizers
- Method: postPath:
/config/sim/v1/setup/salesitemizers
- Delete Sales Itemizers
- Method: postPath:
/config/sim/v1/setup/deletesalesitemizers
- Get Sales Itemizers
- Method: postPath:
/config/sim/v1/setup/getsalesitemizers
- Update Sales Itemizers
- Method: postPath:
/config/sim/v1/setup/updatesalesitemizers
These APIs maintain SLU Consumer Facing Content:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add SLU Consumer Facing Content
- Method: postPath:
/content/sim/v1/setup/screenlookups/consumercontent
- Delete SLU Consumer Facing Content
- Method: postPath:
/content/sim/v1/setup/screenlookups/deleteconsumercontent
- Download SLU Consumer Facing Content
- Method: postPath:
/content/sim/v1/setup/screenlookups/downloadconsumercontent
- Get SLU Consumer Facing Content
- Method: postPath:
/content/sim/v1/setup/screenlookups/getconsumercontent
- Update SLU Consumer Facing Content
- Method: postPath:
/content/sim/v1/setup/screenlookups/updateconsumercontent
These APIs maintain Screen Look Ups:
Release | Description |
---|---|
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Screen Look Ups
- Method: postPath:
/config/sim/v1/setup/screenlookups
- Delete Screen Look Ups
- Method: postPath:
/config/sim/v1/setup/deletescreenlookups
- Get Screen Look Ups
- Method: postPath:
/config/sim/v1/setup/getscreenlookups
- Update Screen Look Ups
- Method: postPath:
/config/sim/v1/setup/updatescreenlookups
These APIs maintain Tag Groups:
Release | Description |
---|---|
23.2 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Tag Groups
- Method: postPath:
/config/sim/v1/setup/tagGroups
- Delete Tag Groups
- Method: postPath:
/config/sim/v1/setup/deleteTagGroups
- Get Tag Groups
- Method: postPath:
/config/sim/v1/setup/getTagGroups
- Update Tag Groups
- Method: postPath:
/config/sim/v1/setup/updateTagGroups
These APIs maintain Tags:
Release | Description |
---|---|
23.2 | First introduced in this version. |
23.3 | The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. |
- Add Tags
- Method: postPath:
/config/sim/v1/setup/tags
- Delete Tags
- Method: postPath:
/config/sim/v1/setup/deleteTags
- Get Tags
- Method: postPath:
/config/sim/v1/setup/getTags
- Update Tags
- Method: postPath:
/config/sim/v1/setup/updateTags
This API return detailed information of Device Status
Release | Description |
---|---|
23.5 | First release |
- Get Device Status Details
- Method: postPath:
/config/sim/v2/devices/deviceStatus/getDetails
This API return Device Status information
Release | Description |
---|---|
23.5 | First release |
- Get Device Status
- Method: postPath:
/config/sim/v2/devices/getDeviceStatus
These APIs maintain Kitchen Display Clients
Release | Description |
---|---|
23.5 | Kitchen Display Clients v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Kitchen Display Clients
- Method: postPath:
/config/sim/v2/devices/kitchenDisplays
- Delete Kitchen Display Clients
- Method: postPath:
/config/sim/v2/devices/deleteKitchenDisplays
- Get Kitchen Display Clients
- Method: postPath:
/config/sim/v2/devices/getKitchenDisplays
- Update Kitchen Display Clients
- Method: postPath:
/config/sim/v2/devices/updateKitchenDisplays
These APIs maintain Kitchen Display Controllers
Release | Description |
---|---|
23.5 | Kitchen Display Controllers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Kitchen Display Controllers
- Method: postPath:
/config/sim/v2/devices/kitchenDisplayControllers
- Delete Kitchen Display Controllers
- Method: postPath:
/config/sim/v2/devices/deleteKitchenDisplayControllers
- Get Kitchen Display Controllers
- Method: postPath:
/config/sim/v2/devices/getKitchenDisplayControllers
- Update Kitchen Display Controllers
- Method: postPath:
/config/sim/v2/devices/updateKitchenDisplayControllers
These APIs maintain Order Devices:
Release | Description |
---|---|
23.5 | Order Devices v2 introduced. |
- Get Order Devices
- Method: postPath:
/config/sim/v2/devices/getOrderDevices
- Update Order Devices
- Method: postPath:
/config/sim/v2/devices/updateOrderDevices
These APIs maintain Print Classes:
Release | Description |
---|---|
23.5 | Print Classes v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Print Classes
- Method: postPath:
/config/sim/v2/devices/printerClasses
- Delete Print Classes
- Method: postPath:
/config/sim/v2/devices/deletePrinterClasses
- Get Print Classes
- Method: postPath:
/config/sim/v2/devices/getPrinterClasses
- Update Print Classes
- Method: postPath:
/config/sim/v2/devices/updatePrinterClasses
These APIs maintain Printers:
Release | Description |
---|---|
23.5 | Printers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Printers
- Method: postPath:
/config/sim/v2/devices/printers
- Delete Printers
- Method: postPath:
/config/sim/v2/devices/deletePrinters
- Get Printers
- Method: postPath:
/config/sim/v2/devices/getPrinters
- Update Printers
- Method: postPath:
/config/sim/v2/devices/updatePrinters
These APIs maintain Workstation Classes
Release | Description |
---|---|
23.5 | Workstation Classes v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Workstation Classes
- Method: postPath:
/config/sim/v2/devices/workstationClasses
- Delete Workstation Classes
- Method: postPath:
/config/sim/v2/devices/deleteWorkstationClasses
- Get Workstation Classes
- Method: postPath:
/config/sim/v2/devices/getWorkstationClasses
- Update Workstation Classes
- Method: postPath:
/config/sim/v2/devices/updateWorkstationClasses
These APIs maintain devices configured to work with a workstations such as Barcode Scanners, Payment Devices, Cash Drawers etc.
Release | Description |
---|---|
23.5 | Workstation Devices v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Workstation Devices
- Method: postPath:
/config/sim/v2/devices/workstations/devices
- Delete Workstation Devices
- Method: postPath:
/config/sim/v2/devices/workstations/deleteDevices
- Get Workstation Devices
- Method: postPath:
/config/sim/v2/devices/workstations/getDevices
- Update Workstation Devices
- Method: postPath:
/config/sim/v2/devices/workstations/updateDevices
These APIs maintain SPI Client Certificate for a workstation of the organization:
Release | Description |
---|---|
23.5 | Add, Update and Delete SPI Client Certificate v2 introduced. |
- Add SPI client certificate
- Method: postPath:
/content/sim/v2/devices/workstations/SPIClientCertificate
- Delete SPI Client Certificate
- Method: postPath:
/content/sim/v2/devices/workstations/deleteSPIClientCertificate
- Update SPI Client Certificate
- Method: postPath:
/content/sim/v2/devices/workstations/updateSPIClientCertificate
These APIs maintain SPI Server Certificate for a workstation of the organization:
Release | Description |
---|---|
23.5 | Add, Update and Delete SPI Server Certificate v2 introduced. |
- Add SPI Server Certificate
- Method: postPath:
/content/sim/v2/devices/workstations/SPIServerCertificate
- Delete SPI server certificate
- Method: postPath:
/content/sim/v2/devices/workstations/deleteSPIServerCertificate
- Update SPI server certificate
- Method: postPath:
/content/sim/v2/devices/workstations/updateSPIServerCertificate
These APIs maintain workstations:
Release | Description |
---|---|
23.5 | Workstations v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Workstations
- Method: postPath:
/config/sim/v2/devices/workstations
- Delete Workstations
- Method: postPath:
/config/sim/v2/devices/deleteWorkstations
- Get Workstations
- Method: postPath:
/config/sim/v2/devices/getWorkstations
- Update Workstations
- Method: postPath:
/config/sim/v2/devices/updateWorkstations
These APIs maintain the cashiers:
Release | Description |
---|---|
23.5 | Cashiers v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Cashiers
- Method: postPath:
/config/sim/v2/employees/cashiers
- Delete Cashiers
- Method: postPath:
/config/sim/v2/employees/deleteCashiers
- Get Cashiers
- Method: postPath:
/config/sim/v2/employees/getCashiers
- Update Cashiers
- Method: postPath:
/config/sim/v2/employees/updateCashiers
These APIs maintain the revenue center operator options for the employee classes:
Release | Description |
---|---|
23.5 | Employee Class Operators v2 introduced. |
- Get Employee Class Operators
- Method: postPath:
/config/sim/v2/employees/classes/getOperators
- Update Employee Class Operators
- Method: postPath:
/config/sim/v2/employees/classes/updateOperators
These APIs maintain Employee Classes:
Release | Description |
---|---|
23.5 | Employee Classes v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Employee Classes
- Method: postPath:
/config/sim/v2/employees/classes
- Delete Employee Classes
- Method: postPath:
/config/sim/v2/employees/deleteClasses
- Get Employee Classes
- Method: postPath:
/config/sim/v2/employees/getClasses
- Update Employee Classes
- Method: postPath:
/config/sim/v2/employees/updateClasses
These APIs maintain the EMC modules visible to the employee:
Release | Description |
---|---|
23.5 | Employee EMC Visibility v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Employee EMC Visibility
- Method: postPath:
/config/sim/v2/employees/EMCVisibility
- Delete Employee EMC Visibility
- Method: postPath:
/config/sim/v2/employees/deleteEMCVisibility
- Get Employee EMC Visibility
- Method: postPath:
/config/sim/v2/employees/getEMCVisibility
- Update Employee EMC Visibility
- Method: postPath:
/config/sim/v2/employees/updateEMCVisibility
These APIs maintain the job codes at the property assigned to the employee:
Release | Description |
---|---|
23.5 | Get Employee Job Codes v2 introduced. |
- Get Employee Job Codes
- Method: postPath:
/config/sim/v2/employees/properties/getJobCodes
These APIs maintain the properties assigned to the employee:
Release | Description |
---|---|
23.5 | Employee Properties v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Employee Properties
- Method: postPath:
/config/sim/v2/employees/properties
- Delete Employee Properties
- Method: postPath:
/config/sim/v2/employees/deleteProperties
- Get Employee Properties
- Method: postPath:
/config/sim/v2/employees/getProperties
- Update Employee Properties
- Method: postPath:
/config/sim/v2/employees/updateProperties
These APIs maintain the operator records for the property assigned to the employee:
Release | Description |
---|---|
23.5 | Employee Property Operators v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Employee Property Operator
- Method: postPath:
/config/sim/v2/employees/properties/operators
- Delete Employee Property Operator
- Method: postPath:
/config/sim/v2/employees/properties/deleteOperators
- Get Employee Property Operators
- Method: postPath:
/config/sim/v2/employees/properties/getOperators
- Update Employee Property Operator
- Method: postPath:
/config/sim/v2/employees/properties/updateOperators
These APIs maintain the roles associated with an employee:
Release | Description |
---|---|
23.5 | Employee Roles v2 introduced |
23.6 | Support for system employee roles introduced |
- Add Employee Roles
- Method: postPath:
/config/sim/v2/employees/employeeRoles
- Delete Employee Roles
- Method: postPath:
/config/sim/v2/employees/deleteEmployeeRoles
- Get Employee Roles
- Method: postPath:
/config/sim/v2/employees/getEmployeeRoles
- Update Employee Roles
- Method: postPath:
/config/sim/v2/employees/updateEmployeeRoles
These APIs maintain Employees:
Release | Description |
---|---|
23.5 | Employees v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Employee
- Method: postPath:
/config/sim/v2/employees/employees
- Delete Employees
- Method: postPath:
/config/sim/v2/employees/deleteEmployees
- Get Employees
- Method: postPath:
/config/sim/v2/employees/getEmployees
- Pre-Delete Employees
- Method: postPath:
/config/sim/v2/employees/preDeleteCheckEmployees
- Reactivate Employee
- Method: postPath:
/config/sim/v2/employees/reactivateEmployee
- Update Employees
- Method: postPath:
/config/sim/v2/employees/updateEmployees
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.5 | Basic employees v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add basic employees
- Method: postPath:
/config/sim/v2/employees/employees2
- Delete basic employees
- Method: postPath:
/config/sim/v2/employees/deleteEmployees2
- Get basic employees
- Method: postPath:
/config/sim/v2/employees/getEmployees2
- Pre-Delete basic employees
- Method: postPath:
/config/sim/v2/employees/preDeleteCheckEmployees2
- Update basic employees
- Method: postPath:
/config/sim/v2/employees/updateEmployees2
These APIs maintain Roles:
Release | Description |
---|---|
23.5 | Roles v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Roles
- Method: postPath:
/config/sim/v2/employees/roles
- Delete Roles
- Method: postPath:
/config/sim/v2/employees/deleteRoles
- Get Roles
- Method: postPath:
/config/sim/v2/employees/getRoles
- Update Roles
- Method: postPath:
/config/sim/v2/employees/updateRoles
These APIs maintain system employee properties only when Labor Management is enabled and are not supported for a Simphony Essentials Edition:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add System Employee Properties
- Method: postPath:
/config/sim/v2/employees/systemEmployeeProperties
- Delete System Employee Properties
- Method: postPath:
/config/sim/v2/employees/deleteSystemEmployeeProperties
- Get System Employee Properties
- Method: postPath:
/config/sim/v2/employees/getSystemEmployeeProperties
- Update System Employee Properties
- Method: postPath:
/config/sim/v2/employees/updateSystemEmployeeProperties
These APIs maintain system employee property operators only when Labor Management is enabled and are not supported for a Simphony Essentials Edition:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add System Employee Property Operators
- Method: postPath:
/config/sim/v2/employees/systemEmployeePropertyOperators
- Delete System Employee Property Operators
- Method: postPath:
/config/sim/v2/employees/deleteSystemEmployeePropertyOperators
- Get System Employee Property Operators
- Method: postPath:
/config/sim/v2/employees/getSystemEmployeePropertyOperators
- Update System Employee Property Operators
- Method: postPath:
/config/sim/v2/employees/updateSystemEmployeePropertyOperators
These APIs maintain system employees only when Labor Management is enabled and are not supported for a Simphony Essentials Edition:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add System Employees
- Method: postPath:
/config/sim/v2/employees/systemEmployees
- Delete System Employees
- Method: postPath:
/config/sim/v2/employees/deleteSystemEmployees
- Get System Employees
- Method: postPath:
/config/sim/v2/employees/getSystemEmployees
- Update System Employees
- Method: postPath:
/config/sim/v2/employees/updateSystemEmployees
These APIs maintain Hierarchy:
Release | Description |
---|---|
23.5 | Get Hierarchy v2 introduced |
23.6 | Get Hierarchy Nodes introduced |
- Get Hierarchies
- Method: postPath:
/config/sim/v2/hierarchy/getHierarchy
- Get Hierarchy Nodes
- Method: postPath:
/config/sim/v2/hierarchy/getHierarchyNodes
These APIs maintain Location Parameters:
Release | Description |
---|---|
23.5 | Get and Update Location Parameters v2 introduced. |
23.6 |
|
- Get Location Parameters
- Method: postPath:
/config/sim/v2/hierarchy/getLocationParameters
- Update Location Parameters
- Method: postPath:
/config/sim/v2/hierarchy/updateLocationParameters
This group of APIs maintains Locations:
Release | Description |
---|---|
23.5 | Locations v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Locations
- Method: postPath:
/config/sim/v2/hierarchy/locations
- Delete Locations
- Method: postPath:
/config/sim/v2/hierarchy/deleteLocations
- Get Locations
- Method: postPath:
/config/sim/v2/hierarchy/getLocations
- Pre-Delete Locations
- Method: postPath:
/config/sim/v2/hierarchy/preDeleteCheckLocations
- Update Locations
- Method: postPath:
/config/sim/v2/hierarchy/updateLocations
This API returns the enterprise levels available in an organization
Release | Description |
---|---|
23.5 | Get Enterprise Levels v2 introduced. |
- Get Enterprise Levels
- Method: postPath:
/config/sim/v2/hierarchy/locations/getEnterpriseLevels
This group of APIs maintains parent enterprise levels assigned to a location within various reporting hierarchies.
Release | Description |
---|---|
23.5 | Get Reporting Hierarchy Levels and Get, Update and Delete Reporting Hierarchy Relationships v2 introduced. |
- Delete Reporting Hierarchy Relationships
- Method: postPath:
/config/sim/v2/hierarchy/locations/deleteReportingHierarchyRelationships
- Get Reporting Hierarchy Levels
- Method: postPath:
/config/sim/v2/hierarchy/locations/getReportingHierarchyLevels
- Get Reporting Hierarchy Relationships
- Method: postPath:
/config/sim/v2/hierarchy/locations/getReportingHierarchyRelationships
- Update Reporting Hierarchy Relationships
- Method: postPath:
/config/sim/v2/hierarchy/locations/updateReportingHierarchyRelationships
These APIs maintain the parameters associated with a revenue center of a location:
Release | Description |
---|---|
23.5 | Get and Update Revenue Center Parameters v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Get Revenue Center Parameters
- Method: postPath:
/config/sim/v2/hierarchy/getRevenueCenterParameters
- Update Revenue Center Parameters
- Method: postPath:
/config/sim/v2/hierarchy/updateRevenueCenterParameters
These APIs maintain the revenue centers of a location for a specified organization:
Release | Description |
---|---|
23.5 | Revenue Centers v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Revenue Centers
- Method: postPath:
/config/sim/v2/hierarchy/revenueCenters
- Checks the existence of references to the object in the database.
- Method: postPath:
/config/sim/v2/hierarchy/preDeleteCheckRevenueCenters
- Delete Revenue Centers
- Method: postPath:
/config/sim/v2/hierarchy/deleteRevenueCenters
- Get Revenue Centers
- Method: postPath:
/config/sim/v2/hierarchy/getRevenueCenters
- Update Revenue Centers
- Method: postPath:
/config/sim/v2/hierarchy/updateRevenueCenters
These APIs maintain EMC Modules for a hierarchy node:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Disable EMC Modules
- Method: postPath:
/config/sim/v2/hierarchy/zones/disableEMCModules
- Enable EMC Modules
- Method: postPath:
/config/sim/v2/hierarchy/zones/enableEMCModules
- Get EMC Modules
- Method: postPath:
/config/sim/v2/hierarchy/zones/getEMCModules
These APIs maintain hierarchy nodes of hierType 'Zone':
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add Hierarchy Nodes
- Method: postPath:
/config/sim/v2/hierarchy/zones/nodes
- Delete Hierarchy Nodes
- Method: postPath:
/config/sim/v2/hierarchy/zones/deleteNodes
- Update Hierarchy Nodes
- Method: postPath:
/config/sim/v2/hierarchy/zones/updateNodes
These APIs maintain Zones:
Release | Description |
---|---|
23.5 | Get Zones v2 introduced |
- Get Zones
- Method: postPath:
/config/sim/v2/hierarchy/getZones
These APIs maintain Zones2:
Release | Description |
---|---|
23.6 | Get Zones2 introduced |
- Get Zones2
- Method: postPath:
/config/sim/v2/hierarchy/getZones2
These APIs maintain Barcodes:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Barcodes
- Method: postPath:
/config/sim/v2/menuItems/barcodes
- Bulk Insert Barcodes
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertBarcodes
- Bulk Update Barcodes
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateBarcodes
- Delete Barcodes
- Method: postPath:
/config/sim/v2/menuItems/deleteBarcodes
- Get Barcodes
- Method: postPath:
/config/sim/v2/menuItems/getBarcodes
- Update Barcodes
- Method: postPath:
/config/sim/v2/menuItems/updateBarcodes
These APIs maintain the prices of side groups in combo meals for a specified organization:
Release | Description |
---|---|
23.5 | Combo Meal Side Group Prices v2 introduced. |
- Add Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/mealSideGroupPrices
- Delete Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/deleteMealSideGroupPrices
- Get Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/getMealSideGroupPrices
- Update Combo Meal Side Group Prices
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/updateMealSideGroupPrices
These APIs maintain Combo Meal Side Groups:
Release | Description |
---|---|
23.5 | Combo Meal Side Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Combo Meal Side Groups
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/mealSideGroups
- Delete Combo Meal Side Groups
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/deleteMealSideGroups
- Get Combo Meal Side Groups
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/getMealSideGroups
- Update Combo Meal Side Groups
- Method: postPath:
/config/sim/v2/menuItems/comboMeals/updateMealSideGroups
These APIs maintain Combo Meals:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/comboMeals
- Bulk Insert Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertComboMeals
- Bulk Update Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateComboMeals
- Delete Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/deleteComboMeals
- Get Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/getComboMeals
- Pre-Delete Check Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/preDeleteCheckComboMeals
- Update Combo Meals
- Method: postPath:
/config/sim/v2/menuItems/updateComboMeals
These APIs maintain Combo Meal Side Groups:
Release | Description |
---|---|
23.5 |
|
23.6 |
|
- Add Combo Side Group Items
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/sideGroupItems
- Bulk Insert Combo Side Group Items
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/bulkInsertSideGroupItems
- Bulk Update Combo Side Group Items
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/bulkUpdateSideGroupItems
- Delete Combo Side Group Items
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/deleteSideGroupItems
- Get Combo Side Group Items
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/getSideGroupItems
- Update Combo Side Group Items
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/updateSideGroupItems
These APIs maintain Combo Side Group Item Prices:
Release | Description |
---|---|
23.5 |
|
23.6 |
|
- Add Combo Side Group Item Prices
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/sideGroupItemPrices
- Bulk Insert Combo Side Group Item Prices
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/bulkInsertSideGroupItemsPrices
- Bulk Update Combo Side Group Item Prices
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/bulkUpdateSideGroupItemsPrices
- Delete Combo Side Group Item Prices
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/deleteSideGroupItemPrices
- Get Combo Side Group Item Prices
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/getSideGroupItemPrices
- Update Combo Side Group Item Prices
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups/updateSideGroupItemPrices
These APIs maintain Combo Meal Side Groups:
Release | Description |
---|---|
23.5 |
|
23.6 |
|
- Add Combo Side Groups
- Method: postPath:
/config/sim/v2/menuItems/comboSideGroups
- Bulk Insert Combo Side Groups
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertComboSideGroups
- Bulk Update Combo Side Groups
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateComboSideGroups
- Delete Combo Side Groups
- Method: postPath:
/config/sim/v2/menuItems/deleteComboSideGroups
- Get Combo Side Groups
- Method: postPath:
/config/sim/v2/menuItems/getComboSideGroups
- Update Combo Side Groups
- Method: postPath:
/config/sim/v2/menuItems/updateComboSideGroups
These APIs maintain Condiment Groups:
Release | Description |
---|---|
23.5 | Condiment Groups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Condiment Groups
- Method: postPath:
/config/sim/v2/menuItems/condimentGroups
- Delete Condiment Groups
- Method: postPath:
/config/sim/v2/menuItems/deleteCondimentGroups
- Get Condiment Groups
- Method: postPath:
/config/sim/v2/menuItems/getCondimentGroups
- Update Condiment Groups
- Method: postPath:
/config/sim/v2/menuItems/updateCondimentGroups
These APIs maintain Condiment Sets:
Release | Description |
---|---|
23.5 | Condiment Sets v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Condiment Sets
- Method: postPath:
/config/sim/v2/menuItems/condimentSets
- Delete Condiment Sets
- Method: postPath:
/config/sim/v2/menuItems/deleteCondimentSets
- Get Condiment Sets
- Method: postPath:
/config/sim/v2/menuItems/getCondimentSets
- Update Condiment Sets
- Method: postPath:
/config/sim/v2/menuItems/updateCondimentSets
These APIs maintain Condiment Set Items:
Release | Description |
---|---|
23.5 | Condiment Set Items v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Condiment Set Items
- Method: postPath:
/config/sim/v2/menuItems/condimentSets/items
- Delete Condiment Set Items
- Method: postPath:
/config/sim/v2/menuItems/condimentSets/deleteItems
- Get Condiment Set Items
- Method: postPath:
/config/sim/v2/menuItems/condimentSets/getItems
- Update Condiment Set Items
- Method: postPath:
/config/sim/v2/menuItems/condimentSets/updateItems
These APIs maintain Family Group Consumer Facing Content:
Release | Description |
---|---|
23.5 | Family Group Consumer Facing Content v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/familyGroups/consumerContent
- Delete Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/familyGroups/deleteConsumerContent
- Download Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/familyGroups/downloadConsumerContent
- Get Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/familyGroups/getConsumerContent
- Update Family Group Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/familyGroups/updateConsumerContent
These APIs maintain Family Groups:
Release | Description |
---|---|
23.5 | Family Groups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Family Groups
- Method: postPath:
/config/sim/v2/menuItems/familyGroups
- Delete Family Groups
- Method: postPath:
/config/sim/v2/menuItems/deleteFamilyGroups
- Get Family Groups
- Method: postPath:
/config/sim/v2/menuItems/getFamilyGroups
- Update Family Groups
- Method: postPath:
/config/sim/v2/menuItems/updateFamilyGroups
These APIs maintain Major Groups:
Release | Description |
---|---|
23.5 | Major Groups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Major Groups
- Method: postPath:
/config/sim/v2/menuItems/majorGroups
- Delete Major Groups
- Method: postPath:
/config/sim/v2/menuItems/deleteMajorGroups
- Get Major Groups
- Method: postPath:
/config/sim/v2/menuItems/getMajorGroups
- Update Major Groups
- Method: postPath:
/config/sim/v2/menuItems/updateMajorGroups
These APIs maintain Menu Items:
Release | Description |
---|---|
23.5 | Get Menu Items 2 v2 introduced |
- Get Menu Items 2
- Method: postPath:
/config/sim/v2/menuItems/getMenuItem2
These APIs maintain Menu Item Classes:
Release | Description |
---|---|
23.5 | Menu Item Classes v2 introduced |
23.5.0.2 | Starting from API release 23.5.0.2, it is recommended to use Menu Item Classes 2 instead of Menu Item Class. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Classes
- Method: postPath:
/config/sim/v2/menuItems/menuItemClasses
- Delete Menu Item Classes
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemClasses
- Get Menu Item Classes
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemClasses
- Update Menu Item Classes
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemClasses
These APIs maintain Menu Item Classes 2:
Release | Description |
---|---|
23.5.0.2 | First introduced in this version |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Classes 2
- Method: postPath:
/config/sim/v2/menuItems/menuItemClasses2
- Delete Menu Item Classes 2
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemClasses2
- Get Menu Item Classes 2
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemClasses2
- Update Menu Item Classes 2
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemClasses2
These APIs maintain Menu Item Definition Consumer Facing Content:
Release | Description |
---|---|
23.5 | Menu Item Defintion Consumer Facing Content v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/menuItemDefinition/consumerContent
- Delete Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/menuItemDefinition/deleteConsumerContent
- Download Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/menuItemDefinition/downloadConsumerContent
- Get Menu Item Defintion Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/menuItemDefinition/getConsumerContent
- Update Menu Item Definition Consumer Facing Content
- Method: postPath:
/content/sim/v2/menuItems/menuItemDefinition/updateConsumerContent
These APIs maintain the default condiments for a given menu item definition:
Release | Description |
---|---|
23.5 | Menu Item Definition Default Condiments v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Delete Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v2/menuItems/menuItemDefinition/deleteDefaultCondiments
- Get Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v2/menuItems/menuItemDefinition/getDefaultCondiments
- Insert Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v2/menuItems/menuItemDefinition/defaultCondiments
- Update Menu Item Definition Default Condiments
- Method: postPath:
/config/sim/v2/menuItems/menuItemDefinition/updateDefaultCondiments
These APIs maintain Menu Item Definitions:
Release | Description |
---|---|
23.5 |
|
- Add Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/menuItemDefinitions
- Bulk Insert Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertMenuItemDefinitions
- Bulk Update Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateMenuItemDefinitions
- Delete Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemDefinitions
- Get Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemDefinitions
- Pre-Delete Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/preDeleteCheckMenuItemDefinitions
- Update Menu Item Definitions
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemDefinitions
These APIs maintain Menu Item Group Details:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Group Details
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups/details
- Bulk Insert Menu Item Group Details
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups/bulkInsertDetails
- Bulk Update Menu Item Group Details
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups/bulkUpdateDetails
- Delete Menu Item Group Deatils
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups/deleteDetails
- Get Menu Item Group Details
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups/getDetails
- Update Menu Item Group Details
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups/updateDetails
These APIs maintain Menu Item Groups:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Groups
- Method: postPath:
/config/sim/v2/menuItems/menuItemGroups
- Bulk Insert Menu Item Groups
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertMenuItemGroups
- Bulk Update Menu Item Groups
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateMenuItemGroups
- Delete Menu Item Groups
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemGroups
- Get Menu Item Groups
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemGroups
- Update Menu Item Groups
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemGroups
These APIs maintain Menu Item Masters:
Release | Description |
---|---|
23.5 |
|
23.6 |
|
- Add Menu Item Masters
- Method: postPath:
/config/sim/v2/menuItems/menuItemMasters
- Bulk Insert Menu Item Master
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertMenuItemMasters
- Bulk Update Menu Item Master
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateMenuItemMasters
- Delete Menu Item Masters
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemMasters
- Get Menu Item Masters
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemMasters
- Pre-Delete Check Menu Item Masters
- Method: postPath:
/config/sim/v2/menuItems/preDeleteCheckMenuItemMasters
- Update Menu Item Masters
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemMasters
These APIs maintain Menu Item Effectivity Groups:
Release | Description |
---|---|
23.5 | Menu Item Master Effectivity Groups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Master Effectivty Group
- Method: postPath:
/config/sim/v2/menuItems/menuItemMasterEffectivity
- Delete Menu Item Master Effectivity Group
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemMasterEffectivity
- Get Menu Item Master Effectivity Groups
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemMasterEffectivity
- Update Menu Item Master Effectivity Group
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemMasterEffectivity
These APIs maintain Menu Item Master Groups:
Release | Description |
---|---|
23.5 | Menu Item Master Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Master Groups
- Method: postPath:
/config/sim/v2/menuItems/menuItemMasterGroups
- Delete Menu Item Master Groups
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemMasterGroups
- Get Menu Item Master Groups
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemMasterGroups
- Update Menu Item Master Groups
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemMasterGroups
These APIs maintain Menu Item Prices:
Release | Description | 23.5 |
|
---|---|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Item Prices
- Method: postPath:
/config/sim/v2/menuItems/menuItemPrices
- Bulk Insert Menu Item Prices
- Method: postPath:
/config/sim/v2/menuItems/bulkInsertMenuItemPrices
- Bulk Update Menu Item Prices
- Method: postPath:
/config/sim/v2/menuItems/bulkUpdateMenuItemPrices
- Delete Menu Item Prices
- Method: postPath:
/config/sim/v2/menuItems/deleteMenuItemPrices
- Get Menu Item Prices
- Method: postPath:
/config/sim/v2/menuItems/getMenuItemPrices
- Update Menu Item Prices
- Method: postPath:
/config/sim/v2/menuItems/updateMenuItemPrices
This API returns available object numbers:
Release | Description |
---|---|
23.5 | Get Available Object Numbers v2 introduced. |
- Get Available Object Numbers
- Method: postPath:
/config/sim/v2/getAvailableObjectNumbers
Use this API to obtain bulk processing request status updates.
Release | Description |
---|---|
23.5 | Bulk Status Request v2 introduced. |
- Gets the status of a bulk processing request
- Method: postPath:
/config/sim/v2/bulkStatusRequest
This API returns Version Information:
Release | Description |
---|---|
23.5 | Release Versions v2 introduced. |
- Get version information
- Method: postPath:
/config/sim/v2/getReleaseVersions
These APIs maintain Discount Itemizers:
Release | Description |
---|---|
23.5 | Discount Itemizers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Discount Itemizers
- Method: postPath:
/config/sim/v2/sales/discountItemizers
- Delete Discount Itemizers
- Method: postPath:
/config/sim/v2/sales/deleteDiscountItemizers
- Get Discount Itemizers
- Method: postPath:
/config/sim/v2/sales/getDiscountItemizers
- Update Discount Itemizers
- Method: postPath:
/config/sim/v2/sales/updateDiscountItemizers
These APIs maintain Discounts:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Discounts
- Method: postPath:
/config/sim/v2/sales/discounts
- Delete Discounts
- Method: postPath:
/config/sim/v2/sales/deleteDiscounts
- Get Discounts
- Method: postPath:
/config/sim/v2/sales/getDiscounts
- Update Discounts
- Method: postPath:
/config/sim/v2/sales/updateDiscounts
These APIs maintain Discount Award Groups:
Release | Description |
---|---|
23.5 | Discount Award Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Discount Award Groups
- Method: postPath:
/config/sim/v2/sales/discounts/awardGroups
- Delete Discount Award Groups
- Method: postPath:
/config/sim/v2/sales/discounts/deleteAwardGroups
- Get Discount Award Groups
- Method: postPath:
/config/sim/v2/sales/discounts/getAwardGroups
- Update Discount Award Groups
- Method: postPath:
/config/sim/v2/sales/discounts/updateAwardGroups
These APIs maintain Discount Trigger Groups:
Release | Description |
---|---|
23.5 | Discount Trigger Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Discount Trigger Groups
- Method: postPath:
/config/sim/v2/sales/discounts/triggerGroups
- Delete Discount Trigger Groups
- Method: postPath:
/config/sim/v2/sales/discounts/deleteTriggerGroups
- Get Discount Trigger Groups
- Method: postPath:
/config/sim/v2/sales/discounts/getTriggerGroups
- Update Discount Trigger Groups
- Method: postPath:
/config/sim/v2/sales/discounts/updateTriggerGroups
These APIs maintain details of Service Charge Groups:
Release | Description |
---|---|
23.5 | Service Charge Group Details v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Service Charge Group Details
- Method: postPath:
/config/sim/v2/sales/serviceChargeGroups/details
- Delete Service Charge Group Details
- Method: postPath:
/config/sim/v2/sales/serviceChargeGroups/deleteDetails
- Get Service Charge Group Details
- Method: postPath:
/config/sim/v2/sales/serviceChargeGroups/getDetails
- Update Service Charge Group Details
- Method: postPath:
/config/sim/v2/sales/serviceChargeGroups/updateDetails
These APIs maintain Service Charge Groups:
Release | Description |
---|---|
23.5 | Service Charge Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Service Charge Groups
- Method: postPath:
/config/sim/v2/sales/serviceChargeGroups
- Delete Service Charge Groups
- Method: postPath:
/config/sim/v2/sales/deleteServiceChargeGroups
- Get Service Charge Groups
- Method: postPath:
/config/sim/v2/sales/getServiceChargeGroups
- Update Service Charge Groups
- Method: postPath:
/config/sim/v2/sales/updateServiceChargeGroups
These APIs maintain Service Charge Itemizers:
Release | Description |
---|---|
23.5 | Service Charge Itemizers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Service Charge Itemizers
- Method: postPath:
/config/sim/v2/sales/serviceChargeItemizers
- Delete Service Charge Itemizers
- Method: postPath:
/config/sim/v2/sales/deleteServiceChargeItemizers
- Get Service Charge Itemizers
- Method: postPath:
/config/sim/v2/sales/getServiceChargeItemizers
- Update Service Charge Itemizers
- Method: postPath:
/config/sim/v2/sales/updateServiceChargeItemizers
These APIs maintain Service Charges:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Service Charges
- Method: postPath:
/config/sim/v2/sales/serviceCharges
- Delete Service Charges
- Method: postPath:
/config/sim/v2/sales/deleteServiceCharges
- Get Service Charges
- Method: postPath:
/config/sim/v2/sales/getServiceCharges
- Update Service Charges
- Method: postPath:
/config/sim/v2/sales/updateServiceCharges
These APIs maintain Tax Classes:
Release | Description |
---|---|
23.5 | Tax Classes v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Tax Classes
- Method: postPath:
/config/sim/v2/sales/taxClasses
- Delete Tax Classes
- Method: postPath:
/config/sim/v2/sales/deleteTaxClasses
- Get Tax Classes
- Method: postPath:
/config/sim/v2/sales/getTaxClasses
- Update Tax Classes
- Method: postPath:
/config/sim/v2/sales/updateTaxClasses
These APIs maintain Tax Parameters:
Release | Description |
---|---|
23.5 | Tax Parameters v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Tax Parameters
- Method: postPath:
/config/sim/v2/sales/taxParameters
- Delete Tax Parameters
- Method: postPath:
/config/sim/v2/sales/deleteTaxParameters
- Get Tax Parameters
- Method: postPath:
/config/sim/v2/sales/getTaxParameters
- Update Tax Parameters
- Method: postPath:
/config/sim/v2/sales/updateTaxParameters
These APIs maintain breakpoints for a Tax Rate:
Release | Description |
---|---|
23.5 | Tax Breakpoints v2 introduced. |
- Get Tax Breakpoints
- Method: postPath:
/config/sim/v2/sales/getTaxBreakpoints
- Update Tax Breakpoints
- Method: postPath:
/config/sim/v2/sales/updateTaxBreakpoints
These APIs maintain Tax Rates:
Release | Description |
---|---|
23.5 | Get, Add, Update and Delete Tax Rates v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Tax Rates
- Method: postPath:
/config/sim/v2/sales/taxRates
- Delete Tax Rates
- Method: postPath:
/config/sim/v2/sales/deleteTaxRates
- Get Tax Rates
- Method: postPath:
/config/sim/v2/sales/getTaxRates
- Update Tax Rates
- Method: postPath:
/config/sim/v2/sales/updateTaxRates
These APIs maintain Tender Media:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Tender Media
- Method: postPath:
/config/sim/v2/sales/tenderMedia
- Delete Tender Media
- Method: postPath:
/config/sim/v2/sales/deleteTenderMedia
- Get Tender Media
- Method: postPath:
/config/sim/v2/sales/getTenderMedia
- Update Tender Media
- Method: postPath:
/config/sim/v2/sales/updateTenderMedia
These APIs maintain Auto Menu Levels:
Release | Description |
---|---|
23.5 | Auto Menu Levels v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Auto Menu Levels
- Method: postPath:
/config/sim/v2/setup/autoMenuLevels
- Delete Auto Menu Levels
- Method: postPath:
/config/sim/v2/setup/deleteAutoMenuLevels
- Get Auto Menu Levels
- Method: postPath:
/config/sim/v2/setup/getAutoMenuLevels
- Update Auto Menu Levels
- Method: postPath:
/config/sim/v2/setup/updateAutoMenuLevels
These APIs maintain CAL Deployment Schedules:
Release | Description |
---|---|
23.5 | CAL Deployment Schedules v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add CAL Deployment Schedules
- Method: postPath:
/config/sim/v2/setup/cal/deploymentSchedules
- Delete CAL Deployment Schedules
- Method: postPath:
/config/sim/v2/setup/cal/deleteDeploymentSchedules
- Get CAL Deployment Schedules
- Method: postPath:
/config/sim/v2/setup/cal/getDeploymentSchedules
- Update CAL Deployment Schedules
- Method: postPath:
/config/sim/v2/setup/cal/updateDeploymentSchedules
These APIs maintain CAL Packages:
Release | Description |
---|---|
23.5 | Get CAL Packages v2 introduced. |
- Get CAL Packages
- Method: postPath:
/config/sim/v2/setup/cal/getPackages
This API returns CAL Packages Installation Status
Release | Description |
---|---|
23.5 | First release |
- Get Install Status
- Method: postPath:
/config/sim/v2/setup/cal/getInstallStatus
These APIs maintain Cash Management Receptacle Templates:
Release | Description |
---|---|
23.5 | Cash Management Receptacle Templates v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v2/setup/cashManagementReceptacleTemplates
- Delete Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v2/setup/deleteCashManagementReceptacleTemplates
- Get Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v2/setup/getCashManagementReceptacleTemplates
- Update Cash Management Receptacle Templates
- Method: postPath:
/config/sim/v2/setup/updateCashManagementReceptacleTemplates
These APIs maintain Currencies:
Release | Description |
---|---|
23.5 | Currencies v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Currencies
- Method: postPath:
/config/sim/v2/setup/currencies
- Delete Currencies
- Method: postPath:
/config/sim/v2/setup/deleteCurrencies
- Get Currencies
- Method: postPath:
/config/sim/v2/setup/getCurrencies
- Update Currencies
- Method: postPath:
/config/sim/v2/setup/updateCurrencies
These APIs maintain Currency Availability:
Release | Description |
---|---|
23.5 | Currency Availability v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Currency Availability
- Method: postPath:
/config/sim/v2/setup/currencyAvailability
- Delete Currency Availability
- Method: postPath:
/config/sim/v2/setup/deleteCurrencyAvailability
- Get Currency Availability
- Method: postPath:
/config/sim/v2/setup/getCurrencyAvailability
- Update Currency Availability
- Method: postPath:
/config/sim/v2/setup/updateCurrencyAvailability
These APIs maintain Currency Conversions:
Release | Description |
---|---|
23.5 | Currency Conversions v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Currency Conversion.
- Method: postPath:
/config/sim/v2/setup/currencyConversion
- Delete currency conversion.
- Method: postPath:
/config/sim/v2/setup/deleteCurrencyConversion
- Get currency conversions.
- Method: postPath:
/config/sim/v2/setup/getCurrencyConversion
- Update currency conversion.
- Method: postPath:
/config/sim/v2/setup/updateCurrencyConversion
These APIs maintain Currency Parameters:
Release | Description |
---|---|
23.5 | Currency Parameters v2 introduced. |
23.6 |
|
- Add Currency Parameters
- Method: postPath:
/config/sim/v2/setup/currencyParameters
- Delete Currency Parameters
- Method: postPath:
/config/sim/v2/setup/deleteCurrencyParameters
- Get Currency Parameters
- Method: postPath:
/config/sim/v2/setup/getCurrencyParameters
- Update Currency Parameters
- Method: postPath:
/config/sim/v2/setup/updateCurrencyParameters
These APIs maintain Custom Content:
Release | Description |
---|---|
23.5 | Custom Content v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Custom Content
- Method: postPath:
/content/sim/v2/setup/customContent
- Delete Custom Content
- Method: postPath:
/content/sim/v2/setup/deleteCustomContent
- Download Custom Content.
- Method: postPath:
/content/sim/v2/setup/downloadCustomContent
- Get Custom Content
- Method: postPath:
/content/sim/v2/setup/getCustomContent
- Update Custom Content
- Method: postPath:
/content/sim/v2/setup/updateCustomContent
These APIs maintain Data Extensions:
Release | Description |
---|---|
23.5 | Data Extensions v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Data Extensions
- Method: postPath:
/config/sim/v2/setup/dataExtensions
- Delete Data Extensions
- Method: postPath:
/config/sim/v2/setup/deleteDataExtensions
- Get Data Extensions
- Method: postPath:
/config/sim/v2/setup/getDataExtensions
- Update Data Extensions
- Method: postPath:
/config/sim/v2/setup/updateDataExtensions
These APIs maintain Dining Tables:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add Dining Tables
- Method: postPath:
/config/sim/v2/setup/diningTables
- Delete Dining Tables
- Method: postPath:
/config/sim/v2/setup/deleteDiningTables
- Get Dining Tables
- Method: postPath:
/config/sim/v2/setup/getDiningTables
- Update Dining Tables
- Method: postPath:
/config/sim/v2/setup/updateDiningTables
These APIs maintain Effectivity Groups:
Release | Description |
---|---|
23.5 | Effectivity Groups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Effectivity Groups
- Method: postPath:
/config/sim/v2/setup/effectivityGroups
- Delete Effectivity Groups
- Method: postPath:
/config/sim/v2/setup/deleteEffectivityGroups
- Get Effectivity Groups
- Method: postPath:
/config/sim/v2/setup/getEffectivityGroups
- Update Effectivity Groups
- Method: postPath:
/config/sim/v2/setup/updateEffectivityGroups
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.5 | Enable Effectivity Groups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Enable Effectivity Groups
- Method: postPath:
/config/sim/v2/setup/effectivityGroups/enableEffectivityGroups
- Delete Enable Effectivity Groups.
- Method: postPath:
/config/sim/v2/setup/effectivityGroups/deleteEnableEffectivityGroups
- Get Enable Effectivity Groups.
- Method: postPath:
/config/sim/v2/setup/effectivityGroups/getEnableEffectivityGroups
- Update Enable Effectivity Groups
- Method: postPath:
/config/sim/v2/setup/effectivityGroups/updateEnableEffectivityGroups
These APIs maintain Headers and Trailers:
Release | Description |
---|---|
23.5 | Headers/Trailers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Headers/Trailers
- Method: postPath:
/config/sim/v2/setup/headersTrailers
- Delete Header/Trailer
- Method: postPath:
/config/sim/v2/setup/deleteHeadersTrailers
- Get Headers/Trailers
- Method: postPath:
/config/sim/v2/setup/getHeadersTrailers
- Update Headers/Trailers
- Method: postPath:
/config/sim/v2/setup/updateHeadersTrailers
These APIs maintain headers trailers by channel type:
Release | Description |
---|---|
23.6 | First introduced in this version. These endpoints are available from Simphony 19.8 and above. |
- Add Headers Trailers By Channel Type
- Method: postPath:
/config/sim/v2/setup/headersTrailersByChannelType
- Delete Headers Trailers By Channel Type
- Method: postPath:
/config/sim/v2/setup/deleteHeadersTrailersByChannelType
- Get Headers Trailers By Channel Type
- Method: postPath:
/config/sim/v2/setup/getHeadersTrailersByChannelType
- Update Headers Trailers By Channel Type
- Method: postPath:
/config/sim/v2/setup/updateHeadersTrailersByChannelType
These APIs maintain Languages:
Release | Description |
---|---|
23.5 | Languages v2 introduced |
23.6 |
|
- Add Languages
- Method: postPath:
/config/sim/v2/setup/languages
- Delete Languages
- Method: postPath:
/config/sim/v2/setup/deleteLanguages
- Get Languages
- Method: postPath:
/config/sim/v2/setup/getLanguages
- Update Languages
- Method: postPath:
/config/sim/v2/setup/updateLanguages
These APIs maintain Text File Configurations
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add Text File Configurations
- Method: postPath:
/content/sim/v2/setup/languages/textFileConfigurations
- Delete Text File Configuration
- Method: postPath:
/content/sim/v2/setup/languages/deleteTextFileConfigurations
- Download Text File Configuration
- Method: postPath:
/content/sim/v2/setup/languages/downloadTextFileConfigurations
- Get Text File Configurations
- Method: postPath:
/content/sim/v2/setup/languages/getTextFileConfigurations
- Update Text File Configurations
- Method: postPath:
/content/sim/v2/setup/languages/updateTextFileConfigurations
These APIs maintain Locales:
Release | Description |
---|---|
23.5 | Locales v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Locales
- Method: postPath:
/config/sim/v2/setup/locales
- Delete locales
- Method: postPath:
/config/sim/v2/setup/deleteLocales
- Get Locales
- Method: postPath:
/config/sim/v2/setup/getLocales
- Update Locales
- Method: postPath:
/config/sim/v2/setup/updateLocales
These APIs maintain Menu Level Entries for a Menu Level Set:
Release | Description |
---|---|
23.5 | Menu Level Entries v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Level Entries
- Method: postPath:
/config/sim/v2/setup/menuLevels/menuLevelEntries
- Delete Menu Level Entries
- Method: postPath:
/config/sim/v2/setup/menuLevels/deleteMenuLevelEntries
- Get Menu Level Entries
- Method: postPath:
/config/sim/v2/setup/menuLevels/getMenuLevelEntries
- Update Menu Level Entries
- Method: postPath:
/config/sim/v2/setup/menuLevels/updateMenuLevelEntries
These APIs maintain Menu Levels
Release | Description |
---|---|
23.5 | Menu Levels v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Menu Levels
- Method: postPath:
/config/sim/v2/setup/menuLevels
- Delete Menu Levels
- Method: postPath:
/config/sim/v2/setup/deleteMenuLevels
- Get Menu Levels
- Method: postPath:
/config/sim/v2/setup/getMenuLevels
- Update Menu Levels
- Method: postPath:
/config/sim/v2/setup/updateMenuLevels
These APIs maintain Order Channel parameters.
Release | Description |
---|---|
23.5 | Order Channel Parameters v2 introduced. |
23.6 |
|
- Add Order Channel Parameters
- Method: postPath:
/config/sim/v2/setup/orderChannelParameters
- Delete Order Channel Parameters
- Method: postPath:
/config/sim/v2/setup/deleteOrderChannelParameters
- Get Order Channel Parameters
- Method: postPath:
/config/sim/v2/setup/getOrderChannelParameters
- Update Order Channel Parameters
- Method: postPath:
/config/sim/v2/setup/updateOrderChannelParameters
These APIs maintain Order Channels.
Release | Description |
---|---|
23.5 | Order Channels v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Order Channels
- Method: postPath:
/config/sim/v2/setup/orderChannels
- Get Order Channels
- Method: postPath:
/config/sim/v2/setup/getOrderChannels
- Update Order Channels
- Method: postPath:
/config/sim/v2/setup/updateOrderChannels
These APIs maintain Order Types:
Release | Description |
---|---|
23.5 |
|
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Order Types
- Method: postPath:
/config/sim/v2/setup/orderTypeNames
- Delete Order Types
- Method: postPath:
/config/sim/v2/setup/deleteOrderTypeNames
- Get Order Types
- Method: postPath:
/config/sim/v2/setup/getOrderTypeNames
- Update Order Types
- Method: postPath:
/config/sim/v2/setup/updateOrderTypeNames
These APIs maintain Order Type Parameters:
Release | Description |
---|---|
23.5 | Order Types Parameters v2 introduced. |
23.6 |
|
- Add Order Type Parameters
- Method: postPath:
/config/sim/v2/setup/orderTypeParameters
- Delete Order Type Parameters
- Method: postPath:
/config/sim/v2/setup/deleteOrdertypeParameters
- Get Order Types Parameters
- Method: postPath:
/config/sim/v2/setup/getOrderTypeParameters
- Update Order Type Parameters
- Method: postPath:
/config/sim/v2/setup/updateOrdertypeParameters
These APIs maintain Payment Driver Configurations:
Release | Description |
---|---|
23.5 | Payment Driver Configuration v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Get Payment Driver Configuration
- Method: postPath:
/config/sim/v2/setup/getPaymentDriverConfiguration
- Update Payment Driver Configuration
- Method: postPath:
/config/sim/v2/setup/updatePaymentDriverConfiguration
These APIs maintain Payment Drivers:
Release | Description |
---|---|
23.5 | Payment Drivers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Payment Drivers
- Method: postPath:
/content/sim/v2/setup/paymentDrivers
- Delete Payment Drivers
- Method: postPath:
/content/sim/v2/setup/deletePaymentDrivers
- Download Payment Drivers
- Method: postPath:
/content/sim/v2/setup/downloadPaymentDrivers
- Get Payment Drivers
- Method: postPath:
/content/sim/v2/setup/getPaymentDrivers
- Update Payment Drivers
- Method: postPath:
/content/sim/v2/setup/updatePaymentDrivers
These APIs maintain Print Logos:
Release | Description |
---|---|
23.5 | Print Logos v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Print Logos
- Method: postPath:
/content/sim/v2/setup/printLogos
- Delete Print Logos
- Method: postPath:
/content/sim/v2/setup/deletePrintLogos
- Download Print Logos
- Method: postPath:
/content/sim/v2/setup/downloadPrintLogos
- Get Print Logos
- Method: postPath:
/content/sim/v2/setup/getPrintLogos
- Update Print Logos
- Method: postPath:
/content/sim/v2/setup/updatePrintLogos
These APIs maintain Reason Codes:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add Reason Codes
- Method: postPath:
/config/sim/v2/setup/reasonCodes
- Delete Reason Codes
- Method: postPath:
/config/sim/v2/setup/deleteReasonCodes
- Get Reason Codes
- Method: postPath:
/config/sim/v2/setup/getReasonCodes
- Update Reason Codes
- Method: postPath:
/config/sim/v2/setup/updateReasonCodes
These APIs maintain Report Groups:
Release | Description |
---|---|
23.5 | Report Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Report Groups
- Method: postPath:
/config/sim/v2/setup/reportGroups
- Delete Report Groups
- Method: postPath:
/config/sim/v2/setup/deleteReportGroups
- Get Report Groups
- Method: postPath:
/config/sim/v2/setup/getReportGroups
- Update Report Groups
- Method: postPath:
/config/sim/v2/setup/updateReportGroups
These APIs maintain Sales Itemizers:
Release | Description |
---|---|
23.5 | Sales Itemizers v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Sales Itemizers
- Method: postPath:
/config/sim/v2/setup/salesItemizers
- Delete Sales Itemizers
- Method: postPath:
/config/sim/v2/setup/deleteSalesItemizers
- Get Sales Itemizers
- Method: postPath:
/config/sim/v2/setup/getSalesItemizers
- Update Sales Itemizers
- Method: postPath:
/config/sim/v2/setup/updateSalesItemizers
These APIs maintain SLU Consumer Facing Content:
Release | Description |
---|---|
23.5 | SLU Consumer Facing Content v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add SLU Consumer Facing Content
- Method: postPath:
/content/sim/v2/setup/screenLookups/consumerContent
- Delete SLU Consumer Facing Content
- Method: postPath:
/content/sim/v2/setup/screenLookups/deleteConsumerContent
- Download SLU Consumer Facing Content
- Method: postPath:
/content/sim/v2/setup/screenLookups/downloadConsumerContent
- Get SLU Consumer Facing Content
- Method: postPath:
/content/sim/v2/setup/screenLookups/getConsumerContent
- Update SLU Consumer Facing Content
- Method: postPath:
/content/sim/v2/setup/screenLookups/updateConsumerContent
These APIs maintain Screen Look Ups:
Release | Description |
---|---|
23.5 | Screen Look Ups v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Screen Look Ups
- Method: postPath:
/config/sim/v2/setup/screenLookups
- Delete Screen Look Ups
- Method: postPath:
/config/sim/v2/setup/deleteScreenLookups
- Get Screen Look Ups
- Method: postPath:
/config/sim/v2/setup/getScreenLookups
- Update Screen Look Ups
- Method: postPath:
/config/sim/v2/setup/updateScreenLookups
These APIs maintain serving periods:
Release | Description |
---|---|
23.6 | First introduced in this version. |
- Add Serving Periods
- Method: postPath:
/config/sim/v2/setup/servingPeriods
- Delete Serving Periods
- Method: postPath:
/config/sim/v2/setup/deleteServingPeriods
- Get Serving Periods
- Method: postPath:
/config/sim/v2/setup/getServingPeriods
- Update Serving Periods
- Method: postPath:
/config/sim/v2/setup/updateServingPeriods
These APIs maintain Tag Groups:
Release | Description |
---|---|
23.5 | Tag Groups v2 introduced. |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Tag Groups
- Method: postPath:
/config/sim/v2/setup/tagGroups
- Delete Tag Groups
- Method: postPath:
/config/sim/v2/setup/deleteTagGroups
- Get Tag Groups
- Method: postPath:
/config/sim/v2/setup/getTagGroups
- Update Tag Groups
- Method: postPath:
/config/sim/v2/setup/updateTagGroups
These APIs maintain Tags:
Release | Description |
---|---|
23.5 | Tags v2 introduced |
23.6 | Update endpoint will only update an existing record and will not insert a new record. |
- Add Tags
- Method: postPath:
/config/sim/v2/setup/tags
- Delete Tags
- Method: postPath:
/config/sim/v2/setup/deleteTags
- Get Tags
- Method: postPath:
/config/sim/v2/setup/getTags
- Update Tags
- Method: postPath:
/config/sim/v2/setup/updateTags