A small, additive release. Two APIs have changes, both non-breaking.
Highlights
-
Customership API adds three new customer-messaging fields (
messagingChannel,readyMessages,storageTimeMessages) to the customer-by-ids and customer-filter responses, and removes an unused request schema fromcomponents/schemas(no endpoints affected). -
Administration API adds a POS locale setting (
useCommaAsDecimalSeparatorOnPos) at company level and aselfCheckoutLayoutIdon kiosk workstation configuration.
Administration API
API Contract Update: New Optional Properties Added
New optional properties were added to selected Administration API response schemas.
Affected endpoints
-
GET /v1-ext/Company
-
GET /v1-ext/Workstation
-
GET /v1-ext/Workstation/{id}
Affected fields
Response (GET /v1-ext/Company) Added new optional property under company settings:
-
useCommaAsDecimalSeparatorOnPos
Response (GET /v1-ext/Workstation and GET /v1-ext/Workstation/{id}) Added new optional property under kiosk configuration:
-
selfCheckoutLayoutId
Consumer action No mandatory action is required for existing consumers, since all added properties are optional.
However:
-
Consumers of GET /v1-ext/Company may start receiving
useCommaAsDecimalSeparatorOnPosunder company settings. -
Consumers of GET /v1-ext/Workstation and GET /v1-ext/Workstation/{id} may start receiving
selfCheckoutLayoutIdunder kiosk configuration.
If you use strict schema validation, generated models, or explicit request/response mappings, consider updating them to include these new properties.
Customership API
API Contract Update: New Customer-Messaging Fields Added
Three new optional properties were added to customer response payloads across two endpoints. They appear together on each customer item and represent a related customer-messaging feature.
Affected endpoints
-
POST /v1-ext/Customers/byIds
-
GET /v1-ext/Customers/filter
Affected fields
Response (POST /v1-ext/Customers/byIds) Added new optional properties on each customer under /items:
-
messagingChannel
-
readyMessages
-
storageTimeMessages
Response (GET /v1-ext/Customers/filter) Added new optional properties on each customer under customers/items:
-
messagingChannel
-
readyMessages
-
storageTimeMessages
Consumer action No mandatory action is required for existing consumers, since all added properties are optional.
However:
-
Consumers of POST /v1-ext/Customers/byIds and GET /v1-ext/Customers/filter may start receiving the three new fields on each customer.
If you use strict schema validation, generated models, or explicit request/response mappings, consider updating them to include these new properties.
Schema Cleanup: CustomerApiRequestModel Removed from Components
The request schema Customership.Api.ApiModels.CustomerApiRequestModel was removed from components/schemas.
Scope
-
No endpoints still referenced this schema at the time of removal, so no request or response contract is affected on the wire.
Consumer action No action is required for consumers of the public API endpoints.
However:
-
Teams that generate client code directly from the OpenAPI document, or that imported the
CustomerApiRequestModeltype by name from a generated SDK, should regenerate their client bindings so the removed type no longer appears in their codebase.
Services with no changes
The following services have no API contract changes in this release:
-
Accounting API
-
Catalog API v1
-
Catalog API v2
-
GiftCards API
-
Orders API
-
Receipts API
-
Reporting API
-
Stock Handling API v1
-
Stock Handling API v2
-
Webhooks API