Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| Patch in API 2025.2 | To provide the integration of the POS system with the Vynamic Engage Promotion Engine, we introduced new endpoints: - PUT /reportJobs/{id}/cancel - enables cancellation of an existing report job. - GET /reportJobs - retrieves a report jobs list and current statuses based on certain criteria. - POST /reportJobs - enables the creation of a new report job. - GET /reportJobs/{id} - retrieves a current status and details of a given report job based on a job identifier. - GET /reportJobs/{id}/data - retrieves a report job data based on a job identifier. | 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 |
| 2023.3-SP1 | To support a bulk import of customer related data we introduced a new Import Export API. The following new endpoints enable to manage Bulk Import Jobs: - POST /importJobs - enables to create a new bulk import job. - PUT /importJobs/{id}/upload - enables to upload a bulk import job package. - PUT /importJobs/{id}/start - enables to start a created import job. - PUT /importJobs/{id}/cancel - enables to cancel an existing bulk import job. - GET /importJobs/{id} - based on a job identifier retrieves a current status and details of a given bulk import job. - GET /importJobs - retrieves bulk import jobs list and current statuses based on certain criteria. | v1 |