Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Additional companyContactPropagation settings were added to define how company contact assignments are propagated within a company hierarchy.
UPWARD – an existing setting that is set as default one, propagation from subsidiaries to parent
DOWNWARD – new, propagation from parent to subsidiaries
DISABLED – new, no propagation
Propagation occurs only at the moment of assignment: creating a contact in one company also creates corresponding contacts in related companies based on the configured direction.
There are no known problems.
New property was added to orderEntryCalculatedPrice.price:
calculated:INTERNAL/EXTERNAL - indicates how the line item price was determined.
INTERNAL — means the calculation was done by Emporix using unit price × quantity.
EXTERNAL — means the calculation was done externally with lineTax
There are no known problems.
A new customerId query parameter has been added to the customer segments retrieval endpoints. This parameter allows you to retrieve customer segments for a specific customer. The parameter can only be used with the customersegment.segment_read scope.
There are no known problems.
See what we are currently working on.
You can expect some changes in the nearest future regarding the workings of the mentioned services.
These announcements are intended to keep you informed about ongoing work and potential updates to the Emporix services. They do not guarantee new functionality. Please note that these updates are subject to change. Our goal is to provide you with this information so that you can consider it in your implementation and enablement plans.
Category tree endpoints now support filtering by category IDs. When the category IDs are provided, only category trees that include at least one of the specified categories are returned.
There are no known problems.
Find out what has been recently changed in the Emporix system.
- new feature
- improvement
- major change
- minor change
- deprecation
Cart Service now supports applying external discounts directly at the cart level. This enables external systems (such as ERP systems) to apply cart-wide discounts that are calculated outside of Commerce Engine.
New attribute added to cart:
externalDiscounts - an array of external discounts that can be applied to the entire cart, similar to how external discounts can be applied at the item level
This update introduces support for initial passwords when creating customers. A new password field is now available during customer creation, allowing you to set an initial password for new customer accounts. Additionally, the login response now includes the initialPassword flag that indicates whether the customer logged in using their initial password, enabling you to prompt users to change their password on first login.
Added customerId query parameter.
Added customerId query parameter.
VSM
Improvements of features
Schema Service Product Service Category Service
Classification categories
Product Service
Product variants
AI Service
Agentic improvements
Added categoryIds query parameter.
New endpoint for searching category trees, which accepts categoryIds in the request body.
The refIds.type field now accepts custom schema types.
The refIds.type field now accepts custom schema types.
Added q param support.
Added q param support.
The SITE schema type has been added and can now be used in the request body.
The SITE schema type has been added and can now be used in the request body.
schema.order-created
New fields vendor,masterOrder,splitInfo added
schema.order-updated
New fields vendor,masterOrder,orderType,splitInfo,subOrders,splitBy added
ai.agent-job-finished
The event is emitted when asynchronous agent chat is called.
schema.custom-instance-created
The event is emitted when custom instance is created. The type of the custom instance is present in the payload.
schema.custom-instance-updated
The event is emitted when custom instance is updated. The type of the custom instance is present in the payload.
schema.custom-instance-deleted
The event is emitted when custom instance is deleted. The type of the custom instance is present in the payload.
When showUnpublished=false is set in the query parameters, trees with an unpublished root node are not returned.
When showUnpublished=false is set in the query parameters, trees with an unpublished root node are not returned.
New endpoint that allows searching for orders with a request body.





