This document lists breaking changes introduced across VRP APIs by release version.
A breaking change requires consumers to update their integration to maintain compatibility.
2026.2 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes:
- To update station and management node names per the HIDM template, we adjusted the DTO to fetch extra fields. As a result, we are introducing a new version of the public API for the:
- Master Data API: v4
- We changed the fields
OwnerNodeName(string) toOwner(object) andSharedNodeName(string) toReceiver(object) in BusinessUnitDto for the GET /businessContracts endpoint. - We changed the fields
StationNumber(integer),StationName(string),StationDisplayName(string), andStationDescription(string) toStation(object) in BusinessUnitDto for the GET /posConfig endpoint.
Impacted endpoints:
- GET /businessContracts
- GET /posConfig
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes:
- The API client can save any master data entity (for example, Item Tare) in multiple languages.
- We added a new required query parameter
managementNodeNo(integer) in the POST /itemTare and POST /packageUnits endpoints.
Impacted endpoints:
- POST /itemTare
- POST /packageUnits
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Stocks API | v1 |
Changes:
- To update station and management node names per the HIDM template, we adjusted the DTO to fetch extra fields. As a result, we are introducing a new version of the public API for the:
- Stocks API: v2
- We changed the fields
StationDescription(string) andStationNo(integer) toStation(object), andStockOwnerDescription(string) andStockOwnerNo(integer) toOwner(object), in BusinessUnitDto for the POST /stock/state endpoint.
Impacted endpoint:
- POST /stock/state
2024.2-SP5 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes Downported from 2026.2 Release:
- The API client can save any master data entity (for example, Item Tare) in multiple languages.
- We added a new required query parameter
managementNodeNo(integer) in the POST /itemTare and POST /packageUnits endpoints.
Impacted endpoints:
- POST /itemTare
- POST /packageUnits
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Central Transaction Repository API | v3 |
Changes:
- We changed data type for all incoming Numeric strings received from customer to Long values, for further processing in CTR. However, in case of data received as Alphanumeric strings, an error is displayed, denoting - customers will mandatorily have to upgrade to the V3 version for Alphanumeric strings to be processed to unified documents.
Impacted endpoint:
- GET /documents/unified
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| CPaaS - Configuration API, Fiscal API and Transactions API | v2 |
Changes:
- To enhance resiliency, maintainability, and performance, our internal orchestration has been updated to utilize new CPaaS services. This change in orchestration logic does not require a contract modification, making it a non-breaking change in that regard. However, it is considered a breaking change concerning Multiversion compatibility. As a result, we are introducing a new version of the public API: V2.
Impacted endpoints:
Transactions API:
POST /transactions/basket/start
POST /transactions/basket/total
POST /transactions/basket/payment
POST /transactions/basket/finish
POST /transactions/basket/abort
POST /transactions/basket/item
POST /transactions/cashflow/start
POST /transactions/cashflow/finish
POST /transactions/cashflow/abort
POST /transactions/miscellaneous/start
POST /transactions/miscellaneous/finish
POST /transactions/miscellaneous/abort
GET /healthCheckFiscal API:
POST /sessions/start
POST /sessions/finish
GET /sessions
GET /clients
GET /customers
POST /customers/validate
POST /printouts/reprint
POST /printouts/non-fiscal
POST /printouts/report
GET /printouts/report/status/{reportId}
GET /printouts/report/{reportId}
POST /maintenance/operation
GET /healthCheck
POST /clients/events
POST /proforma/processConfiguration API:
GET /regions
GET /regions/{regionCode}
GET /regionalSettings/{regionCode}
GET /taxes/{regionCode}
GET /restrictions/{regionCode}
GET /fiscalIntegrations/{regionCode}
GET /cashPaymentLimits/{regionCode}
GET /reports/{regionCode}
GET /payments/{regionCode}
GET /reports
GET /documents/{regionCode}
GET /derivativeDocuments
GET /derivativeDocuments/{regionCode}
GET /regionalCertificates/{regionCode}
GET /regionalCertificates/{regionCode}/download
GET /printforms
GET /healthCheck
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Central Transaction Repository API | v3 |
Changes:
- We changed the data type from long to string in the response for
operatorUserRoleNumber,loyaltyInfo.approverId, andauthorizedBy.approverUserRoleNumberfields in theGET /documents/unifiedendpoint. - We changed the data type from long to string in the response for
operatorUserRoleNumber,loyaltyInfo.approverId, andauthorizedBy.approverUserRoleNumberfields in theGET /documents/unified/{ctrTransactionId}endpoint. - We changed the data type from long to string in the response for
operatorUserRoleNumber,loyaltyInfo.approverId, andauthorizedBy.approverUserRoleNumberfields in thePOST /documents/unified-listendpoint.
Impacted endpoints:
- GET /documents/unified
- GET /documents/unified/{ctrTransactionId}
- POST /documents/unified-list
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes:
- We changed the data type from numbers to array of long in the request
idfield. It was changed from int32 to int64 in theGET /timeRestrictionsendpoint. - We changed the data type from numbers to long in the response
idfield. It was changed from int32 to int64 in theGET /timeRestrictionsendpoint.
Impacted endpoints:
- GET /timeRestrictions
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes:
- We changed the data type from integer to string in the request
idfield in thePOST users/bulk-loadendpoint. - We changed the data type from array[integer] to array[string] in the request
idfield and the responseidfield (from integer to string) in theGET /usersendpoint. - We changed the data type from array[integer] to array[string] in the request
idfield in thePUT /users/deactivateendpoint.
Impacted endpoints:
- POST /users/bulk-load
- GET /users
- PUT /users/deactivate
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes:
- We removed the request field
shopItems.inventoryAccountingMethodCodefrom the POST /shopitems/bulk-load endpoint.
Impacted endpoint:
- POST /shopitems/bulk-load
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes:
- We changed the data type from integer (int32) to integer (int64) for
methodOfPayments.inquiryNumberfield in the GET /methodOfPayments and POST /methodOfPayments/bulk-load endpoints.
Impacted endpoints:
- GET /methodOfPayments
- POST /methodOfPayments/bulk-load
2024.2-SP3 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes Downported from 2026.2 Release:
- The API client can save any master data entity (for example, Item Tare) in multiple languages.
- We added a new required query parameter
managementNodeNo(integer) in the POST /itemTare and POST /packageUnits endpoints.
Impacted endpoints:
- POST /itemTare
- POST /packageUnits
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Central Transaction Repository API | v3 |
Changes Downported from 2024.2-SP5 Release:
- We changed the data type from long to string in the response for
operatorUserRoleNumber,loyaltyInfo.approverId, andauthorizedBy.approverUserRoleNumberfields in theGET /documents/unifiedendpoint. - We changed the data type from long to string in the response for
operatorUserRoleNumber,loyaltyInfo.approverId, andauthorizedBy.approverUserRoleNumberfields in theGET /documents/unified/{ctrTransactionId}endpoint. - We changed the data type from long to string in the response for
operatorUserRoleNumber,loyaltyInfo.approverId, andauthorizedBy.approverUserRoleNumberfields in thePOST /documents/unified-listendpoint.
Impacted endpoints:
- GET /documents/unified
- GET /documents/unified/{ctrTransactionId}
- POST /documents/unified-list
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes Downported from 2024.2-SP5 Release:
- We changed the data type from numbers to array of long in the request
idfield. It was changed from int32 to int64 in theGET /timeRestrictionsendpoint. - We changed the data type from numbers to long in the response
idfield. It was changed from int32 to int64 in theGET /timeRestrictionsendpoint.
Impacted endpoints:
- GET /timeRestrictions
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v3 |
Changes Downported from 2024.2-SP5 Release:
- We removed the request field
shopItems.inventoryAccountingMethodCodefrom the POST /shopitems/bulk-load endpoint.
Impacted endpoint:
- POST /shopitems/bulk-load
2024.1 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Marketing API | v2 |
Changes:
- More restricted validation are implemented on backend side to ensure an offer cannot be added outside of the promotion or campaign validity period.
Impacted endpoints:
- POST /offers,
- PUT /offers/external/{offerExternalId},
- PUT /offers,
- POST /campaigns/{offerId},
- PUT /campaigns/{campaignId}
2023.3_SP2 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Master Data API | v2 |
Changes:
- We added the new HTTP response code 206: Partial Content.
Impacted endpoints:
- PUT /suppliers/deactivate,
- PUT /taxes/deactivate,
- PUT /timeRestrictions/deactivate
2023.3 SP1 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Promotions API | v5 |
Changes:
- We removed the following parameters which are not used from the request contract:
transaction.identifiedCustomer.stampcards.stampcardsToBeRedeemedtransaction.identifiedCustomer.stampcards.stampcardsToBeReleasedtransaction.identifiedCustomer.pointsToBeGrantedtransaction.identifiedCustomer.stampsToBeGrantedtransaction.scannedCoupons.couponsToBeRedeemedtransaction.scannedCoupons.couponsToBeReleasedtransaction.couponsAsBenefitToBeGrantedtransaction.couponsAsBenefitToBeGranted
Impacted endpoints:
- POST /basket/calculation
- POST /basket/finalization
Changes:
- We modified the data types for the following parameters:
transaction.identifiedCustomer.grantedPointsToBeVoided.pointsCounttransaction.redeemedPointsToBeVoided.pointsCount
Impacted endpoint:
- POST /basket/void
2023.3 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Customers API | v3 |
Changes:
- We changed the endpoint path in EAPI, PAPI, and SAPI.
Impacted endpoint:
- GET /customers/card/{cardNumber}
No change on backend side.
2023.2 Release
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Promotions API | v4 |
Changes:
- We changed the data type to the following response fields:
storedActions.voucherTemplateGettingActions.discountDetail.discountActionTypestoredActions.couponValidityDatesCheckingActions.discountDetail.discountActionTypetoBeFinalizeStoredActions.grantVoucherActions.discountDetail.discountActionTypetoBeFinalizeStoredActions.grantMessageActions.discountDetail.discountActionType
Impacted endpoint:
- POST /basket/calculation
| API | Major Version to which the Breaking Change was introduced |
|---|---|
| Customers API | v2 |
Changes:
- We removed the following request field:
movements.currencyId
Impacted endpoint:
- POST /accounts/{id}/movements