All REST Endpoints
These APIs maintain Kitchen Display Clients
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Kitchen Display Clients
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Kitchen Display Controllers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Order Devices
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Print Classes
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Printers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Workstation Classes
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Workstation Devices
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add SPI client certificate
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add SPI Server Certificate
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Workstations
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | This endpoint was added in the API version 23.3.1 |
- Add Cashiers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | This endpoint was added in the API version 23.3.1 |
- Get Employee Class Operators
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Employee Classes
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Employee EMC Visibility
- Method: 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/updateEmployeeVisibility
These APIs maintain the job codes at the property assigned to the employee:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Employee Job Codes
- Method: postPath:
/config/sim/v1/employees/properties/getJobCodes
These APIs maintain the properties assigned to the employee:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Employee Properties
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Employee Property Operator
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Employee Roles
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Employee
- Method: 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
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | First introduced in this version. |
- Add basic employees
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Roles
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Hierarchies
- Method: postPath:
/config/sim/v1/hierarchy/getHierarchy
These APIs maintain Location Parameters:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Location Parameters
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1.3 | Starting with the API release 23.3.1.3, the Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above. |
- Add Locations
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1.3 | First introduced in this version. The Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above. |
- Get Enterprise Levels
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1.3 | First introduced in this version. The Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above. |
- Delete Reporting Hierarchy Relationships
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Revenue Center Parameters
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/revenueCenters
- Checks the existence of references to the object in the database.
- Method: postPath:
/config/sim/v1/hierarchy/preDeleteCheckRevenueCenters
- Delete Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/deleteRevenueCenters
- Get Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/getRevenueCenters
- Update Revenue Centers
- Method: postPath:
/config/sim/v1/hierarchy/updateRevenueCenters
These APIs maintain Zones:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Zones
- Method: postPath:
/config/sim/v1/hierarchy/getZones
These APIs maintain Barcodes:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Barcodes
- Method: postPath:
/config/sim/v1/menuItems/barcodes
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Combo Meal Side Group Prices
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Combo Meal Side Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Combo Meals
- Method: postPath:
/config/sim/v1/menuitems/combomeals
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Combo Side Group Items
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups/sidegroupitems
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Combo Side Group Item Prices
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Combo Side Groups
- Method: postPath:
/config/sim/v1/menuItems/combosidegroups
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Condiment Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Condiment Sets
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Condiment Set Items
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Family Group Consumer Facing Content
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Family Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Major Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Menu Items 2
- Method: postPath:
/config/sim/v1/menuItems/getMenuItem2
These APIs maintain Menu Item Classes:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Classes
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Definition Consumer Facing Content
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Delete Menu Item Definition Default Condiments
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Definitions
- Method: postPath:
/config/sim/v1/menuItems/menuItemDefinitions
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Group Details
- Method: postPath:
/config/sim/v1/menuItems/menuItemGroups/details
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Groups
- Method: postPath:
/config/sim/v1/menuItems/menuItemGroups
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Masters
- Method: postPath:
/config/sim/v1/menuItems/menuItemMasters
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | First introduced in this version. |
- Add Menu Item Master Effectivty Group
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Master Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Item Prices
- Method: postPath:
/config/sim/v1/menuItems/menuItemPrices
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Menu Items
- Method: postPath:
/config/sim/v1/menuitems/getMenuItems
This API returns available object numbers:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | First introduced in this version. |
- Get Available Object Numbers
- Method: postPath:
/config/sim/v1/getAvailableObjectNumbers
These APIs clone configuration data from one organization to another.
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Create Clone
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get version information
- Method: postPath:
/config/sim/v1/getReleaseVersions
These APIs maintain Discount Itemizers:
Release | Description |
---|---|
23.3 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Discount Itemizers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Discounts
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Discount Award Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Discount Trigger Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Service Charge Group Details
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Service Charge Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Service Charge Itemizers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Service Charges
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Tax Classes
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Tax Parameters
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Tax Breakpoints
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Tax Rates
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Tender Media
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Auto Menu Levels
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add CAL Deployment Schedules
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get CAL Packages
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Cash Management Receptacle Templates
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Currencies
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Currency Availability
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Currency Conversion.
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Currency Parameters
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Custom Content
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Data Extensions
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Effectivity Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | First introduced in this version. |
- Add Enable Effectivity Groups.
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Headers/Trailers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Languages
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Locales
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Level Entries
- Method: postPath:
/config/sim/v1/setup/menulevels/menuLeveleEtries
- 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Menu Levels
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | First introduced in this version. |
- Add Order Channel Parameters
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
23.3.1 | First introduced in this version. |
- Add Order Channels
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Order Types
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Order Type Parameters
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Get Payment Driver Configuration
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Payment Drivers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Print Logos
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Report Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Sales Itemizers
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add SLU Consumer Facing Content
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Screen Look Ups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Tag Groups
- Method: 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 | Starting with the API release 23.3, the Simphony-OrgShortName parameter will be ignored. The API will use the authentication token to determine which organization the API account has access to. |
- Add Tags
- Method: 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