It allows retrieving a list of agent request logs with pagination, sorting, and filtering support.
It allows retrieving a single agent request log by its ID.
It allows searching for agent request logs based on the provided query.
It allows retrieving a list of agent session logs with pagination, sorting, and filtering support.
It allows retrieving a single agent session log by its ID, including all associated log messages.
It allows searching for agent session logs based on the provided query.
There are no known problems.
customerSegmentIds – IDs of customer segments assigned to the product.
categoryIds – IDs of categories assigned to the product.
Both attributes are read-only, available only in product retrieval responses as they are populated automatically when category or customer segment assignment is created. Currently, they remain in preview mode as they are not fully operational yet.
Added customerSegmentIds and categoryIds attributes to the response.
Added customerSegmentIds and categoryIds attributes to the response.
Added customerSegmentIds and categoryIds attributes to the response.
There are no known problems.
New LLM provider is supported: self_hosted_vllm.
New LLM provider is supported: self_hosted_vllm.
New LLM provider is supported: self_hosted_vllm.
New LLM provider is supported: self_hosted_vllm.
New LLM provider is supported: self_hosted_vllm.
There are no known problems.
New streamable_http transport protocol is supported.
New streamable_http transport protocol is supported.
New streamable_http transport protocol is supported.
New streamable_http transport protocol is supported.
There are no known problems.
Endpoint for triggering reindexing process.
Endpoint for retrieving possible fields destined for computing embeddings.
Endpoint for retrieving fields destined to filtering database entries.
There are no known problems.
Each external discount includes:
id - unique identifier of the external discount
discountType - type of discount: PERCENT, ABSOLUTE, or FREE_SHIPPING
value - the discount value (percentage for PERCENT type, or monetary amount for ABSOLUTE type)
discountCalculationType - determines how the discount is applied:
TOTAL - discount is spread across products, product fees, and shipping cost
SUBTOTAL - discount is spread across products only, without fees or shipping
sequence - defines the order in which multiple discounts are applied
Applying external discounts to a cart requires the cart.cart_manage_external_prices scope.
The externalDiscounts attribute has been added.
The externalDiscounts attribute is included in the response.
There are no known problems.
New endpoint that allows searching for customers with a request body.
There are no known problems.
New endpoint that retrieves the specified legal entity and all parent legal entities in the hierarchy.
There are no known problems.
New assignment type has been added: Contact. This is now the default value.
New contact type and validation added - customer can be assigned only once to the legal entity.
New contact type and validation added - customer can be assigned only once to the legal entity.
There are no known problems.
The SSE transport protocol is deprecated.
The SSE transport protocol is deprecated.
The SSE transport protocol is deprecated.
The SSE transport protocol is deprecated.
There are no known problems.
New attribute password added.
New attribute initialPassword added to the response.
There are no known problems with the current implementation.
New service for vendors management vendor locations added.
There are no known problems.
availability.availability_manage_by_vendor
availability.availability_view_by_vendor
New attribute vendorId added to response. New scope availability.availability_view_by_vendor added.
New attribute vendorId added to response. New scope availability.availability_view_by_vendor added.
New attribute vendorId added to response. New scope availability.availability_view_by_vendor added.
New scope availability.availability_manage_by_vendor added.
New scope availability.availability_manage_by_vendor added.
New scope availability.availability_manage_by_vendor added.
There are no known problems.
New attribute vendor added in the response on item's product.
New attribute vendor added in the response on item's product.
New attribute vendor added in the response on item's product.
New attribute vendor added in the response on item's product.
There are no known problems.
product.product_read_by_vendor
product.product_manage_by_vendor
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
There are no known problems.
Creating a media
Endpoint removed. Previous documentation under is no longer available.
Deleting a media
Endpoint removed. Previous documentation under is no longer available.
The image and cloudinaryUrl fields removed from request body.
The image and cloudinaryUrl fields removed from request body.
The image and cloudinaryUrl fields removed from request body.
There are no known problems.
The Category Service has been enhanced with a new search endpoint that allows searching for categories using a request body. Additionally, the existing GET categories endpoint now supports the q query parameter for filtering results.
There are no known problems.
Price lists can now be assigned to specific legal entities. When a price list is assigned to a legal entity, it automatically applies to all its subsidiaries as well.
New field legalEntityId has been added to:
Price list – to assign price lists to specific legal entities
Price match – to include price lists resctricted to legal entity during price matching
There are no known problems.
All previously deprecated endpoints are now removed (2025-04-04: Sequential ID Service - deprecations).
There are no known problems.
New attribute added to cart:
quoteId - this field contains the ID of the quote associated with the cart
When a quote is created from a cart using the Creating a quote endpoint, the cart is automatically closed and the quoteId is set on that cart. This ensures proper traceability between carts and their corresponding quotes.
There are no known problems.
A new attribute vendorId has been added to the group entity. The attribute is used to identify the vendor that owns the group and can be set only when a group is created. New endpoints that return users that belong to vendor have been added.
There are no known problems.
New field vendorId was added to the asset response payload. With the new scopes, vendor employees can now manage and view assets for products that belong to their vendor.
media.asset_manage_by_vendor
media.asset_read_by_vendor
There are no known problems.
Two new attributes have been added to cart item:
linePrice - externally calculated total price for the item line (unit price × quantity)
lineTax - externally calculated total tax for the item line, allowed only for external product type
New property was added to itemCalculatedPrice.price:
calculated:INTERNAL/EXTERNAL - indicates how the line item price was determined.
INTERNAL — means the calculation was done by Emporix using unit price × quantity.
EXTERNAL — means the calculation was done externally with lineTax
There are no known problems.
The calculatedPrice of Order Service has been enriched with new fields:
totalDiscounts has a new price field that contains all price details
appliedDiscounts has a new price field that contains all price details
The calculatedPrice or cart level has new fields
shipping price before discounts
fees price before discounts
There are no known problems.
All previously deprecated endpoints and fields are now removed (2025-03-04: Brand Service - deprecations).
There are no known problems.
The Schema Service has been enhanced with support for references. These updates include:
New REFERENCE mixin schema attribute type for custom schema types, allowing references to products, orders, carts, customers, media, prices, price lists, customer segments, categories and other custom schema types.
The cart service now allows adding items to cart as separate lines. This means the same product can appear in the cart multiple times, enabling you to apply external discounts or fees to individual items. To add item as a separate line, specify keepAsSeparateLine property in the Adding a product to cart request.
New endpoint that allows searching for categories with a request body.
Added support for the standard q query parameter to filter categories.
New attribute legalEntityId added to request payload.
New attribute legalEntityId added to request payload.
New attribute legalEntityId added to request payload.
New attribute legalEntityId added to response.
New attribute legalEntityId added to response.
Retrieving all schemas
Endpoint removed. Previous documentation under Retrieving all schemas is no longer available. Please use this endpoint instead.
Creating a schema
Endpoint removed. Previous documentation under Creating a schema is no longer available. Please use this endpoint instead.
Creating a nextId
Endpoint removed. Previous documentation under Creating a nextId is no longer available. Please use this endpoint instead.
New attribute quoteId added.
New attribute quoteId added.
New attribute quoteId added.
New attribute quoteId added.
New reference type MODULE has been added.
New reference type MODULE has been added.
New reference type MODULE has been added.
New reference type MODULE has been added.
The attribute vendorId has been added.
The attribute vendorId has been added.
New endpoint that return's list of users belonging to the vendor
New attribute vendorId added to response. New scope media.asset_read_by_vendor added.
New attribute vendorId added to response. New scope media.asset_read_by_vendor added.
New scope media.asset_manage_by_vendor added.
New scope media.asset_manage_by_vendor added.
New scope media.asset_manage_by_vendor added.
New scope media.asset_read_by_vendor added.
The linePrice and lineTax attributes have been added.
The linePrice and lineTax attributes have been added.
The linePrice and lineTax attributes have been added in the response.
The linePrice and lineTax attributes have been added in the response.
The calculatedPrice attribute has been enriched in order and order entries.
The calculatedPrice attribute has been enriched in order and order entries.
The calculatedPrice attribute has been enriched in order and order entries responses.
The calculatedPrice attribute has been enriched in order and order entries responses.
Creating a media
Endpoint removed. Previous documentation under Creating a media is no longer available.
Deleting a media
Endpoint removed. Previous documentation under Deleting a media is no longer available.
The image and cloudinaryUrl fields removed from request body.
The image and cloudinaryUrl fields removed from request body.
The image and cloudinaryUrl fields removed from request body.
Tools of RAG_EMPORIX and RAG_CUSTOM types have been introduced.
Tools of RAG_EMPORIX and RAG_CUSTOM types have been introduced.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New attribute vendor added.
New validateReferences query parameter to control reference validation during create, upsert, and patch operations.
New expand query parameter to retrieve expanded reference data.
New media field in custom instance responses containing IDs of media assigned to the custom instance.
Added validateReferences query parameter.
Added validateReferences query parameter.
Added validateReferences query parameter.
Added validateReferences query parameter.
Added validateReferences query parameter.
Added expand query parameter for fetching expanded references. Added media field to the response.
There are no known problems.
Added the keepAsSeparateLine attribute.
Added the keepAsSeparateLine attribute.
Quotes do not support separate line items yet.
Added a new API for importing and exporting AI agents and improved the existing APIs.
Extended the jobs API with new fields: type, exportResult, and importResult.
Introduced a force query parameter for the delete endpoints of agents, tools, tokens, and MCP servers.
Added the enabled field to the responses of tools and MCP servers.
There are no known problems.
Cart Service now supports comprehensive address management directly on the cart object. This enhancement allows you to specify billing and shipping addresses that are used for tax determination and shipping cost calculation.
New attribute added to cart:
addresses - an array of addresses associated with the cart
Each address can include the following properties:
type - address type: BILLING or SHIPPING
contactName - contact name for the address
companyName - company name
When addresses are not explicitly provided in the request, the Cart Service automatically populates them based on the following priority order:
Legal Entity Address - If the cart is associated with a legal entity, the first location with both country,zip-code and required address type is used (origin: LEGAL_ENTITY).
Customer Address - If the cart has a logged-in customer, the default address matching the required type is used (origin: CUSTOMER).
Addresses provided in the request are marked with origin REQUEST in the response.
For backward compatibility the legal entity address population has to be enabled in the tenant settings: enableLegalEntityAddressFallbackInCart. It is enabled by default for all new tenants.
The addresses specified on the cart are used for:
Tax determination - The appropriate tax country is determined based on the billing or shipping address, as configured in the site's taxDeterminationBasedOn setting.
Shipping cost calculation - The shipping address is used to calculate accurate shipping costs based on the destination.
For more details, see:
The existing countryCode and zipCode parameters at the cart level are still supported for backward compatibility. However, the new addresses array provides a more comprehensive and flexible approach to address management.
There are no known problems.
All previously deprecated endpoints are now removed (2025-03-28: Coupon Service - deprecations).
There are no known problems.
The Quote Service has been extended to support external prices and mixins on product and item levels. This enhancement allows for more flexible quote management with custom pricing and additional product metadata.
Key changes:
A product can be added to quote more than once
Added support for the quote creation from carts with external products and prices
Added support for external prices with the type field (INTERNAL/EXTERNAL) on price objects
Added mixins and metadata support on both product and item levels
Added new scope requirement cart.cart_manage_external_prices for external prices
Extended PATCH operations to support mixin updates on items and products
Added the id field to media objects
Prices can now be defined as INTERNAL - from Emporix Price Service, or EXTERNAL - as custom prices. The type field on price objects indicates the price type:
INTERNAL: Price is fetched from the Emporix Price Service using priceId, which is a required value.
EXTERNAL: Custom price is provided directly in the request, where priceId is not required.
Products can now be defined as INTERNAL - from Emporix Price Service, or EXTERNAL - as custom products. For external products:
The name field can be provided as a localized map
The media object can be provided with the id, contentType, and url fields
Mixins and metadata can now be added to:
Quote items
Products within quote items
Quote level (already supported)
PATCH operations support adding, replacing, and removing mixin values at all these levels.
There are no known problems.
The Logging in a customer and Refreshing a customer token endpoints of Customer Service now return the additional field:
session_id - Customer email used to login (generate the token).
There are no known problems.
New endpoints have been introduced to retrieve orders for a legal entity. These endpoints allow fetching multiple orders or a specific order associated with a legal entity. The response structure remains identical to the existing order retrieval endpoints for tenants and customer-managed orders.
There are no known problems.
All deprecations will be removed on 2025-10-01. From now, use the new referral coupons endpoints to referral coupons.
There are no known problems.
The Validate a token endpoint of Oauth service returns now two additional fields:
email - Customer email used to login (generate the token).
legalEntityId - Legal Entity Id.
There are no known problems.
An optional legalEntityId query parameter has been introduced to the endpoint. This is the recommended way to store information about the selected legal entity in the system. Upon logging in, users should select a legal entity they want to act on behalf of. It invokes the refresh token endpoint with the chosen entity. If the value is provided in the request, the validation process ensures that the customer is assigned to the specified legal entity.
There are no known problems.
From now on, the response of the "Retrieving category trees for a customer segments" endpoint includes new fields: localizedDescription, localizedSlug, ecn, validity, position, and published, which allows fetching complete category tree information in a single request.
There are no known problems.
When applying discount on a cart, the request allows to specify calculationType with following values: ApplyDiscountBeforeTax, ApplyDiscountAfterTax The field has been deprecated, cart's calculatedPrice relays on site's configuration includesTax which defines whether the discount should be applied on net or gross prices.
There are no known problems.
We are committed to ensuring the highest level of security for our API services. As part of this commitment, we are discontinuing support for weak cryptographic ciphers (api.emporix.io).
This update is essential to maintain the security and integrity of the data exchanged between your systems and our API.
Effective 24th of March, we will no longer support the following cipher suites:
The metadata field at root level is now deprecated in GET responses, as each shopping list now maintains its own independent metadata field. This field will be fully removed on September 1st, 2025. Additionally we have added version validation for update operation where you can provide version in the update payload to validate it against the current entity version, preventing unintentional overriding when multiple updates occur simultaneously.
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
These cipher suites rely on older encryption methods that are vulnerable to modern security threats. To ensure the highest level of security and compatibility, we will continue supporting strong ciphers, including TLS 1.2 and TLS 1.3 protocols.
Ensure that your systems and applications are configured to use the following ciphers:
TLSv1.2:  ciphers:    TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (ecdh_x25519)    TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (ecdh_x25519)    TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (ecdh_x25519)
TLSv1.3:  ciphers:    TLS_AKE_WITH_AES_128_GCM_SHA256 (ecdh_x25519)    TLS_AKE_WITH_AES_256_GCM_SHA384 (ecdh_x25519)    TLS_AKE_WITH_CHACHA20_POLY1305_SHA256 (ecdh_x25519)
vendor.vendor-created
The event is emitted when vendor instance is created.
vendor.vendor-updated
The event is emitted when vendor is updated.
vendor.vendor-deleted
The event is emitted when vendor is deleted.
There are no known problems.
There are no known problems.
Added the type field to price and product objects.
Added the cart.cart_manage_external_prices scope for external prices.
Added mixins and metadata support on item and product levels.
Added the name and media fields for external products.
Added the type field to price and product objects in response.
Added mixins and metadata to item and product objects.
Added the id field to media object.
Added the id field to media object in response.
Added support for mixin operations with new paths: /items/{itemId}/mixins/{mixinsPath}, /items/{itemId}/metadata/mixins/{mixinsPath}, /items/{itemId}/product/mixins/{mixinsPath}, /items/{itemId}/product/metadata/mixins/{mixinsPath}.
Added the session_id field in response.
Added the session_id field in response.
Retrieves a list of orders related to a particular legal entity for a customer. To be used by B2B customers on the storefront.
Retrieves an order related to a particular legal entity for a customer. To be used by B2B customers on the storefront.
Endpoint will be removed and moved under /coupon/{tenant}/referral-coupons/{customerNumber}.
Endpoint will be removed and moved under /coupon/{tenant}/referral-coupons/{customerNumber}.
Field businessModel added to the response.
Field businessModel added to the response.
New property referralCoupon added to the response.
New property referralCoupon added to the response.
Added the email and legalEntityId fields in response.
The endpoint extended with an optional legalEntityId query param.
New endpoint has been added.
Endpoint will be removed. Please use /product/{tenant}/products/search instead.
Added validation of taxCode fee is marked with taxable=true
Added validation of taxCode fee is marked with taxable=true
Request body's refIds.type field has a new enum value - BRAND.
Request body's refIds.type field has a new enum value - BRAND.
Added localizedDescription, localizedSlug, ecn, validity, position, and published fields to the responses.
Deprecated request attribute calculationType
New endpoint has been added.
street - street name
streetNumber - street number
streetAppendix - additional street information
zipCode - postal/zip code
city - city name
country - two-letter country code (ISO 3166)
SITEThe addresses attribute has been added to the request body.
The addresses attribute has been added to the request body.
The addresses attribute with origin information is included in the response.
Added expand query parameter for fetching expanded references. Added media field to the response.
Added expand query parameter for fetching expanded references. Added media field to the response.
The REFERENCE attribute type is now available for custom schema types.
The REFERENCE attribute type is now available for custom schema types.
New force query parameter has been added which allows you to delete custom MCP server which is used by agents.
New enabled field has been added to the Tool response.
New enabled field has been added to the Tool response.
New enabled field has been added to the Tool response.
New enabled field has been added to the Tool payload.
New enabled field has been added to the Tool payload.
New enabled field has been added to the MCP server response.
New enabled field has been added to the MCP server response.
New enabled field has been added to the MCP server response.
New enabled field has been added to the MCP server payload.
New enabled field has been added to the MCP server payload.
It allows importing AI agents.
It allows exporting AI agents.
New fields have been added to the job response: type, 'exportResult' and importResult.
New fields have been added to the job response: type, 'exportResult' and importResult.
New fields have been added to the job response: type, 'exportResult' and importResult.
New force query parameter has been added which allows you to delete agent which is used as collaboration agent.
New force query parameter has been added which allows you to delete tool which is used by agents.
New force query parameter has been added which allows you to delete token which is used by agents, tools or MCP servers.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.
New attribute cartId added.
New attribute cartId added.
New attribute cartId added.
New attribute cartId added.
New attribute cartId added.
New attribute cartId added.
New attribute cartId added.
New attribute cartId added.
Added the externalDiscounts attribute.
Added the externalDiscounts attribute.
Added the externalDiscounts attribute.
There are no known problems.
Added the entryId attribute.
There are no known problems.
New attribute orderId added.
New attribute orderId added.
New attribute orderId added.
There are no known problems.
appliedDiscounts has a new price field that contains all price details
The calculatedPrice or cart level has new fields:
shipping price before discounts
fees price before discounts
The calculatedPrice attribute has been enriched in cart and cart items responses.
The calculatedPrice attribute has been enriched in cart and cart items responses.
The calculatedPrice attribute has been enriched in cart and cart items responses.
There are no known problems.
The new query parameter q has been added.
There are no known problems.
For every legal entity, three new customer groups have been created: Admin, Buyer, and Requester.
All users have been reassigned to the appropriate new groups based on their roles and legal entity relationships.
Users without a specific legal entity have been assigned to a default customer group to ensure continued access.
These changes make it easier to manage user permissions and roles within your organization.
Customer Groups
New Admin, Buyer, and Requester groups created for every legal entity.
User Assignments
Users reassigned to the correct new groups according to their roles.
Fallback Assignment
Users without a legal entity assigned to the default customer group for continuity.
There are no known problems.
For more information, see the following pages:
Endpoint will be removed.
Endpoint will be removed.
The image and cloudinaryUrl fields will be removed from request body.
The image and cloudinaryUrl fields will be removed from request body.
The image and cloudinaryUrl fields will be removed from request body.
There are no known problems.
New request attribute legalEntityId added.
New request attribute legalEntityId added.
New request attribute legalEntityId added.
New response attribute legalEntityId added.
New response attribute legalEntityId added.
There are no known problems.
Deprecated metadata field on root level and added metadata field to each shopping list.
Deprecated metadata field on root level and added metadata field to each shopping list.
Added metadata.version to request payload which allows for version validation
There are no known problems.
Endpoint will be removed.
Endpoint will be removed.
The image and cloudinaryUrl fields will be removed from request body.
The image and cloudinaryUrl fields will be removed from request body.
The image and cloudinaryUrl fields will be removed from request body.
There are no known problems.
A new cart validation endpoint has been added to allow validating a cart without performing any modifications. Additionally, a new configuration setting has been introduced that allows skipping the validation of the existing cart items when a new item is added to the cart. The configuration improves performance for carts that include multiple items.
There are no known problems.
The token responses was improved with new properties compliant with the OAuth 2.0 specification. Properties from the response accessToken, saasToken, expiresIn, refreshToken, refreshTokenExpiresIn are now deprecated in favor of the new properties (access_token, saas_token, expires_in, refresh_token, refresh_token_expires_in, token_type).
All deprecations will be removed on 2025-11-13. From now, use the new token properties.
There are no known problems.
The timezone field has been added to the site.homeBase request and response body. For now, this field is used by the Sequential ID Service to generate fallback values for placeholders such as:
__year__
__month__
__day__
__hour__
__minute__
__second__
There are no known problems.
The Order Service has transitioned to using new calculated price attributes at both order and entry levels. The following changes have been implemented:
New mandatory attributes: calculatedPrice (order level), calculatedPrice and calculatedUnitPrice (entry level).
Previously used price attributes (totalPrice, unitPrice) are now marked as deprecated and optional.
Backward compatibility is maintained - the API will continue to work if deprecated price attributes are provided without the new calculated price attributes.
These changes streamline price handling while ensuring existing integrations continue to function without disruption.
There are no known problems.
Several fields in cart's response have been deprecated and are now replaced by calculatedPrice and unitPrice fields. The new fields provide a more comprehensive and consistent way to access price calculations.
totalPrice - use calculatedPrice.finalPrice instead
subTotalPrice - use calculatedPrice.price or calculatedPrice.discountedPrice instead
taxAggregate
price - use unitPrice instead
itemPrice - use unitPrice instead
itemTaxInfo - use calculatedPrice.price
There are no known problems.
A new boolean attribute weightDependent has been added to the product model. It allows to mark the product as weight-dependent if the line item price can change after packaging. This is necessary to ensure that credit card payments can be authorized. Having the attribute available directly on the product level, the corresponding attribute weightDependent in Adding a product to cart API has been deprecated. The cart services checks the value specified on a product model and sets the weightDependent value on the cart item.
There are no known problems.
New field vendorId was added to the price response payload. With the new scopes, vendor employees can now manage and view prices for products that belong to their vendor.
price.price_manage_by_vendor
price.price_read_by_vendor
There are no known problems.
The IAM Service was updated with validation for assigning customers to predefined groups. This ensures consistent role management within a company (Legal Entity) and provides clearer error handling for invalid assignments.
New validation rules:
A customer can only be assigned to one predefined group (for example Admin, Buyer, Requester) within the same Legal Entity.
Validates cart items' prices.
When cartItemValidationSkipExistingItemsValidationOnAddToCart is set to true, the add to cart does not validate the existing cart items' prices.
cartItemValidationSkipExistingItemsValidationOnAddToCart
Skip existing cart items validation on adding new item to cart.
BOOLEAN
Endpoint will be removed. Please use /sequential-id/{tenant}/schemas instead.
Endpoint will be removed. Please use /sequential-id/{tenant}/schemas instead.
Endpoint will be removed. Please use /sequential-id/{tenant}/schemas/types/{schemaType}/nextId instead.
New properties access_token, saas_token, expires_in, refresh_token, refresh_token_expires_in, token_type added to the response.
New properties access_token, expires_in, refresh_token, refresh_token_expires_in, token_type added to the response.
New properties access_token, saas_token, expires_in, refresh_token, refresh_token_expires_in, token_type added to the response.
The homeBase.timezone field added to the response body.
The homeBase.timezone field added to the response body.
The homeBase.timezone field added to the request body.
The homeBase.timezone field added to the request body.
The homeBase.timezone field added to the request body.
Order level calculatedPrice marked as mandatory and totalPrice marked as optional.
Order entry level calculatedPrice marked as mandatory and totalPrice marked as optional.
Order entry level calculatedUnitPrice marked as mandatory and unitPrice marked as optional.
Order level calculatedPrice marked as mandatory and totalPrice marked as optional.
Order entry level calculatedPrice marked as mandatory and totalPrice marked as optional.
Order entry level calculatedUnitPrice marked as mandatory and unitPrice marked as optional.
calculatedPrice.finalPrice.taxAggregatesubtotalAggregate - use calculatedPrice.price instead
totalDiscount - use calculatedPrice.totalDiscount instead
feeYrnAggregate - use calculatedPrice.totalFees and items[].calculatedPrice.fees instead
shipping - use calculatedPrice.totalShipping instead
itemFeesTotal - use calculatedPrice.totalFee instead
paymentFeesTotal - use calculatedPrice.paymentFees instead
totalAuthorizedAmount - use calculatedPrice.upliftValue instead
fees - use calculatedPrice.fees instead
authorizedAmount - use calculatedPrice.upliftValue instead
totalDiscount - use calculatedPrice.totalDiscount instead
externalFees - use calculatedPrice.fees instead
couponDiscounts - use calculatedPrice.totalDiscounts.appliedDiscounts instead
Deprecated response fields are replaced by calculatedPrice and unitPrice.
Deprecated response fields are replaced by calculatedPrice and unitPrice.
Deprecated response fields are replaced by calculatedPrice and unitPrice.
Request body's refIds.type field has a new enum value - LABEL.
Request body's refIds.type field has a new enum value - LABEL.
Added lastLogin field to the responses.
Added lastLogin field to the responses.
Added lastLogin field to the responses.
New endpoint that allows searching for price lists with a request body.
New request attribute weightDependent added.
New response attribute weightDependent added.
New response attribute weightDependent added.
Deprecated request attribute weightDependent.
Deprecated request attribute weightDependent.
New request attribute weightDependent added.
New request attribute weightDependent added.
New request attribute weightDependent added.
New request attribute weightDependent added.
New scope price.price_manage_by_vendor added.
New attribute vendorId added to response. New scope price.price_read_by_vendor added.
New attribute vendorId added to response. New scope price.price_read_by_vendor added.
New scope price.price_manage_by_vendor added.
New scope price.price_manage_by_vendor added.
New scope price.price_manage_by_vendor added.
New scope price.price_manage_by_vendor added.
__second____country__All date-related placeholders are computed based on the site.homeBase.timezone field.
The country placeholder is replaced with the value of the site.homeBase.address.country field.
If these values are missing in a site configuration, the following defaults are used:
UTC for timezone
DE for country
Query param siteCode added.
Query param siteCode added.
Query param siteCode added.
There are no known problems.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
There are no known problems.
sku
code
productType
name
localizedName
description
images Using information from productService. The data will be populated only if there is no product object passed in the add to cart request.
New attributes localizedName and code added to the product object
New attributes localizedName and code added to the product object
New attributes localizedName and code added to the product object
New attributes localizedName and code added to the item's product object
New attributes localizedName and code added to the item's product object
There are no known problems.
Endpoint previously available under the /coupon/ReferralCouponCode/{customerId} is now available only on /coupon/{tenant}/referral-coupons/{customerNumber}.
Endpoint previously available under the /coupon/ReferralCouponCode/{customerId} is now available only on /coupon/{tenant}/referral-coupons/{customerNumber}.
There are no known problems.
Customers may still be assigned to different groups in different companies (Legal Entities).
The Contact group can always be assigned.
Validation added - a customer can only be assigned to one predefined group in one Legal Entity.
Validation added - a customer can only be assigned to one predefined group in one Legal Entity.
There are no known problems.
Added cartCalculationScale field to the request.
Added cartCalculationScale field to the request.
Added cartCalculationScale field to the request.
Added cartCalculationScale field to the responses.
There are no known problems.
Several fields in order's response have been deprecated in favor of new calculatedPrice and unitPrice fields. The new fields provide a more comprehensive and consistent way to access price calculations.
totalPrice - use calculatedPrice.finalPrice instead
subTotalPrice - use calculatedPrice.price or calculatedPrice.discountedPrice instead
taxAggregate
price - use unitPrice instead
itemPrice - use unitPrice instead
itemTaxInfo - use calculatedPrice.price
There are no known problems.
calculatedPrice.finalPrice.taxAggregatesubtotalAggregate - use calculatedPrice.price instead
totalDiscount - use calculatedPrice.totalDiscount instead
feeYrnAggregate - use calculatedPrice.totalFees and items[].calculatedPrice.fees instead
shipping - use calculatedPrice.totalShipping instead
itemFeesTotal - use calculatedPrice.totalFee instead
paymentFeesTotal - use calculatedPrice.paymentFees instead
totalAuthorizedAmount - use calculatedPrice.upliftValue instead
fees - use calculatedPrice.fees instead
authorizedAmount - use calculatedPrice.upliftValue instead
totalDiscount - use calculatedPrice.totalDiscount instead
externalFees - use calculatedPrice.fees instead
couponDiscounts - use calculatedPrice.totalDiscounts.appliedDiscounts instead
Deprecated response fields in favor of calculatedPrice and unitPrice
Deprecated response fields in favor of calculatedPrice and unitPrice
Deprecated response fields in favor of calculatedPrice and unitPrice
Deprecated response fields in favor of calculatedPrice and unitPrice
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
Endpoint will be removed and moved under the /coupon/ base path.
It creates or updates an agent.
It partially updates an agent.
It deletes an agent.
It retrieves all agent jobs.
It searches for agent jobs.
It retrieves an agent job.
It deletes an agent job.
It retrieves a list of commerce events.
It retrieves all MCP servers.
It searches for MCP servers.
It retrieves an MCP server.
It upserts an MCP server.
It partially updates an MCP server.
It deletes an MCP server.
It retrieves all AI tokens.
It searches for AI tokens.
It retrieves a token by its ID.
It creates or updates an AI token.
It partially updates an AI token.
It deletes an AI token.
It retrieves all AI tools.
It searches for AI tools.
It retrieves an AI tool.
It creates or updates an AI tool.
It partially updates an AI tool.
It deletes an AI tool.
It allows chatting with AI agents.
It allows chatting with AI agents asynchronously.
It retrieves all agent templates.
It searches for agent templates.
It creates a new agent based on the selected template.
It retrieves all agents.
It searches for agents.
It retrieves details of an agent by its ID.
It retrieves a custom instance.
It deletes a custom instance.
It upserts a custom instance.
It partially updates a custom instance.
It searches for custom instances.
It creates custom instances in bulk.
It upserts custom instances in bulk.
It deletes custom instances in bulk.
It creates a new schema type.
It retrieves all custom schema types.
It retrieves a custom schema type.
It deletes a custom schema type.
It upserts custom schema type.
It creates a custom instance.
It retrieves all custom instances.
entries.product.vendor - marks a product as vendor dependent
orderType - populated only for orders involved in the splitting process
masterOrder - the identifier of a master order, available on suborders created after splitting the master order
splitInfo - information based on what was the suborder created
subOrders - list of suborders that were created after splitting the master order
entries.externalFees - list of external fees applied on entry level
A new endpoint that allows to split an order has been added.
New attributes added.
New attributes added.
New attributes added.
New attributes added.
New attributes added.
New attributes added.
There are no known problems.
New attributes added.
New attributes added.
New endpoint for splitting orders.