Version History
This section describes changes made in subsequent releases and the new features in this API. If not otherwise stated, changes are implemented in the Public API Cloud and Public API Edge.
| Release | Enhancements | API Version |
|---|---|---|
| 2025.2 | To improve resiliency and maintainability along with the performance; internal orchestration changed to point new CPaaS services. The orchestration logic doesn't involve contract change, making it non-breaking change ideally. But it does constitute a breaking change with respect to Multiversion. Hence a new version is introduced to public API, v2. For backward compatibility, the deprecated version (v1) remains functional until further notice (max 12 months), but we recommend that you use the new option instead. | v2 |
| 2025.2 | We improved the POS flow by allowing it to override some basket restriction violations with appropriate approval by the store manager. This ensures that the transaction will not be terminated with an exception when a sale restriction validation returns false. CPaaS now returns information on what restriction failed, why it failed, and if it is allowed to bypass. To support this implementation, request and response contracts are extended for the below endpoint: - POST /customers/validate The array properties below have been added to the response contract. - failedGeneralRestrictions - failedSaleRestrictions Orchestration changes for POST /customers/validate - To populate missing tax and product groups, PAG is calling the CPaaS Mapping Service. - Restriction Validation will now call for a separate Restriction Service instead of a basket service. | v1 |
| 2025.2 | To fulfill the requirement of generating regional specific data such as QR code, mandatory request field externalLocationId along with optional request fields externalClientId, documentNumber, documentTypeId, previousFiscalData,attributes and customer are added to endpoint: POST/proforma/process. | v1 |
| 2024.4 | To support validation of customer data on-demand, we have introduced a new endpoint on Public API Cloud and Edge: POST/customers/validate. It can be called anytime in between creating a basket until finalizing one. | v1 |
| 2024.4 | Optional request fields documentNumber, startDateTime and documentChain[ ] are added to the request body of endpoint: POST/printouts/reprint. Optional request field operation added to endpoint: POST/printouts/non-fiscal. The enhancement to the existing endpoints supports generic utilization regardless of fiscal device integration. | v1 |
| 2024.4 | To support enhancement pertaining to recalculation of tax after applying rebate, we have introduced a new endpoint on Public API Cloud and Edge: POST/taxes/proforma/calculate. It allows the POS to recalculate tax for Proforma invoice. | v1 |
| 2024.2 | To keep our codebase relevant, we deprecated the unused endpoint: GET /sessions/configuration/{fiscalSessionId}. This endpoint is deprecated as of Release 2024.2. It will be decommissioned at the end of Q1 2025. We also deprecated the following query parameters: clientId and fiscalSessionId in the GET/sessions endpoint. | v1 |
| 2024.2 | To support translations of fiscal reports printout, we introduced a new optional header: language-printout to the POST /printouts/report endpoint. The language-printout header is a unique language code used to translate printouts, as defined by RFC 5646 standards. | v1 |
| 2023.3 | To fix consistency with corresponding Public API Cloud POST /printouts/reprint endpoint we updated fiscalTransactionNumber parameter on Public API Edge and changed type and example to string. | v1 |
| 2023.3 | To enable the on-demand download of the fiscal report, we have introduced a new endpoint: GET /printouts/report/{reportId}. It allows the POS to get a fiscal report with fiscal session's events in response. With the new endpoint, if a report is requested when it is still being processed, the status code "202: Report is not ready" is returned. | v1 |
| 2023.2 | The following new endpoint has been added in this release: POST /clients/events - enables POS system to register standalone events occuring without transactions (for example, opening cash drawer, printing error, sales transaction canceled, shop product modified, customer modified). | v1 |