Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.3 and Patch in API 2026.2 | Enhanced Legal Entity number handling for the GET /businessUnitGroups endpoint by updating the data types of businessUnitGroupTypeId, parentBusinessUnitGroupId and legalEntityId from int32 to int64 in the request payload. This enhancement supports larger numeric values and enables the creation and processing of Legal Entities with long entity numbers. | v1, v2, v3, and v4 |
| 2026.3 | A new query parameter, SyncVersion has been added to the POST/api/v4/stations/{stationNo}/edges/{edgeNo}/multiVersion/restoreEdgeSync endpoint in the Stations component of Master Data API. It is optional, and required everytime an edge is registered to the database (cloud-edge synchronization). The value is obtained from the SyncVersion column of dbo.DbVersion table in VRx database and normally filled when the edge deployment playbook is run. | v2, v3, v4 |
| 2026.3 and Patch in API 2026.2 | Item numbers are now unique per ownerBusinessUnitGroupId, which allows different management-node owners to use the same item number without cross-owner selection errors. The change also introduces hierarchy-based station synchronization, which gives retailers, the opportunity to store items within station hierarchy only. Retailers can define items using the same number at multiple hierarchy levels for example, Corporate, Country, Chain, Store. To allow same item numbers within the business unit hierarchy, we introduced the following changes: - POST /api/v4/supplierPackagesItems/bulk-load - A new request field, supplierPackagesItems.ownerBusinessUnitGroupId is added. - POST /api/v4/supplierPackagesItems/bulk-load - Two new request fields, priceLists.prices.itemId and priceLists.prices.ownerBusinessUnitGroupId is added. - POST /api/v4/assortmentItems/bulk-load - A new request field, assortmentItems.ownerBusinessUnitGroupId is added. | v2, v3, v4 |
| 2026.3 and Patch in API 2026.2 | To ensure consistency with the backend, we introduced the following endpoint: - POST /api/v4/configuration/orgNodeConfiguration/{orgNodeId} - retrieves the configuration tree for a specified orgNodeId by path. | v4 |
| 2026.3 and Patch in API 2026.2 | To ensure consistency with the backend, we introduced the following endpoint: - GET /api/v4/stations/{locationNumber}/eslExport/initialPublication - starts the initial publication process of the SQL database for a given station in Vynamic VRx. | v3 & v4 |
| 2026.3 and Patch in API 2026.2 | POST /shopItems/bulk-load Updated shopItems.itemAttributesOverride.salesRestrictions.timeGroupId and shopItems.salesRestrictions.timeGroupId from int32 to int64, enabling support for large timeGroupId values. | v3 & v4 |
| 2026.3 | To improve duty-free purchase compliance validation, support was added for importing the QuotaGroup attribute per item through the Bulk Import Public API. As part of this enhancement, the GET /api/v4/shopItems endpoint was extended with the following fields: shopItems.itemAttributesOverride.salesRestrictions.isDutyFreeItem, shopItems.itemAttributesOverride.salesRestrictions.isNoSeatControlledItem, shopItems.itemAttributesOverride.salesRestrictions.quotaGroupId, shopItems.salesRestrictions.isDutyFreeItem, shopItems.salesRestrictions.isNoSeatControlledItem, shopItems.salesRestrictions.quotaGroupId GET /api/v4/shopItems/bulk-load was extended with the following fields: shopItems.salesRestrictions.quotaGroupId, shopItems.itemAttributesOverride.salesRestrictions.quotaGroupId | v3 & v4 |
| 2026.3 and Patch in API 2026.2 | To align with the Retail Management user interface, the maximum character lengths for the following request fields in the POST /api/v4/shopItems/bulk-load endpoint have been increased. As a result, the API and UI now enforce consistent validation rules for these fields: ItemName (maximum 40 characters), ItemLabelText (maximum 50 characters), ItemDescription (maximum 50 characters), and ItemButtonText (maximum 255 characters). | v1, v2, v3 and v4 |
| 2026.3 and Patch in API 2026.2 | We have enhanced the Tax Mapping feature to enable users to map RM VAT/Taxes to CPaaS Taxes through the VRx Master Data Public API for Taxes. This enhancement helps ensure that tax mappings are aligned with applicable regional and legal tax requirements while maintaining consistency between RM and CPaaS tax data. To support this functionality, a new API version (v4) has been introduced for the following endpoint: - POST /api/v4/taxes/bulk-load The request payload remains the same as in the previous version and cpaasMapping object consists of: internalId (number (integer)) and regionCode (string) Additionally, the response for the following endpoint has been extended: - GET /api/v4/taxes cpaasTaxInfo object consists of: regionCode (string), taxName (string), taxGroupId (string), taxRatePercentage (number (double)), validDateFrom (string), validDateTo (string), receiptPrintCode (string). | v4 |
| 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 OwnerNodeName (string) to Owner (object) and SharedNodeName (string) to Receiver (object) in BusinessUnitDto for the GET /businessContracts endpoint. - we changed the fields StationNumber (integer), StationName (string), StationDisplayName (string), and StationDescription (string) to Station (object) in BusinessUnitDto for the GET /posConfig endpoint. - we added a new required query parameter managementNodeNo (integer) in the POST /itemTare and POST /packageUnits endpoints. This is a breaking change and due to this breaking change released in the Master Data API, we changed its version to v4. For backward compatibility, the deprecated version (v3) remains functional until further notice (max 12 months), but we recommend that you use the new option instead. | v4 |
| 2026.2 | To enable proper handling of duty-paid/free items on the POS, including restricting sales based on flight type or seat assignment, we have extended the POST /shopitems/bulk-load endpoint by adding an optional fields isDutyFreeItem and isNoSeatControlledItem to the request contract. | v3 |
| 2026.2 | An optional query parameter, managementNodeNo (integer), has been added to the request contract of the following endpoints: - GET /recipes - GET /currencies - GET /businessUnitGroups - GET /storeOperators - GET /hauliers - GET /users - GET /businessunits - GET /methodOfPayments This enhancement enables the API to retrieve information for all available Quick Service Restaurant (QSR) item recipes, currency rates, business unit groups, store operators, hauliers, users, business units, and methods of payment configured in VRx that are associated with management nodes other than Node No. 1. | v3 |
| 2026.2 | To ensure consistency with the backend, we introduced the following endpoint: - GET /golive - retrieves the current station mode. | v3 |
| 2026.2 | To ensure that the number field is the unique POS number from the database, we improved the following endpoint: - GET /api/v1/stations/edgeIdentification Field posInfo.id has now a unique number of the POS. | v2,v3 |
| 2026.2 | From 2026.2, the following endpoint has been deprecated from the Masterdata API: - GET /documents/search You can continue to use the GET /documents/search endpoint via the Document API. For backward compatibility, the deprecated endpoint remain functional until further notice (max 12 months), but we recommend that you use the new option instead. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To facilitate storing details such as - effective and expiry dates of items at store levels, it was required to modify character(s) restrictions of certain attributes in the Request schema of the POST/shopitems/bulk-load endpoint. The following fields now have modified character restrictions: - itemName - The character limitation of this attribute has increased from 24 to 40. - itemDescription - The character limitation of this attribute has increased from 30 to 50. - productDescription - The character limitation for this attribute has been removed; it is now equipped to accept data of any length. - itemLabelText - The character limitation of this attribute has increased from 24 to 50. - itemButtonText - The character limitation of this attribute has increased from 12 to 255. - customAttributes - The character limitation for this attribute has been removed; it is now equipped to accept data of any length. | v3 |
| 2026.2 | To ensure synchronization of changes in master data with ESL systems, taking into account the effective date and time constraints, and to ensure consistency with the backend, we introduced the following endpoint: - POST /eslNotifier - Notifies Electronic Shelf Label (ESL) systems about item changes based on provided filters. Allows filtering by specific item IDs, categories, groups, departments, and locations with an effective date and restriction time. | v3 |
| 2026.2 | To facilitate the importing and retrieving of suppliers with delivery options, we have enhanced the following endpoints by adding new fields under Suppliers array of object. - POST /suppliers/bulk-load - GET /suppliers The fields are added to the request and response contract of the endpoints, respectively: - itemOrderingTypeId - deliveryOptionLeedTime - deliveryOptionMinDeliveryQuantity - deliveryOptionMinOrderValue. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To ensure consistency with the backend, we introduced the following endpoint: - GET /checkNumber/{number} - check if number validation is required and if the number is unique. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Item Tare functionality allows users to create, view, and edit item tares for their products. The shop products can then be configured using the item tare. To support this functionality and to maintain consistency with the backend, we introduced the following new endpoints: - POST /itemTare - creates a new one or updates the existing item tare. The update operation occurs when the entityNo is provided in the request. The create operation occurs when the entityNo is provided in the request as null. - GET /itemTare - retrieves the list of item tare. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Application Theme parameter defines the color theme of the application. To ensure consistency with the backend, we introduced the following endpoint: - GET /applicationTheme - retrieves the application theme based on module and theme identifiers. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To ensure consistency with the backend, we introduced the following endpoints: - GET /priceChangeDocument/{documentID} - enables the API client to retrieve price change document details by document identifier. - GET /documents/search - enables the API client to search documents by document code. The following endpoint was extended with the update operation: - POST /prices/bulk-load-async - The create operation occurs when the documentCode details are provided in the initial request. The update operation takes place when documentCode details are included in subsequent requests. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To ensure consistency with the backend, we introduced the following endpoints: - POST /posConfig - enables the API client to create a new POS from DTO (version: v1.0.2) - PUT /posConfig - enables the API client to update the POS from DTO (version: v1.0.2) - GET /posConfig - retrieves a list of all the POS configurations by management node identifier (version: v1.2.0). | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Operational Unit values are defined by configuration. A user can select one or more operational units to which a transaction belongs. To support this enhancement in the public API, we introduced the following endpoint: - GET /operationalunits - retrieves the list of all available operational units. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To further enhance the translation in the locale, the following endpoint is extended: POST /localization - enables the API client to either import (create) or update translations for the selected file in the Retail Management. The create operation occurs when the translation details are provided in the initial request.The update operation takes place when translation details are included in subsequent requests. To support the export functionality, we introduced the following endpoint: POST /localization/export/masterdataEntities - exports the translations for the selected file in the Retail Management. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To enable users to fetch an image by its path for login screens, reports, retail management client, and pos client etc.,we have released the following endpoint: - GET /images - retrieves an image by its path and entity number. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Brands feature allows users to create and view brands for the products. To support the feature implementation and to maintain consistency with the backend, we introduced the following new endpoints: - POST /brands - creates a new one or updates the existing brands. - GET /brands - gets the list of all available brands for the grid. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Packaging Units are the units of measurement for the shop items in a stock. To support the feature implementation and to maintain consistency with the backend, we introduced the following new endpoints: - POST /packageUnits - creates a new or updates the existing package units. - GET /packageUnits - gets the list of all available package units. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To enable retrieving and updating configuration tree values for a specified Station or POS (entityNo), we introduced the following new endpoints: - POST /configuration/entityConfiguration/{entityNo} - retrieves the configuration tree for a specified entity by path. - PUT /configuration/entityConfiguration/{entityNo} - updates the configuration parameters for the organizational node or user by path. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | To support translation in the locale , we introduced a new endpoint: - POST /localization The EAPI accepts a JSON request. Once the required values are retrieved, a CSV file is prepared and converted to Base64 format before being sent to the backend system. To support the implementation, an orchestration logic is introduced. The following endpoints are called internally to retrieve the required data. - POST /api/v1/systemKeys/masterDataSystemKeys - GET /api/v1/dictionaries/entityTranslationAttributes - GET /api/v1/translation/locales | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Barcode Template is a combination of tokens encoded in a fixed-length string that helps identify the functionality associated with that string. It helps to use the same workflow every time the system recognizes a barcode. To support this functionality and maintain consistency with the backend, we introduced the following new endpoints: - GET /barcodeTemplates - retrieves a list of the barcode templates. - POST /barcodeTemplates - creates or updates the barcode templates. The POST /barcodeTemplates endpoint updates the barcode template if a user passes the ID in the request; otherwise, it creates a new barcode template. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Number Ranges functionality enables users to assign and limit the number range for various features, including Items, Departments, Method of Payment, and Assortments, to a specific management node. To support this feature and maintain consistency with the backend, we introduced the following new endpoints: - GET /numberRanges - retrieves number ranges for the management node. - PUT /numberRanges - updates number ranges for the management node. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Period Workflows feature enables user to configure different Reconciliation Process such as The Wet Stock (WSR) Reconciliation Process, the Electronic Fund Terminal (EFT) Reconciliation Process etc. To support the feature implementation and to maintain consistency with the backend, we introduced the following new endpoints: - POST /periodWorkflows/periodProcessTypeId/{periodProcessTypeId}/savePeriodWorkflow - creates a new period workflow. - GET /periodWorkflows/periodProcessTypeId/{periodProcessTypeId}/periodWorkflowId - retrieves period workflow identifier by period process type identifier. - POST / periodWorkflows/periodProcessTypeId/{periodProcessTypeId}/filtered - filters workflow with the specified criteria. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The bulk import of locations enables users to upload a batch of various locations, which are then stored in the system. To support this enhancement in the public API and maintain consistency with the backend, we introduced the following new endpoint: - POST /locations/bulkImport - allows uploading a batch of locations in JSON format. | v3 |
| 2026.2 and Patch in API 2024.2-SP5 | The Business Contract functionality enables users to define rules that work across different management nodes. It also defines which individual records can be viewed and edited by users of a specific management node. To support this feature and maintain consistency with the backend, we introduced the following new endpoints: - GET /businessContracts/templates - retrieves a list of the business contract templates. - POST /businessContracts/templates - creates a new template based on the existing business contract. - PUT /businessContracts/templates - updates a template based on the existing business contract. - DELETE /businessContracts/templates/{templateId} - deletes a template by its identifier. - POST /businessContracts - creates a new business contract. - PUT /businessContracts - updates a business contract. - GET /businessContracts - retrieves a list of business contract. - GET /businessContracts/defaultRules - returns business object default rules. - GET /businessContracts/availableNumber - retrieves a minimal available number. - GET /businessContracts/cardDatasources - retrieves datasources for business contract card. - GET /businessContracts/contexts - retrieves business context by the allowed access level of the business object. - GET /businessContracts/availableAdvancedFilters - retrieves available advanced filters definitions for business object. | v3 |
| 2024.2-SP5 and Patch in API 2024.2 | To enhance the user experience, VRx Retail Management UI is provided with a checkbox named, isSkipDeployment. User can define whether the POS deployment should be skipped for a specific location. To support this enhancement in public API, we extended the endpoint: GET /posconfig/posIdentification where we introduced a new optional response field: isSkipDeployment. We extended the endpoint: GET /stations/locationIdentification. We added the following new optional response fields: isSkipDeployment and locationIdentificationPos. We extended the endpoint: GET /stations/edgeIdentification. We added the following new optional response fields: isSkipDeployment, location, and posInfo. | v3 |
| 2024.2-SP5 and Patch in API 2024.2 | To fix discrepancy and maintain consistency with the backend, we changed the field type from int32 to int64 in request & response field id for the following endpoint: - GET /timeRestrictions. This is a breaking change. For backward compatibility, the deprecated endpoints remain functional until further notice (max 12 months), but we recommend using the new option instead. Due to the breaking change released in the Master Data API, but version v3 remains the same. | v3 |
| 2024.2-SP5 | To support the multi-edge deployment and configuration process, we introduced the following new endpoint: - GET /stations/{stationNo}/edges It provides a list of Edge devices with attributes (number, hostname, MAC address, serial number, configuration details, etc.) based on the Station identifier. | v3 |
| 2024.2-SP5 | To further support the CPaaS - VRP integration, and the setup of VRP environment, we extended the GET /stations/locationIdentification endpoint. We added an optional response field regionCode, unique code of the region where the POS is located. It is mapped with CPaaS region code Id. | v3 |
| 2024.2-SP5 and Patch in API 2024.2 | To further support the setup of VRP environment, we extended the GET /stations/locationIdentification endpoint. It retrieves various touchpoint parameters and configuration details based on the machine hostname, MAC address, or serial number. We introduced the following new response fields: - locationDescription - locationIdentificationPos.id - locationIdentificationPos.stationNo - locationIdentificationPos.description - locationIdentificationPos.posDeviceTypeId - locationIdentificationPos.operatingSystemId - locationIdentificationPos.entityStateId - locationIdentificationPos.isLocked - locationIdentificationPos.proxyServiceDetails - locationIdentificationPos.proxyServiceDetails.proxyServiceTypeId - locationIdentificationPos.proxyServiceDetails.proxyServiceId As a result, it is possible to fetch the POS Id, station Id, device type Id and more stations details, and use these data in the deployment automation. | v2, v3 |
| 2024.2-SP5 and Patch in API 2024.2 | To fix discrepancy and maintain consistency with the backend, we changed the field type from int32 to int64 in the following endpoints: - GET /departments in the response fields: id, ownerBusinessUnitGroupId, parentId, stockOwnership.stockOwnerEntityId, salesRestrictions.timeGroupId, otherAttributes.financialGroupId, otherAttributes.outFinancialGroupId, otherAttributes.eFTRestrictionId, otherAttributes.outEFTRestrictionId, otherAttributes.taxRuleId, otherAttributes.outTaxRuleId. - GET /shopitems in the response fields: shopItems.manufacturerId, shopItems.brandId, shopItems.countryOfOriginId, shopItems.salesRestrictions.timeGroupId, shopItems.activeIngredient.number, otherAttributes.financialGroupNumber, otherAttributes.outFinancialGroupNumber, otherAttributes.eftRestrictionNumber, otherAttributes.outEFTRestrictionNumber, shopItems.otherAttributes.taxRuleID, shopItems.otherAttributes.outTaxRuleID, orderingAttributes.mainSupplierId, shopItems.stockOwnership.stockOwnerId. - GET /taxes in the response fields: taxRules.taxRuleId, taxRules.taxRates.id, taxRules.ownerBusinessUnitGroupId | v1, v2, v3 |
| 2024.2-SP5 and Patch in API 2024.2 | We improved HIDM and VRx applications integration with processing alphanumeric characters in managing User identifiers. To support this enhancement in Public API, we introduced the following changes: - we added the maximum characters for id field (255), login an fullName fields (256) in the POST /users/bulk-load endpoint. - we changed the data type from integer to string in the request id field in the POST /users/bulk-load- we changed the data type from array[integer] to array[string] in the request id field and the response id field (from integer to string) in the GET /users endpoint. - we changed the data type from array[integer] to array[string] in the request id field in the PUT /users/deactivate endpoint.Due to the breaking change released in the Master Data API, we changed its version to v3. For backward compatibility, the deprecated version (v2) remains functional until further notice (max 12 months), but we recommend that you use the new option instead. | v3 |
| 2024.2-SP5 and Patch in API 2024.2 | In some scenarios, the same shop items can have multiple owners across various locations. We extended VRx capabilities to manage inventory control of a given item across different management nodes. Currently, the accounting type attribute is supported on the management node level and can be specified per location. To support this enhancement, we extended the GET /shopitems and POST /shopitems/bulk-load endpoints: - we added an optional request parameter BusinessUnitGroupId to the GET /shopitems endpoint - we added the following optional response fields (array): shopItems.itemAttributesOverride [] to GET /shopitems endpoints. It represents a collection of models for overridden item attributes. - we added optional request fields: shopItems.stockAccounting, shopItems.stockAccounting.inventoryAccountingMethodCode, shopItems.itemAttributesOverride.stockAccounting, shopItems.itemAttributesOverride.stockAccounting.inventoryAccountingMethodCode to the POST /shopitems/bulk-load endpoint. - we deleted the request field: shopItems.inventoryAccountingMethodCode, which is an API breaking change. Due to the breaking change released in the Master Data API, we changed its version to v3. The Master Data API v2 is deprecated as of Release VRP 2024.2-SP5 and VRP 2024.2_SP3. For backward compatibility, the deprecated endpoints remain functional until further notice (max 12 months), but we recommend using the new option instead. | v3 |
| 2024.2-SP5 and Patch in API 2024.2 | To support proper and efficient Cloud-Edge synchronization we exposed the following endpoints: - POST /stations/{stationNo}/multiVersion/disableEdgeSync - notifies the cloud environment that synchronization should be disabled for a specific station Edge device. ( deprecated) - POST /stations/{stationNo}/multiVersion/restoreEdgeSync - notifies the cloud environment that synchronization should be restored for a specific station Edge device. ( deprecated)These endpoints were downported to API 2024.2 and 2024.2-SP5 releases, and then superseded by the following new endpoints, supporting the multi-edge deployment process: - POST /stations/{stationNo}/edges/{edgeNo}/multiVersion/disableEdgeSync - it notifies the cloud environment that synchronization should be disabled for a given station and a selected Edge device. - POST /stations/{stationNo}/edges/{edgeNo}/multiVersion/restoreEdgeSync - it notifies the cloud environment that synchronization should be restored for a given station and a selected Edge device. We also introduced the new endpoint which starts the initial publication process of the Edge SQL database for a given station and an Edge device: - POST /stations/{stationNo}/edges/{edgeNo}/sqlDb/initialPublication. It superseded the following endpoint: POST /stations/{stationNo}/sqlDb/initialPublication, deprecated as of Release 2024.2-SP5 (and in API 2024.2 as a patch). For backward compatibility, the deprecated endpoints remain functional until further notice (max 12 months), but we recommend that you use the new option instead. | v2 |
| 2024.2-SP5 and Patch in API 2024.2 | To support the multi-edge deployment process, we enhanced the configuration management capabilities of the Retail Management platform. The following endpoint provides comprehensive information for edge devices: - GET /stations/edgeIdentification - it retrieves Edge parameters and configuration details based on the Edge hostname, MAC address, or serial number. The new endpoint superseded the following endpoint: GET /stations/locationIdentification, deprecated as of Release 2024.2-SP5 (and in API 2024.2 as a patch). For backward compatibility, the deprecated endpoint remain functional until further notice (max. 12 months), but we recommend that you use the new option instead. | v2 |
| 2024.2-SP5 and Patch in API 2024.2 | We enhanced configuration management by providing comprehensive device information on Edges, Touchpoints, and POS devices. To support this feature, we implemented a new endpoint: - GET /posConfig/posIdentification The endpoint retrieves multiple device parameters and configuration details based on the machine hostname, MAC address, or serial number. | v2 |
| 2024.2-SP5 and Patch in API 2024.2 | To enable retrieving multiple configuration tree values for a specified Station or POS (entityNo), we introduced the following new endpoint: - POST /configuration/aggregatedEntityConfiguration/{entityNo} It fetches aggregated configuration parameters from Vynamic VRx. | v2 |
| 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. | v2 |
| 2024.2-SP5 | In the Vynamic Retail Portfolio, 2024.2-SP5 release, we implemented customizable Inquiries that can be shown on the cashier's screens for certain POS sales operations. This enables retailers to obtain additional information during transactions. The configuration of the Inquiry form is implemented for cases where the cashier has added a Predefined discount and also displayed for Methods of payment. To support bulk import of inquries, along with other master data, we introduced the following new request fields in the POST /discounts/bulk-load endpoint: - discounts.useInquiries - discounts.inquiryId (int64) To maintain consistency with the backend we also changed the data type from int32 to int64 for the methodOfPayments.inquiryNumber field in the GET /methodOfPayments and POST /methodOfPayments/bulk-load endpoints. | v2 |
| 2024.2-SP5 | We have enhanced backend validation rules to the description for POST /businessunits/bulk-load endpoint. contactDetails.phone,contactDetails.fax and contactDetails.mobile | v1, v2 |
| Patch in API 2024.2 | Setting predefined discounts is a convenient way to apply discounts during the checkout process. By configuring predefined discounts, the Cashier can quickly apply discounts to specific products with just a few clicks, eliminating the need for manual discount calculations. To support this feature, we enhanced the POST /discounts/bulk-load endpoint with the following request fields: - discounts.externalId - enables you to assign External ID to a Discount. Using this parameter, you can easily integrate 3rd party ERP systems with Retail Management. - discounts.itemAssignments [] - limitations that can be applied to a discount or used under certain conditions. - discounts.businessUnitGroups [] - enables you to set and manage Predefined Discounts in specific Management Nodes. - We also updated a maximum number of characters for the discounts.name (to 30) and discounts.description (to 256). To maintain consistency with the newest version (v2) of private endpoints, we changed the backend version to v2 in the POST /discounts/bulk-load and GET/discounts endpoints. | v1 |
| Patch in API 2024.2 | To add improvements and maintain consistency with the newest version (v2) of private endpoints, we changed the backend version to v2 in the POST /recipes/bulk-load and POST /additives/bulk-load endpoints. | v1, v2 |
| 2024.2 and Patch in API 2024.1 | To further support the HIDM - VRP integration, and the setup of VRP environment, we extended the GET /stations/locationIdentification endpoint, which provides stations details based on the location identification data. We added an optional response field businessUnitId, indicating HIDM Id, assigned to the related Management Node. | v1, v2 |
| 2024.2 | To facilitate efficient support during failover, we implemented High Availability POS: a dedicated store touchpoint with POS software installed on the Edge device. This ensures that the store is connected to at least one touchpoint in the case of missing connection. To support this enhancement we extended the GET /stations/locationIdentification endpoint with the following optional response fields: - managementNodeNumber (a unique, system-assigned identifier for a group of Business Units) and - locationIdentificationPos.number (indicating the POS number). As a result, it is possible to retrieve the POS number as well as the number of the Management Node of the POS connected to Edge, and use these data in deployment automation. | v2 |
| 2024.2 | To control markdown handling, we extended the following endpoints: POST /shopitems/bulk-load (in request) and GET /shopitems (in response) with a new optional field shopItems.markdownDisabled. This parameter indicates if a given shop item is eligible for downpricing by Hand Held Terminal (HHT) User. | v2 |
| 2024.1 | To support the handling of Variable priced items we are introducing the following parameters: Price Entry Required flag and Quantity Entry Required flag. The POS application will prompt the Cashier to enter the price or quantity for the selected article when it is added to the basket. To support this feature we have extended the endpoints: POST /shopitems/bulk-load (in request) and GET /shopitems (in response) with the following optional attributes: - shopItems.posItems.priceEntryRequired - shopItems.posItems.quantityEntryRequired | v2 |
| 2024.1 | To maintain consistency with the backend we changed the data type from int32 to int64 for the subsequent fields: shopItems.departmentId and shopItems.itemGroupId in the following endpoints: POST /shopitems/bulk-load (in request) and GET /shopitems (in response). | v1, v2 |
| 2024.1 | We extended the POST /shopitems/bulk-load endpoint with an optional array of objects: shopItems.itemAttributesOverride [] in the request. This enhancement makes it possible to define and modify the Shop Items properties assigned to specific Management Nodes. | v1, v2 |
| 2024.1 | To provide details of the POS integration, we exposed a new endpoint: - GET /posconfig/integration - retrieves details of the POS configuration interface from Retail Management. The POS can be uniquely identified per tenant, for instance by the Id (workstations.posId), the Management Node Id (workstations.businessUnitGroupId), the Station Number (workstations.businessUnitId). | v2 |
| 2024.1 | To enable retrieving Site specific configuration details from the Retail Management services we exposed the following endpoints: - GET /posConfig/station/{stationId} - provides the POS configuration details from Vynamic VRx using the unique Station Identifier. - GET /stations/number/{number} - provides details of the specific station by Station Number - GET /stations/locationIdentification - provides stations details by location identification data - POST /configuration - provides details of the configuration tree from Vynamic VRx - GET /stations/withPoses - provides a list of stations with POSes. - POST/ stations/{stationNo}/sqlDb/initialPublication - starts the initial publication process of the SQL database for a given station in Vynamic VRx. | v2 |
| 2024.1 | The cashier can access the most frequently used items quickly and directly by using the Article keys area at the POS terminal. We enhanced the Shop Buttons feature to display groups of articles in the Articles panel. By using the group buttons, the Operator can set up complex structures of buttons and menus with subcategories. To support this extension we introduced the following changes: - we added the following fields: posKeys.screen.buttons.navigateScreenName and array: posKeys.screens [] to the endpoints: POST /posKeys/bulk-load (in request) and GET /poskeys (in response) - we added the field: shouldFetchAllLayouts to GET /poskeys endpoint (in request) - we changed the backend version for POST /posKeys/bulk-load endpoint to v2. | v2 |
| 2024.1 | During the purchase of goods at a retail store, the buyer and the retailer constitute counterparties in the operation. Legal Entities are counterparties participating in a financial operation, for example different business units that have legal rights and obligations related to agreements, contracts and payments. To enable creating, assigning, and deactivating Legal Entities, as well as assigning Legal Entities to a set of management nodes in Retail Management via API, we introduced the following new endpoints: - POST /legalEntities/bulk-load - enables bulk loading of the Legal Entities list to Retail Management in asynchronous way - PUT /legalEntities/deactivate - deactivates Legal Entities - GET /legalEntities - retrieves data and provides details on Legal Entities. To support master data handling on the specific management node level and maintain consistency with private API endpoints we introduced the following changes: - we added the new field ownerBusinessUnitGroupId (a business identifier which is used to identify a Management Node) for the following endpoints (in request): GET /itemgroups, PUT /itemgroups/deactivate, GET /departments, PUT /departments/deactivate, PUT /shopitems/deactivate Note: the above-mentioned changes were introduced in v1 and v2. - we added a response code 206: "Partial Content" to the following endpoints and changed its backend version to v2: PUT /itemgroups/deactivate, PUT /departments/deactivate, PUT /shopitems/deactivate | v2 |
| 2023.3-SP2 | A Management Node is the main object used for defining a flexible hierarchy structure with different levels of hierarchies. To support Master Data handling on a specific management node level we introduced the following changes: - we added the new request field ownerBusinessUnitGroupId (a unique identifier that makes it possible to identify the Management Node of an item owner) to the following Master Data endpoints: - GET /assortments - PUT /assortments/deactivate - GET /suppliers (in request and in response) - POST /suppliers/bulk-load - PUT /suppliers/deactivate (implemented in v2 only) - GET /supplierPackages - PUT /supplierPackages/deactivate - GET /taxes - PUT /taxes/deactivate (implemented in v2 only) - GET /timeRestrictions - PUT /timeRestrictions/deactivate (implemented in v2 only) - we removed the businessUnitGroupId request field from the following endpoints: GET /assortments and GET /supplierPackages. - we added a new request field: suppliers.isLegalEntity to POST /suppliers/bulk-load. - we added a response code 206: "Partial Content" to the following endpoints: PUT /suppliers/deactivate, PUT /supplierPackages/deactivate, PUT /taxes/deactivate, PUT /timeRestrictions/deactivate We also expanded new endpoints related to Financial Groups and Electronic Funds Transfer (EFT) restrictions: - POST /financialGroups/bulk-load - uploads a batch of Financial Groups. The Financial Group includes a VAT rate that can be shared among all assigned shop items. - PUT /financialGroups/deactivate - deactivates Financial Groups. - GET /financialGroups - provides a list of Financial Groups based on the parameters supplied in the request. - POST /eftRestrictions/bulk-load - enables bulk loading of the list of the Electronic Funds Transfer (EFT) restrictions to the VRx Retail Management application. The Electronic Funds Transfer (EFT) restrictions constitute limitations that define which items can be sold via an EFT terminal when using payment cards. - PUT /eftRestrictions/deactivate - deactivates the Electronic Funds Transfer (EFT) restrictions. - GET /eftRestrictions - provides details of Electronic Funds Transfer (EFT) restrictions. Due to the breaking changes released in the Master Data API we changed its version to v2. The Master Data API v1 is deprecated as of Release VRP 2023.3-SP2. For backward compatibility, the deprecated endpoints remain functional until further notice (max 12 months), but we recommend using the new option instead. | v1, v2 |
| 2023.3 | To enable the matching documents sent via bulk-import API to the linked documents in CTR we extended the contract of the two synchronous endpoints: POST/fuelPrices/bulk-load and POST/prices/bulk-load and introduced the following fields: errorData.externalDocumentId and successData.externalDocumentId. To keep consistency with the current implementation we modified the font size for the following fields, changing two uppercase letters (ID) to one (Id): prices.unitPriceTypeId, businesUnits.businesUnitGroupId and businesUnits.businesUnitId. | 1.3.12 |
| 2023.3 | To support master data handling on the specific Business Unit Group level and maintain consistency with private API endpoints, we introduced the following new field ownerBusinessUnitGroupId, a unique identifier that enables to identify a group of BusinessUnit of item owner: - a new optional request field taxes.ownerBusinessUnitGroupId has been added to POST /taxes/bulk endpoint. - a new optional response field taxRules.ownerBusinessUnitGroupId has been added to GET /Taxes endpoint - a new optional request field timeRestrictions.ownerBusinessUnitGroupId has been added to POST /timeRestrictions/bulk-load endpoint. - a new optional response field timeRestrictions.ownerBusinessUnitGroupId has been added to GET /timeRestrictions endpoint. | 1.3.12 |
| 2023.3 | To support creating, assigning, deactivating Supplier Packages in Retail Management via API, we introduced four new endpoints: - POST /supplierPackagesItems/bulk-load - enables bulk loading of the list of Supplier Package items to Retail Management - POST /supplierPackages/bulk-load - enables bulk loading of the list of Supplier Packages to Retail Management and assigning Supplier Packages to a set of management nodes - GET/supplierPackages - retrieves data and provides details on Supplier Packages - PUT/suppliers/deactivate - deactivates Supplier Packages. To enable assigning Assortments to a set of management nodes in Retail Management via API, we have added the optional response field: assortments.ownerBusinessUnitGroupId to POST /assortments/bulk-load and GET /assortments endpoints | 1.3.12 |
| 2023.3 | We have introduced a solution that helps decipher whether a return is possible at the department and item level - flag indicating if return is allowed. This allows the system to check whether an item (marked as non-refundable) can be returned during a return/refund/fast return to prevent it (isReturnProhibited flag set to true) from being returned. To support this new feature, we added a new attribute: shopItems.salesRestrictions.isReturnProhibited to the following endpoints: - POST /shopitems/bulk-load and POST /departments/bulk - in request. The system allows to import information about whether an item can be returned via department and shop item bulk import, along with other item details. - GET /shopitems and GET /departments - in response. Information about whether the return is allowed is also read out via shop item and department get details, so this parameter is available for external systems to be processed. | 1.3.12 |
| 2023.3 | To enable mapping external codes for items or articles that could be used for integration purposes, we added new response field shopItems.customAttributes to endpoints: POST /shopitems/bulk-load and GET /shopitems. In Vynamic Retail user can setup, open and save custom attributes for items. This possibility allows user to define external codes for items or articles that could be used for integration purposes, for example with car wash machines. | 1.3.12 |
| 2023.3 | To enable creating, assigning, and deactivating products assortment, as well as assigning the assortment to a set of management nodes in Retal Management via API, we introduced five new endpoints: - POST /assortments/bulk-load - supports bulk import of the assortment lists. - POST /assortmentItems/bulkImport - imports list of assortment items in asynchronous way and associates items to the assortment. - POST /assortmentsBusinessUnitGroups/bulk-load - imports list of assortment for business unit groups to VRx in asynchronous way and associates management nodes to the Assortment. - GET /assortments - retrieves data and provides details of assortments from Master Data API. - PUT /assortments/deactivate - deactivates assortments. | 1.3.12 |
| Patch in API 2023.2 | The ESL template can be linked to an item and common to all stores, but the price can also be specific to the store or management node. Depending on the price type, the ESL template can be set at the store level. To support ESL template setting on price type changes we need to import custom attributes via pricelist payload. We introduced this feature with the following changes: - we added prices.customAttributes field to the POST/prices/bulk-load endpoint - we added priceLists.prices.customAttributes field to the POST /prices/bulk-load-async endpoint. The current version of the VRx backend does not use this new field. To use a new field, it is required to use a customized version of the backend that includes this field. | 1.2.2 |
| 2023.2 | To support asynchronous processing and have consistency among all bulk import endpoints in VRx, we introduced two new endpoints: - POST /fuelPrices/bulk-load-async - for fuel items bulk-import - POST /prices/bulk-load-async - for dry-stock items bulk-import Both endpoints ingest data and return the requestId for requesting the import status using the status endpoint. | 1.1.36 |
| 2023.2 | To enable retailers to display the information on shelf label as per defined layout, we have added shopItems.eslLayoutId parameter to POST /items/bulkImport endpoint. The item information provided to the ESL system contains an ESL layout identifier, processed via item bulk import. | 1.1.36 |
| 2023.2 | To have consistency among all bulk import operation endpoints, we have modified the GET /api/status-enquiries/{requestId} endpoint, adding the new response fields: additionalInfo.pending, additionalInfo.successData. | 1.1.36 |