Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.3 | A Delta Bulk Export has been added to enable exporting customer data as deltas for analysis and reporting purposes and/or integration with external systems. This improvement was created to eliminate manual steps and to minimize performance impact. To allow this, we introduced the following new endpoints: - GET /api/v1/deltaExportJobs - Retrieves the delta export jobs list based on certain criteria. - POST /api/v1/deltaExportJobs - Creates a new delta export job. - GET /api/v1/deltaExportJobs/{id}/file - Downloads a delta export job file based on a job identifier. - GET /api/v1/deltaExportJobs/{id} - Retrieves the current status and details of a given delta export job based on a job identifier. - PUT /api/v1/deltaExportJobs/{id}/start - Enables initiation of an existing export job. - PUT /api/v1/deltaExportJobs/{id}/cancel - Enables initiation of an existing export job. | v1 |
| 2026.2 and Patch in API 2024.2-SP5 | A Bulk Export function has been added to enable the export of customer data for analysis and reporting purposes, or for integration with external systems. This improvement was created to eliminate manual steps and to minimize performance impact. To allow this, we introduced the following new endpoints: - PUT /api/v1/exportJobs/{id}/start - Initiates an existing report job. - GET /api/v1/exportJobs - Retrieves the export jobs list based on certain criteria. - POST /api/v1/exportJobs - Enables the creation of a new export job. - GET /api/v1/exportJobs/{id} - Retrieves the current status and details of a given export job based on a job identifier. - GET /api/v1/exportJobs/{id}/file - Download an export job file based on a job identifier. | v1 |
| Patch in API 2024.2-SP5 | To provide the integration of the POS system with the Vynamic Engage Promotion Engine, we introduced new endpoints: - PUT /api/v1/reportJobs/{id}/cancel - enables cancellation of an existing report job. - GET /api/v1/reportJobs - retrieves a report jobs list and current statuses based on certain criteria. - POST /api/v1/reportJobs - enables the creation of a new report job. - GET /api/v1/reportJobs/{id} - retrieves a current status and details of a given report job based on a job identifier. - GET /api/v1/reportJobs/{id}/data - retrieves a report job data based on a job identifier. | v1 |
| 2024.2-SP5 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 /api/v1/importJobs - enables to create a new bulk import job. - PUT /api/v1/importJobs/{id}/upload - enables to upload a bulk import job package. - PUT /api/v1/importJobs/{id}/start - enables to start a created import job. - PUT /api/v1/importJobs/{id}/cancel - enables to cancel an existing bulk import job. - GET /api/v1/importJobs/{id} - based on a job identifier retrieves a current status and details of a given bulk import job. - GET /api/v1/importJobs - retrieves bulk import jobs list and current statuses based on certain criteria. | v1 |