Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.2 | To update station and management node names per the HIDM template, we adjusted the DTO to fetch extra fields. To support this enhancement in Public API, we introduced the following changes: - we changed the fields StationDescription (string) and StationNo (integer) to Station (object), and StockOwnerDescription (string) and StockOwnerNo (integer) to Owner (object), in BusinessUnitDto for the POST /api/v2/stock/state endpoint. This is a breaking change and due to this breaking change released in the Stocks API, we changed its version to 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 |
| 2026.2 and Patch in API 2024.2-SP5, 2024.2 | To fulfill the legal requirement for generating the Stock State report, we have introduced the following endpoint: - POST /stock/state External systems will use this endpoint to retrieve stock state data. | v1 |
| 2024.2-SP5 and Patch in API 2024.2 | To improve the performance of the document bulk load in Vynamic Retail Management via API Platform and to provide the possibility to import Inventory Count documents from third parties via API platform, we introduced the new endpoints: - GET /stock/status-enquiries/{requestId} and POST /stock/inventoryCount/bulk-load. The GET /stock/status-enquiries/{requestId} endpoint retrieves the status of the bulk import operation. The POST /stock/inventoryCount/bulk-load endpoint is used to create or update Stock-Inventory Count in a bulk and asynchronous manner. The GET /healthCheck endpoint also supports the Bulk Import API service along with the other dependent backend services such as Counterparties API service, Stock Control API service, and MasterData API service. | 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 services. A client can check the status of backend services so that it knows when to switch from cloud to edge. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. | v1 |