Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| Patch in API 2024.2 | To enable the use of the POS system in multiple countries, coupon templates handle various languages by the TextInfos property called Translations. To support this feature and maintain consistency with private Vynamic Engage API, we extended the GET /coupons/templates/search and POST /coupons/templates endpoints with the following fields:- textInfos.languageCode - language code specified as 2 letters ISO code and 2 letters country code, for example en-GB, fr-FR. - textInfos.translations [] - optional collection of additional translations for text messages. | v1 |
| 2025.2 and Patch in API 2024.2 | 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 service. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. | v1 |
| 2024.1 | Vynamic Engage introduced the possibility to issue and redeem coupons in a bulk operation. The Mass Coupon Issue feature supports marketing campaigns and enables Retailers to issue multiple personalized coupon codes from a given template. To support this feature, we have exposed the following endpoints: - POST /coupons/massIssueJob - enables the POS system to create a Coupon Mass Issue job - GET /coupons/massIssueJob/{id} - enables the POS system to retrieve a collection of a Coupon Mass Issue job by Id (Coupon Mass Issue job unique Identifier) - GET /coupons/massIssueJob/search - enables the POS system to search for Coupon Mass Issue jobs based on various parameters. - GET /coupons/massIssueJob/result/{id} - enables the POS system to retrieve a Coupon Mass Issue job result with a status of the job execution. - GET /coupons/massIssueJob/resultAsCsv/{id} - enables the POS system to retrieve a Coupon Mass Issue job results as a .CSV file, by Id (Coupon Mass Issue job unique Identifier) The Mass Coupon Redemption feature enables Retailers to import already redeemed coupons from another system into CCVM. It prevents coupons from being reused and facilitates their handling according to their status. To support this enhancement, we have introduced the following endpoints: - POST /coupons/couponMassRedemptionJob - enables the POS system to create a Coupon Mass Redemption job - GET /coupons/couponMassRedemptionJob/{id} - enables the POS system to retrieve a collection of a Coupon Mass Redemption job by Id (Coupon Mass Redemption job unique Identifier) - GET /coupons/couponMassRedemptionJob/search - enables the POS system to search for Coupon Mass Redemption jobs based on various parameters. | v1 |
| 2023.3 | Coupon templates is a feature that enables users to pre-configure settings for future coupons, which can accelerate the creation of templates in a quicker and more efficient manner. To enable retailers to create and search the coupon templates, we have exposed two new endpoints: - POST /coupons/templates - enables to create a coupon template. - GET /coupons/templates/search - used to search and order coupon templates based on various parameters (name, creation date, validity period, status, type, Id, etc.). To enable retailers to retrieve available coupons for the particular customer (by Customer Id assigned to a coupon) we have also introduced the new endpoint: GET /coupons/customers/{customerId}. | v1 |
| 2023.2 | To enable retailers to manage, retrieve and validate the coupons, we have exposed four new endpoints to the Coupons API: - PUT /coupons/issues/reservation/{couponCode} - enables coupon reservation and place it under ReservationId - DELETE /coupons/issues/reservation/{couponCode} - enables to cancel coupon reservation by ReservationId - POST /coupons/templates/{couponTemplateId}/issues - issues a coupon from a given template. - PUT /coupons/redemptions - enables managing a collection of coupons, allows to redeem coupons by Redemptions.CouponCode and Redemptions.Date, to cancel coupon reservation by ReleaseReservationFor and to redeem coupons that were previously reserved by reservationId | v1 |
| 2023.2 | To enhance Vynamic Engage promotion engine flexibility we modified the GET /coupons/{couponCode} endpoint: - we added new optional request field: includeDesignData - we added new response fields: customerId, issueDate, and new response fields for objects: redemption, template, template, design, validity, - we introduced new value for Coupon status description (response field status): Voided. | v1 |