Administration Api
API Contract Update: New Optional Properties Added
New optional response properties were added to the Workstation schema. These appear identically across all returned media types (application/json, text/json, text/plain) and have been consolidated below.
Affected endpoints
-
GET /v1-ext/Workstation -
GET /v1-ext/Workstation/{id}
Affected fields
Response (both endpoints above) — new optional properties under Workstation:
-
fiscalService.fiscalConfiguration.controlUnitParameters.printFiscalDataAsQrCode -
kiosk.kioskLayoutId
Consumer action
No mandatory action is required for existing consumers, since all added properties are optional.
However:
-
Consumers of
GET /v1-ext/WorkstationandGET /v1-ext/Workstation/{id}may start receiving the new optional fieldsprintFiscalDataAsQrCodeandkioskLayoutId. -
If you use strict schema validation or generated models, consider updating them to include these new properties.
Reporting Api
API Contract Update: New Optional Properties Added
New optional response properties were added to the fiscal data returned for orders. This pattern is consistent across all order-related read endpoints.
Affected endpoints
-
POST /v1-ext/Orders -
GET /v1-ext/Orders/getAllAfter/{fromEpoch} -
GET /v1-ext/Orders/getAllAfterByPage/{fromEpoch} -
GET /v1-ext/Orders/getAllInDateRange -
GET /v1-ext/Orders/getAllPaidAfter/{fromEpoch} -
GET /v1-ext/Orders/getByReceiptId/{receiptId} -
GET /v1-ext/Orders/{orderId}
Affected fields
Response (all endpoints above) — new optional properties under fiscalData:
-
fiscalReceiptTexts -
machineReadableCode
Consumer action
No mandatory action is required for existing consumers, since all added properties are optional.
However:
-
Consumers of any of the endpoints listed above may start receiving the new optional fields
fiscalReceiptTextsandmachineReadableCodewithinfiscalData. -
If you use strict schema validation or generated models, consider updating them to include these new properties.
No Changes Detected
The following APIs had no contract changes between Production and Release:
-
Accounting Api
-
Catalog Api v1
-
Catalog Api v2
-
Customership Api
-
GiftCards Api
-
Orders Api
-
Receipts Api
-
Stock Handling Api v1
-
Stock Handling Api v2
-
Webhooks Api