List of breaking changes introduced to the VRP APIs

2025.1, 2024.2_SP5, 2024.2_SP4, 2024.2_SP3

Changed data types for parameters:

• We changed the data type from long to string in the response for operatorUserRoleNumber, loyaltyInfo.approverId, and authorizedBy.approverUserRoleNumber fields in the GET /documents/unified endpoint.
• We changed the data type from long to string in the response for operatorUserRoleNumber, loyaltyInfo.approverId, and authorizedBy.approverUserRoleNumber fields in the GET /documents/unified/{ctrTransactionId} endpoint.
• We changed the data type from long to string in the response for operatorUserRoleNumber, loyaltyInfo.approverId, and authorizedBy.approverUserRoleNumber fields in the POST /documents/unified-list endpoint.

Impacted endpoints:

• GET /documents/unified
• GET /documents/unified/{ctrTransactionId}
• POST /documents/unified-list

2025.1, 2024.2_SP4, 2024.2_SP3

Changed data types for parameters:

• We changed the data type from numbers to array of long in the request id field. It was changed from int32 to int64 in the
  GET /timeRestrictions endpoint.
• We changed the data type from numbers to long in the response id field. It was changed from int32 to int64 in the
  GET /timeRestrictions endpoint.

Impacted endpoints:

• GET /timeRestrictions

2025.1, 2024.2_SP4

Changed data types for parameters:

• We changed the data type from integer to string in the request id field in the POST users/bulk-load endpoint.
• 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.

Impacted endpoints:

• POST /users/bulk-load
• GET /users
• PUT /users/deactivate

2025.1, 2024.2_SP3

Removed: request field shopItems.inventoryAccountingMethodCode

Impacted endpoint:

• POST /shopitems/bulk-load

2025.1, 2024.2_SP3, 2024.3

Deprecated: In order to support Multi-edge and Multi-version (ansible scripts) the existing endpoints are depracated and new ones introduced.

• POST /api/stations/{stationNo}/sqlDb/initialPublication
• POST /api/stations/{stationNo}/multiVersion/restoreEdgeSync
• POST /api/v2/stations/{stationNo}/multiVersion/disableEdgeSync
• GET /stations/locationIdentification

2024.3

Changed data types for parameters:

• We changed the data type from integer(int32) to integer(int64) for methodOfPayments.inquiryNumber field in the GET /methodOfPayments and POST /methodOfPayments/bulk-load endpoint.

Impacted endpoint:

• GET /methodOfPayments
• POST /methodOfPayments/bulk-load

2024.1

Validation 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

New HTTP response code 206: "Partial Content" added.
Impacted endpoints:

• PUT /suppliers/deactivate,
• PUT /taxes/deactivate,
• PUT /timeRestrictions/deactivate

2023.3 SP1

1. Removed: not used properties from the request. Deleted parameters:

• transaction.identifiedCustomer.stampcards.stampcardsToBeRedeemed.*
• transaction.identifiedCustomer.stampcards.stampcardsToBeReleased.*
• transaction.identifiedCustomer.pointsToBeGranted.*
• transaction.identifiedCustomer.stampsToBeGranted.*
• transaction.scannedCoupons.couponsToBeRedeemed.*
• transaction.scannedCoupons.couponsToBeReleased.*
• transaction.couponsAsBenefitToBeGranted.*
• transaction.couponsAsBenefitToBeGranted.*

Impacted endpoints:

• POST /basket/calculation
• POST /basket/finalization

2. Change: Data types for parameters modified

• transaction.identifiedCustomer.grantedPointsToBeVoided.pointsCount
• transaction.redeemedPointsToBeVoided.pointsCount

Impacted endpoint:

• POST /basket/void

2023.3

Resource modification. Changed endpoint path in EAPI, PAPI and SAPI.

Impacted endpoint:

• GET /customers/card/{cardNumber}
  No change on backend side.

2023.2

Change: data type for parameters modified. We have changed data type to the following response fields:

• storedActions.voucherTemplateGettingActions.discountDetail.discountActionType
• storedActions.couponValidityDatesCheckingActions.discountDetail.discountActionType
• toBeFinalizeStoredActions.grantVoucherActions.discountDetail.discountActionType
• toBeFinalizeStoredActions.grantMessageActions.discountDetail.discountActionType

Impacted endpoint:

• POST /basket/calculation

2023.2

Removed request field: movements.currencyId

Impacted endpoint:

• POST /accounts/{id}/movements