Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.2 | To enhance the user experience, we have improved the Retail Management UI to allow tenants to manage their location and client parameters. With this upgrade, tenants can now configure their regional, tenant-specific data using an intuitive user interface. To support these changes, the following endpoints have been updated with optional response parameters: - GET /api/v1/businessunits/{externalId}/parameters - The response field requiredLocationParameters.rules has been updated from an object to an array of objects. New optional response fields (as arrays of objects) have been added: requiredLocationParameters.properties and requiredLocationParameters.options. - GET /api/v1/locations/{externalId}/clients/{clientId}/parameters - The following response fields have been modified from objects to arrays of objects: requiredLocationParameters.rules and requiredClientParameters.rules. The following optional response fields (as arrays of objects) have been added: requiredLocationParameters.properties, requiredLocationParameters.options, requiredClientParameters.properties and requiredClientParameters.options. The following endpoints have been updated to change both the request and response payloads into arrays of objects. - POST /api/v1/businessunits/parameters - POST /api/v1/clients/parameters. The changes described here are classified as breaking changes. However, implementing these changes will have no impact since the endpoints are currently unused. Therefore, these changes should not be considered breaking changes. | v1 |
| 2026.2 | To enhance the management of fiscal devices, we have updated the following endpoint to include a new property: - PUT /api/v1/devices/{deviceId}/deregister We have added a new property to the DeregisterDeviceRequest: ForceSoftwareDeregistration (type: Boolean) - This property indicates whether the deregistration process should be performed at the tenant service level if the hardware-level deregistration fails. | v1 |
| 2026.2 | To improve the functionality, a couple of request query parameters are changed from required to optional for the following endpoints: - GET /api/v1/clients/parameters - GET /api/v1/devices The following parameters are changed from required to optional: pageNumber and pageSize. | v1 |
| 2026.2 | For an improved implementation of fiscal device management, we introduced the following new cloud-only endpoint: - PUT /api/v1/devices/{deviceId}/initialize - The hardware is successfully initialized, but the POS (client) is not yet registered on the device. The following endpoints was renamed: - PUT /api/v1/devices/{deviceId}/deactivate is now PUT /api/v1/devices/ {deviceId}/deinitialize We introduced a new "state" property in the following endpoint : - GET /api/v1/locations/{externalId}/devices/{deviceId} - . We introduced new fields, clientIds, Enabled in the POST /api/v1/devices and PUT /api/v1/devices/{deviceId} endpoints. Additionally, serialNumber is moved to parameters. We extended the response fields with supportedDeviceTypes array in the following endpoint. - GET /api/v1/businessunits/{externalId}/parameters | v1 |
| 2026.2 | For the implementation and enhancement of fiscal device management, which ensures seamless integration of different fiscal devices into CPaaS, we introduced the following cloud-only endpoints: - POST /api/v1/devices - enables the POS system to register new devices. - PUT /api/v1/devices/{deviceId} - enables the POS system to update devices. - GET /api/v1/devices - enables the POS system to retrieve a paged list of devices. - PUT /api/v1/devices/{deviceId}/register - enables the POS system to register device with a user. - PUT /api/v1/devices/{deviceId}/deregister - enables the POS system to deregister device from a user. - PUT /api/v1/devices/{deviceId}/activate - marks the device as active and ready for work. - PUT /api/v1/devices/{deviceId}/deactivate - marks the device as deactive and no longer ready for work. - GET /api/v1/locations/{externalId}/devices/{deviceId} - enables a POS system to retrieve devices associated with a location. | v1 |
| 2026.2 | To improve the compatibility between CPaaS and VRx, we introduced a new field gln in the response of GET /api/v1/businessunits/{externalId}/parameters endpoint. gln or Global Location Number is a reference to a unique ID of the newly created Business Unit in an external system. | v1 |
| 2026.2 | To support managing region and tenant specific data we exposed the CPaaS Tenant API. To enable the POS system to define values for a particular Business Unit parameters we introduced the following endpoints: - POST /api/v1/businessunits/parameters - enables the POS system to register a new business unit parameter. - DELETE /api/v1/businessunits/{externalId}/parameters/{key} - enables the POS system to remove a specific business unit parameter. - GET /api/v1/businessunits/{externalId}/parameters - enables the POS system to retrieve all business unit parameters associated with a specific business unit. - GET /api/v1/businessunits/parameters - enables the POS system to get a paged list of business unit parameters, and to filter the business unit parameters list by providing a key-value. To support handling a particular Client Parameters we introduced the following endpoints: - POST /api/v1/clients/parameters - enables the POS system to register a new client parameter. - DELETE /api/v1/locations/{externalId}/clients/{clientId}/parameters/{key} - enables the POS system to delete a specific client parameter - GET /api/v1/locations/{externalId}/clients/{clientId}/parameters - enables the POS system to retrieve all business unit and client parameters associated with a specific client. - GET /api/v1/clients/parameters - enables the POS system to retrieve a paged list of client parameters. , - GET /api/v1/healthcheck - enables service level health check. It allows the API client to check the status of the dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. | v1 |