Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.3 | To implement voucher on the MTP Autonomous POS, the item in Retail Management and the Voucher Template ID in Vynamic Engage was required to be linked via an ExternalID. For this purpose, we have introduced two new endpoints: - POST /api/vouchers/templates/external/ externalId/issues: Issues a voucher from a template identified by its externalId. - GET /api/v1/vouchers/templates/external/externalId: Retrieves a voucher details based on the specified external ID. | v1 |
| 2026.3 and Patch in 2026.2 | To help integrate with 3rd-party systems, a new endpoint is introduced that allows POS systems to retrieve voucher history records such as balance, date of voucher operation, and source channel used to execute the voucher operation: - POST /api/v1/vouchers/voucherCode/history. | v1 |
| 2026.3 | Introduced a new voucher search capability that allows POS systems to retrieve vouchers using Template ID: - GET /api/v1/vouchers/templates/{id} This enhancement improves voucher management, enabling secure voucher handling while maintaining a seamless customer journey. | v1 |
| 2026.2 | To enhance the end-to-end functionality of the VRP portfolio, we have introduced endpoints that allow users to create new voucher templates. A voucher template serves as a base for vouchers that can be issued to customers as part of an offer. Users can also modify existing voucher templates. They have the ability to update the template's name, description, and relevant dates, as well as adjust the mode of redemption and type of distribution method for the voucher. The relevant endpoints are: - POST /vouchers/templates (to create a new voucher template). - PUT /vouchers/templates (to update an existing voucher template). | v1 |
| 2024.2-SP5 | To enable a service-level health check, we introduced a new endpoint: - GET /healthCheck. 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 |
| 2024.2 | To enable using additional data from voucher providers, we introduced a new optional request and response field "additionalData" to all Vouchers API endpoints. This field has an unspecified generic object type. | v1 |