Only this pageAll pages
Powered by GitBook
Couldn't generate the PDF for 111 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

Changelog

Loading...

In progress

Loading...

2025

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...

2025-09-16: Client Management Service – new customer assignment propagation settings

Overview

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.

Known problems

There are no known problems.

2025-07-30: Order Service - orderEntryCalculatedPrice.price updated with new property

Overview

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

Known problems

There are no known problems.

2025-12-10: Customer Segments Service - customerId query parameter

Overview

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.

Modified endpoints

Endpoint
Description

Known problems

There are no known problems.

Current work in progress

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.

Service Name
Description

2025-11-26: Category Tree – filtering category trees by category IDs

Overview

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.

Modified endpoints

Endpoint
Description

New endpoints

Endpoint
Description

Known problems

There are no known problems.

2025-11-07: Media Service - support for custom schema types in reference type

Overview

The Media Service has been extended to support custom schema types as reference types. The type field in RefId can now accept any custom schema type in addition to the predefined types.

Updated endpoints

Endpoint
Description

Known problems

There are no known problems.

2025-08-04: Price Service - q param support

Overview

A q param has been added to endpoints for retrieving prices and price-lists.

Updated endpoints

Endpoint
Description

Known problems

There are no known problems.

2025-07-29: Schema Service - support for Site type

Overview

Schema Service has been extended with new schema type - SITE.

Created services

Endpoint
Description

Known problems

There are no known problems.

2025-07-30: Webhook Service - update order event schema

Overview

Order event schema was updated.

Added new fields

Event
Description

Known problems

There are no known problems.

2025-10-22: Webhook - new agentic job events

Overview

The new events were added to the Webhook Service. The events are related to the finished agentic jobs.

Added events

Event
Description

Known problems

There are no known problems.

2025-06-24: Webhook Service - new events added

Overview

The new events were added to webhook-service. The events related to manipulation of custom instances are now emitted to Webhook Service.

Added events

Event
Description

Known problems

There are no known problems.

2025-09-29: Category Tree - filter unpublished categories

Overview

Category tree endpoints exclude trees in which the root category has published=false, when only published categories are requested (showUnpublished=false).

Modified endpoints

Endpoint
Description

Known problems

There are no known problems.

2025-11-07: Order Service - new search endpoint

Overview

A new search endpoint has been added to the Order Service, allowing you to search for tenant's orders using a request body instead of query parameters.

New endpoints

Endpoint
Description

Known problems

There are no known problems.

2025-11-25: AI Service - Agent Logs

Overview

Added a new API for retrieving agent logs, allowing you to monitor and debug agent requests and sessions.

Added endpoints

Changelog

Find out what has been recently changed in the Emporix system.

- new feature

- improvement

- major change

- minor change

- deprecation

2025-11-26: Product Service – category and customer segment IDs in product response

This functionality is in preview mode — some of the features may not be fully operational yet.

Overview

Product retrieval responses now expose two new fields:

2025-12-08: AI Service - support for vLLM provider

Overview

Extended existing API for Agents by adding LLM provider of self_hosted_vllm type which supports self deployed vLLM.

Updated endpoints

2025-12-04: AI Service - Streamable HTTP MCP servers

Overview

The AI Service has been extended to support a new MCP server transport protocol: streamable_http. This option enables streamable HTTP-based communication between agents and custom MCP server implementations alongside the deprecated sse transport protocol.

2025-12-03: AI RAG Indexer - new endpoints for configuring RAG Search Functionality

Overview

Introduced new endpoints in ai-rag-indexer service which are necessary for configuring and performing RAG Search.

Added endpoints

2025-10-30: Cart Service - external discounts on cart level

Overview

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

2025-11-07: Customer Service - new search endpoint

Overview

A new search endpoint has been added to the Customer Service, allowing you to search for customer profiles using a request body instead of query parameters.

New endpoints

2025-11-14: Client Management Service - parent hierarchy endpoint added

Overview

A new endpoint has been added to retrieve a legal entity along with all of its parent legal entities in the hierarchy.

New endpoints

2025-09-24: Client Management Service – added a new contact assignment type

Overview

We've added a new contact assignment type: Contact to the Client Management service.

New validation rules:

  • Customer can be assigned to a legal entity only once, regardless of the assignment type.

2025-12-04: AI Service - Deprecation of SSE transport protocol

Overview

Since the official deprecation of the SSE transport in the Model Context Protocol spec , MCP clients have been moving away from SSE. Based on the official deprecation, we are deprecating the sse transport protocol in the AI Service as well.

2025-09-10: Customer Service - initial password for customer

Overview

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.

2025-07-18: Vendor Service - Vendor Service with locations

Overview

The Vendor Service allows you to manage vendors and their employees in your system. Vendor employees have access only to vendor's products and orders.

A vendor can have a subsidiary that represents a subdivision of the main vendor. Every vendor and subsidiary can have locations.

2025-08-29: Availability Service - vendor handling added

Overview

New field vendorId was added to the availability response. Vendor employees can modify and see only availabilities for products that belong to their vendor.

2025-07-30: Cart Service - vendor added

Overview

A new attribute vendor has been added to the cart item's product. The value is autopopulated based on product's vendor.

Modified endpoints

2025-07-18: Product Service - vendorId added

Overview

New field vendorId was added to the product model. Vendor employees can see only products that belong to their vendor.

New scopes

2025-09-10: Label Service - removed deprecated endpoints and fields

Overview

All previously deprecated endpoints and fields are now removed ().

Removed endpoints & fields

Retrieving all customer segments

Added customerId query parameter.

Searching with parameters for customer segments

Added customerId query parameter.

VSM

Improvements of features

Schema Service Product Service Category Service

Classification categories

Product Service

Product variants

AI Service

Agentic improvements

Retrieving the category trees

Added categoryIds query parameter.

Searching for category trees

New endpoint for searching category trees, which accepts categoryIds in the request body.

Creating an asset

The refIds.type field now accepts custom schema types.

Updating an asset

The refIds.type field now accepts custom schema types.

Retrieving all prices

Added q param support.

Retrieving all price lists

Added q param support.

Creating a schema

The SITE schema type has been added and can now be used in the request body.

Updating a schema

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.

Retrieving the category trees

When showUnpublished=false is set in the query parameters, trees with an unpublished root node are not returned.

Retrieving a specific category tree

When showUnpublished=false is set in the query parameters, trees with an unpublished root node are not returned.

Searching for orders

New endpoint that allows searching for orders with a request body.

Endpoint
Description

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.

Known problems

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.

    Modified endpoints

    Endpoint
    Description

    Added customerSegmentIds and categoryIds attributes to the response.

    Added customerSegmentIds and categoryIds attributes to the response.

    Added customerSegmentIds and categoryIds attributes to the response.

    Known problems

    There are no known problems.

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Modified endpoints
    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Endpoint
    Description

    Endpoint for triggering reindexing process.

    Endpoint for retrieving possible fields destined for computing embeddings.

    Endpoint for retrieving fields destined to filtering database entries.

    Known problems

    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.

    Updated endpoints

    Endpoint
    Description

    The externalDiscounts attribute has been added.

    The externalDiscounts attribute is included in the response.

    Known problems

    There are no known problems.

    Endpoint
    Description

    New endpoint that allows searching for customers with a request body.

    Known problems

    There are no known problems.

    Endpoint
    Description

    New endpoint that retrieves the specified legal entity and all parent legal entities in the hierarchy.

    Known problems

    There are no known problems.

    New assignment type has been added: Contact. This is now the default value.

    Modified endpoints

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Modified endpoints
    Endpoint
    Description

    The SSE transport protocol is deprecated.

    The SSE transport protocol is deprecated.

    The SSE transport protocol is deprecated.

    The SSE transport protocol is deprecated.

    Known problems

    There are no known problems.

    details here
    Updated Endpoints
    Endpoint
    Description

    New attribute password added.

    New attribute initialPassword added to the response.

    Known Problems

    There are no known problems with the current implementation.

    Created services
    Endpoint
    Description

    New service for vendors management vendor locations added.

    Known problems

    There are no known problems.

    New scopes
    • availability.availability_manage_by_vendor

    • availability.availability_view_by_vendor

    Modified endpoints

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

  • product.product_read_by_vendor

  • product.product_manage_by_vendor

  • Modified endpoints

    Endpoint
    Description

    New attribute vendor added.

    New attribute vendor added.

    New attribute vendor added.

    New attribute vendor added.

    New attribute vendor added.

    New attribute vendor added.

    Known problems

    There are no known problems.

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    2025-02-24: Label Service - deprecations

    2025-11-07: Category Service - new search endpoint and query parameter

    Overview

    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.

    New endpoints

    Endpoint
    Description

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-11-14: Price Service - legal entity support added

    Overview

    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

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-10-15: Sequential ID Service - removal of deprecated endpoints

    Overview

    All previously deprecated endpoints are now removed (2025-04-04: Sequential ID Service - deprecations).

    Removed endpoints & fields

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-10-30: Cart Service - quoteId added

    Overview

    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.

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-07-18: Order Service - vendor added

    Overview

    A new attribute vendor has been added to the order object. Vendor employees can see and modify only orders that belong to their vendor.

    New scopes

    • order.order_read_by_vendor

    • order.order_manage_by_vendor

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-09-30: Media Service - add MODULE media id type

    Overview

    A new reference type has been added to the Media service: MODULE. It's meant to be used for Management Dashboard assets.

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-07-18: IAM Service - new endpoint and vendorId attribute

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-08-29: Media Service - vendor handling added

    Overview

    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.

    New scopes

    • media.asset_manage_by_vendor

    • media.asset_read_by_vendor

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-07-30: Cart Service - new attributes on item level

    Overview

    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

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-06-12: Order Service - calculatedPrice has been enriched

    Overview

    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

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-09-10: Brand Service - removed deprecated endpoints and fields

    Overview

    All previously deprecated endpoints and fields are now removed (2025-03-04: Brand Service - deprecations).

    Removed endpoints & fields

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-12-03: AI Service - RAG_CUSTOM and RAG_EMPORIX new tool types

    Overview

    Extended existing API for Native Tools by adding tools of RAG_CUSTOM and RAG_EMPORIX types which are necessary for performing RAG Search.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-11-07: Schema Service - references

    Overview

    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.

    2025-05-26: Cart Service - adding items as separate lines to a cart

    Overview

    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.

    Searching for categories

    New endpoint that allows searching for categories with a request body.

    Retrieving a list of categories

    Added support for the standard q query parameter to filter categories.

    Matching a product price

    New attribute legalEntityId added to request payload.

    Creating a new price list

    New attribute legalEntityId added to request payload.

    Upserting a price list

    New attribute legalEntityId added to request payload.

    Retrieving all price lists

    New attribute legalEntityId added to response.

    Retrieving a price list

    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.

    Updating a cart

    New attribute quoteId added.

    Retrieving cart details by ID

    New attribute quoteId added.

    Retrieving cart details by criteria

    New attribute quoteId added.

    Searching for carts

    New attribute quoteId added.

    Retrieving all assets

    New reference type MODULE has been added.

    Retrieving an asset

    New reference type MODULE has been added.

    Creating an asset

    New reference type MODULE has been added.

    Updating an asset

    New reference type MODULE has been added.

    Creating a new group

    The attribute vendorId has been added.

    Retrieving a group

    The attribute vendorId has been added.

    Retrieving a list of vendor users

    New endpoint that return's list of users belonging to the vendor

    Retrieving all assets

    New attribute vendorId added to response. New scope media.asset_read_by_vendor added.

    Retrieving an asset

    New attribute vendorId added to response. New scope media.asset_read_by_vendor added.

    Creating an asset

    New scope media.asset_manage_by_vendor added.

    Updating an asset

    New scope media.asset_manage_by_vendor added.

    Deleting an asset

    New scope media.asset_manage_by_vendor added.

    Downloading an asset

    New scope media.asset_read_by_vendor added.

    Adding a product to cart

    The linePrice and lineTax attributes have been added.

    Updating a cart item

    The linePrice and lineTax attributes have been added.

    Retrieving cart details by ID

    The linePrice and lineTax attributes have been added in the response.

    Retrieving all products added to a cart

    The linePrice and lineTax attributes have been added in the response.

    Creating a new order as employee

    The calculatedPrice attribute has been enriched in order and order entries.

    Creating a new order as customer

    The calculatedPrice attribute has been enriched in order and order entries.

    Retrieving order details

    The calculatedPrice attribute has been enriched in order and order entries responses.

    Retrieving a specific order by ID

    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.

    Creating a brand

    The image and cloudinaryUrl fields removed from request body.

    Updating a brand

    The image and cloudinaryUrl fields removed from request body.

    Partially updating a brand

    The image and cloudinaryUrl fields removed from request body.

    Upserting tool

    Tools of RAG_EMPORIX and RAG_CUSTOM types have been introduced.

    Partially updating tool

    Tools of RAG_EMPORIX and RAG_CUSTOM types have been introduced.

    Listing agent requests
    Retrieving agent request by ID
    Searching agent requests
    Listing agent sessions
    Retrieving agent session by ID
    Searching agent sessions
    Searching for products
    Retrieving all products
    Retrieving a product
    Listing agents
    Searching agents
    Retrieving agent by ID
    Upserting agent
    Partially updating agent
    Searching MCP servers
    Retrieving MCP server by ID
    Upserting MCP server
    Partially updating MCP server
    Reindexing the entities of given type
    Listing fields for RAG search
    Listing fields for vector search filtering
    Updating a cart
    Retrieving cart details by ID
    Searching for customers
    Retrieving a legal entity with parent hierarchy
    Creating contact assignment
    Upserting a contact assignment
    Searching MCP servers
    Retrieving MCP server by ID
    Upserting MCP server
    Partially updating MCP server
    Creating a customer
    Logging in a customer
    Vendor service
    Retrieving all availability information for a site
    Retrieving product availabilities for a site
    Retrieving a product's availability
    Creating a new availability for a product
    Upserting availability information of a product
    Deleting availability information of a product
    Retrieving all products added to a cart
    Retrieving a cart item
    Retrieving cart details by criteria
    Retrieving cart details by ID

    Upserting multiple products

    New attribute vendor added.

    Creating a new product
    Retrieving a product's details
    Retrieving a list of products
    Upserting a product
    Partially updating a product's details
    Creating multiple products
    Creating a media
    Deleting a media
    Creating a label
    Updating a label
    Partially updating a label

    2025-03-28: Customer Service - removed couponMixin mixin

    Overview

    The couponMixin mixin has been removed from the customer model. The mixin was used to store referralCouponCode of the customer. The information about referral coupon is now stored in the Coupon model.

    Known problems

    There are no known problems.

    New attribute vendor added.

    New attribute vendor added.

    Creating a new order

    New attribute vendor added.

    Retrieving orders

    New attribute vendor added.

    Retrieving a specific order by ID

    New attribute vendor added.

    Updating an order

    New attribute vendor added.

    Partially updating an order

    New attribute vendor added.

    Creating a new order

    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.

  • Updated endpoints

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Added endpoints
    Endpoint
    Description

    Added the keepAsSeparateLine attribute.

    Added the keepAsSeparateLine attribute.

    Known problems

    Quotes do not support separate line items yet.

    2025-11-17: AI Service - Export/Import agents

    Overview

    Added a new API for importing and exporting AI agents and improved the existing APIs.

    New attributes

    • 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.

    Added endpoints

    Endpoint
    Description

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-10-30: Cart Service - address management

    Overview

    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

    Address auto-population

    When addresses are not explicitly provided in the request, the Cart Service automatically populates them based on the following priority order:

    1. 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).

    2. 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.

    Address usage

    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:

    Backward compatibility

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-11-13: Coupon Service - removal of deprecated endpoints

    Overview

    All previously deprecated endpoints are now removed (2025-03-28: Coupon Service - deprecations).

    Removed endpoints & fields

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-10-29: Quote Service - external prices and mixins support

    Overview

    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

    Modified endpoints

    Endpoint
    Description

    New features

    External prices

    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.

    External products

    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 support

    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.

    Known problems

    There are no known problems.

    2025-06-05: OAuth Service - added session_id field to login and refreshauthtoken response

    Overview

    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).

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-06-04: Order Service - cartId added

    Overview

    A new attribute cartId has been added to the order object. The new field will have cartId of the cart associated with the order.

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-17: Order Service - new endpoints to fetch orders for a legal entity

    Overview

    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.

    New endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-28: Referral Coupon Service - deprecations

    Overview

    All deprecations will be removed on 2025-10-01. From now, use the new referral coupons endpoints to referral coupons.

    Deprecated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-27: Quote Service - businessModel field added to the responses

    Overview

    The GET endpoints for the Quote Service have been extended with the businessModel field. It provides information whether quote has been created for B2B or B2C customer.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-28: Coupon Service - new referralCoupon field in the coupon model

    Overview

    A new referralCoupon field has been added to the endpoint. This field indicates if the coupon is of a referral coupon type.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-06-02: OAuth Service - added fields to validateauthtoken response

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-26: OAuth Service - Legal Entity information in the auth token

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-04-16: Cart Service - introduction of search endpoint

    Overview

    The cart service was extended with search endpoint which allows to search for many carts.

    Added endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-04-17: Product Service - deprecations

    Overview

    Endpoint for searching by YRNs will be removed on 2025-10-17.

    Deprecated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-18: Fee Management - new validation added

    Overview

    A validation rule ensures fee data consistency by requiring a taxCode when creating or updating fees with taxable=true. This enforces the logical dependency between taxation status and tax code identification.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-04: Media Service - support for brands

    Overview

    Request body for creating or updating assets has been extended with new reference type - BRAND - which should be used to assign media to the brands.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-19: Customer Segments Service - expanded response for retrieving category trees for a custom

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-18: Cart Service - deprecated field

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-04-03: OAuth Service - new endpoint

    Overview

    A new validate a customer token endpoint has been created. The endpoint checks whether a token is valid. If the token is invalid, it returns a 401 status code. If the token is valid, it provides the token details.

    New endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-04-14: Cart Service - support external discounts

    Overview

    The cart service now allows to specify external discounts on an item level. The functionality requires the cart.cart_manage_external_prices scope to add an external discount to the item.

    2025-05-26: Order Service - adding entries to an order

    Overview

    When adding entries to an order, the payload now includes a new attribute called entryId. The productId attribute should only be provided when adding a completely new product to the order. This enhancement allows for more precise control over order modifications.

    2025-06-04: Cart Service - orderId added

    Overview

    A new attribute orderId has been added to the cart object. The new field will have orderId of the order associated with the cart.

    Modified endpoints

    2025-06-12: Cart Service - calculatedPrice has been enriched

    Overview

    The calculatedPrice of Cart Service has been enriched with new fields:

    • totalDiscounts has a new price field that contains all price details

    2025-04-07: IAM Service - new query parameter

    Overview

    Query parameter q has been added to GET all groups endpoint. The new query parameter allows you to filter groups.

    2025-07-23: B2B Customer Groups - Migration

    Overview

    We have completed an update to the customer group and assignment structure in the IAM service for all tenants. This change brings greater clarity and flexibility to how users are organized and managed within each legal entity.

    What’s new

    2025-03-04: Important Security Update – discontinuation of Weak Cipher Support

    Overview

    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:

    2025-02-24: Label Service - deprecations

    Overview

    All deprecations will be removed on 2025-09-01. From now on, use the to manage media for labels.

    Deprecated endpoints

    2025-03-05: Order Service - legal entity information in the order model

    Overview

    A new optional legalEntityId field has been added to the endpoint. This field is intended exclusively for B2B cases and specifies the legal entity for which the order was created.

    2025-03-04: Shopping List Service - metadata field changes

    Overview

    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.

    2025-03-04: Brand Service - deprecations

    Overview

    All deprecations will be removed on 2025-09-01. From now on, use the to manage media for brands.

    Deprecated endpoints

    2025-08-04: Webhook Service - new Vendor events

    Overview

    The new events were added to webhook-service. The events related to manipulation of vendor instances are now emitted to Webhook Service.

    Added events

    2025-04-29: Customer Segments Service - fully operational

    Overview

    Customer Segment Service allows you to group your customers in many convenient ways that suit different purposes. You can assign products or categories to create targeted marketing campaigns and display the relevant items on the storefront.

    Deprecated endpoints

    TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • 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.

    What do you need to do:

    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)

    Event
    Description

    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.

    Known problems

    There are no known problems.

    All the previously added endpoints were changed from the preview mode to fully operational. See the Customer Segments API Reference.

    Known problems

    There are no known problems.

    Creating a quote

    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.

    Retrieving a single quote

    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.

    Retrieving quotes

    Added the id field to media object in response.

    Partially updating a quote

    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}.

    Logging in a customer

    Added the session_id field in response.

    Refreshing a customer token

    Added the session_id field in response.

    Retrieving legal entity orders

    Retrieves a list of orders related to a particular legal entity for a customer. To be used by B2B customers on the storefront.

    Retrieving legal entity order

    Retrieves an order related to a particular legal entity for a customer. To be used by B2B customers on the storefront.

    Retrieving customer's referral coupon code

    Endpoint will be removed and moved under /coupon/{tenant}/referral-coupons/{customerNumber}.

    Creating a referral coupon code for a specific customer

    Endpoint will be removed and moved under /coupon/{tenant}/referral-coupons/{customerNumber}.

    Retrieving quotes

    Field businessModel added to the response.

    Retrieving a single quote

    Field businessModel added to the response.

    Retrieving list of coupons by criteria

    New property referralCoupon added to the response.

    Retrieving information about particular coupon by code

    New property referralCoupon added to the response.

    Validate a token

    Added the email and legalEntityId fields in response.

    Refreshing a customer token

    The endpoint extended with an optional legalEntityId query param.

    Search endpoint

    New endpoint has been added.

    Searching for products by YRNs)

    Endpoint will be removed. Please use /product/{tenant}/products/search instead.

    Creating fee

    Added validation of taxCode fee is marked with taxable=true

    Retrieving fee by id

    Added validation of taxCode fee is marked with taxable=true

    Creating a media

    Request body's refIds.type field has a new enum value - BRAND.

    Updating a media

    Request body's refIds.type field has a new enum value - BRAND.

    Retrieving category trees for a customer segments

    Added localizedDescription, localizedSlug, ecn, validity, position, and published fields to the responses.

    Applying a discount to cart

    Deprecated request attribute calculationType

    Validate a customer token

    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)

  • Site Homebase Address
    - If neither of the above is available, the site's homebase address is used (origin:
    SITE
    ).

    Creating a new cart

    The addresses attribute has been added to the request body.

    Updating a cart

    The addresses attribute has been added to the request body.

    Retrieving cart details by ID

    The addresses attribute with origin information is included in the response.

    How to determine a tax country at cart level
    How to calculate shipping cost at cart level
    Retrieving order details
    Retrieving a list of orders

    Retrieving a custom instance

    Added expand query parameter for fetching expanded references. Added media field to the response.

    Searching for custom instances

    Added expand query parameter for fetching expanded references. Added media field to the response.

    Creating a schema

    The REFERENCE attribute type is now available for custom schema types.

    Updating a schema

    The REFERENCE attribute type is now available for custom schema types.

    Creating a custom instance
    Upserting a custom instance
    Patching a custom instance
    Creating custom instances in bulk
    Upserting custom instances in bulk
    Retrieving all custom instances
    Adding a product to cart
    Adding multiple products to cart

    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.

    Importing agents

    It allows importing AI agents.

    Exporting agents

    It allows exporting AI agents.

    Listing available jobs

    New fields have been added to the job response: type, 'exportResult' and importResult.

    Searching jobs

    New fields have been added to the job response: type, 'exportResult' and importResult.

    Retrieving available job

    New fields have been added to the job response: type, 'exportResult' and importResult.

    Deleting agent

    New force query parameter has been added which allows you to delete agent which is used as collaboration agent.

    Deleting tool

    New force query parameter has been added which allows you to delete tool which is used by agents.

    Deleting token

    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.

    Retrieving list of coupons by criteria

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    Creating a new coupon

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    Retrieving information about particular coupon by code

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    Updating the coupon by code

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    Partially updating the coupon by code

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    Deleting a coupon by code

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    Validating redeemability of a coupon

    Endpoint previously available under the /coupon-v2/ path is now available only on /coupon/ base path.

    New attribute cartId added.

    New attribute cartId added.

    Creating a new order

    New attribute cartId added.

    Retrieving orders

    New attribute cartId added.

    Retrieving a specific order by ID

    New attribute cartId added.

    Updating an order

    New attribute cartId added.

    Partially updating an order

    New attribute cartId added.

    Creating a new order

    New attribute cartId added.

    Added endpoints
    Endpoint
    Description

    Added the externalDiscounts attribute.

    Added the externalDiscounts attribute.

    Added the externalDiscounts attribute.

    Known problems

    There are no known problems.

    Added endpoints
    Endpoint
    Description

    Added the entryId attribute.

    Known problems

    There are no known problems.

    Endpoint
    Description

    New attribute orderId added.

    New attribute orderId added.

    New attribute orderId added.

    Known problems

    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

    Updated endpoints

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Updated endpoints
    Endpoint
    Description

    The new query parameter q has been added.

    Known problems

    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.

    Summary of changes

    Area
    Description

    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.

    Known problems

    There are no known problems.

    Documentation

    For more information, see the following pages:

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    media-service endpoints
    Updated endpoints
    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Updated endpoints
    Endpoint
    Description

    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

    Known problems

    There are no known problems.

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    media-service endpoints

    2025-04-10: Cart Service - cart validation and configuration improvement

    Overview

    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.

    Added endpoints

    Endpoint
    Description

    New configuration settings

    Key
    Name
    Type

    Known problems

    There are no known problems.

    2025-04-04: Sequential ID Service - deprecations

    Overview

    All deprecations will be removed on 2025-10-01.

    Deprecated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-05-12: Customer Service - improvements

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-21: Site Settings Service - timezone field added

    Overview

    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__

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-07: Order Service - calculated prices

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-18: Cart Service - deprecated fields

    Overview

    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.

    Deprecated cart-level fields:

    • totalPrice - use calculatedPrice.finalPrice instead

    • subTotalPrice - use calculatedPrice.price or calculatedPrice.discountedPrice instead

    • taxAggregate

    Deprecated cart item-level fields:

    • price - use unitPrice instead

    • itemPrice - use unitPrice instead

    • itemTaxInfo - use calculatedPrice.price

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-24: Media Service - support for labels

    Overview

    Request body for creating or updating assets has been extended with new reference type - LABEL - which should be used to assign media to the labels.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-05: Weight dependent products

    Overview

    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.

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-14: Customer Service - new field

    Overview

    A new lastLogin field has been added to the customer response, returning a date-time string. If the value is null, it indicates that the customer has not logged in since the field was introduced (14-02-2025).

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-11-07: Price Service - new search endpoint for price lists

    Overview

    A new search endpoint has been added to the Price Service, allowing you to search for price lists using a request body instead of query parameters.

    New endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-08-29: Price Service - vendor handling added

    Overview

    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.

    New scopes

    • price.price_manage_by_vendor

    • price.price_read_by_vendor

    Modified endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-03-21: Sequential ID Service - siteCode query param

    Overview

    Query param siteCode has been added to endpoints responsible for generating next ids. The siteCode is used to resolve certain placeholders. Placeholders such as __year__, __month__, __day__, __hour__, __minute__

    2025-03-28: Coupon Service - deprecations

    Overview

    All deprecations will be removed on 2025-10-01. From now, use the /coupon/ base path for all the to manage coupons and referral coupons.

    2025-06-04: Cart Service - auto populate product details

    Overview

    A new tenant configuration option populateProductDetailsOnAddToCart has been added to the Cart Service. When enabled, the cart service will populate product details on the cart item:

    • id

    2025-11-13: Referral Coupon Service - removal of deprecated endpoints

    Overview

    All previously deprecated endpoints are now removed ().

    Removed endpoints & fields

    2025-09-16: IAM Service – validation of predefined group assignments

    Overview

    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.

    2025-02-18: Site Settings - new field

    Overview

    A new cartCalculationScale field has been added to the site setting. The field allows to control the number of decimal points in cart's calculatedPrice attributes.

    Validating cart items

    Validates cart items' prices.

    Adding a product to cart

    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

    Retrieving all schemas

    Endpoint will be removed. Please use /sequential-id/{tenant}/schemas instead.

    Creating a schema

    Endpoint will be removed. Please use /sequential-id/{tenant}/schemas instead.

    Creating a nextId

    Endpoint will be removed. Please use /sequential-id/{tenant}/schemas/types/{schemaType}/nextId instead.

    Logging in a customer

    New properties access_token, saas_token, expires_in, refresh_token, refresh_token_expires_in, token_type added to the response.

    Refreshing a customer token

    New properties access_token, expires_in, refresh_token, refresh_token_expires_in, token_type added to the response.

    Creating a customer account with double opt-in

    New properties access_token, saas_token, expires_in, refresh_token, refresh_token_expires_in, token_type added to the response.

    Retrieving sites

    The homeBase.timezone field added to the response body.

    Retrieving a site

    The homeBase.timezone field added to the response body.

    Creating a site

    The homeBase.timezone field added to the request body.

    Fully updating a site

    The homeBase.timezone field added to the request body.

    Partially updating a site

    The homeBase.timezone field added to the request body.

    Creating a new order (tenant-managed)

    Order level calculatedPrice marked as mandatory and totalPrice marked as optional.

    Creating a new order (tenant-managed)

    Order entry level calculatedPrice marked as mandatory and totalPrice marked as optional.

    Creating a new order (tenant-managed)

    Order entry level calculatedUnitPrice marked as mandatory and unitPrice marked as optional.

    Creating a new order (customer-managed)

    Order level calculatedPrice marked as mandatory and totalPrice marked as optional.

    Creating a new order (customer-managed)

    Order entry level calculatedPrice marked as mandatory and totalPrice marked as optional.

    Creating a new order (customer-managed)

    Order entry level calculatedUnitPrice marked as mandatory and unitPrice marked as optional.

    - use
    calculatedPrice.finalPrice.taxAggregate
    instead
  • subtotalAggregate - 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

  • 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

  • Retrieving cart details by ID

    Deprecated response fields are replaced by calculatedPrice and unitPrice.

    Retrieving cart details by criteria

    Deprecated response fields are replaced by calculatedPrice and unitPrice.

    Retrieving all products added to a cart

    Deprecated response fields are replaced by calculatedPrice and unitPrice.

    Creating a media

    Request body's refIds.type field has a new enum value - LABEL.

    Updating a media

    Request body's refIds.type field has a new enum value - LABEL.

    Retrieving a customer's profile

    Added lastLogin field to the responses.

    Retrieving a customer profile

    Added lastLogin field to the responses.

    Retrieving a list of customers

    Added lastLogin field to the responses.

    Searching for price lists

    New endpoint that allows searching for price lists with a request body.

    Deleting MCP server
    Listing tools
    Searching tools
    Retrieving tool by ID
    Upserting tool
    Partially updating tool
    Listing MCP servers
    Searching MCP servers
    Retrieving MCP server by ID
    Upserting MCP server
    Partially updating MCP server
    Retrieving a list of redemptions by criteria
    Redeeming the coupon by creating a redemption
    Retrieving a coupon redemption
    Deleting a coupon redemption
    Retrieving order details
    Retrieving a list of orders
    Adding a product to cart
    Adding multiple products to cart
    Updating a cart item
    Adding entries to an order
    Retrieving cart details by ID
    Retrieving cart details by criteria
    Searching for carts
    Retrieving cart details by criteria
    Retrieving cart details by ID
    Retrieving all products added to a cart
    Retrieving all groups
    Creating a media
    Deleting a media
    Creating a label
    Updating a label
    Partially updating a label
    Creating a new order
    Updating an order
    Partially updating an order
    Retrieving orders
    Retrieving a specific order by ID
    Retrieving a shopping list
    Retrieving a customer shopping list
    Updating a customer shopping list
    Creating a media
    Deleting a media
    Creating a brand
    Updating a brand
    Partially updating a brand

    New request attribute weightDependent added.

    New response attribute weightDependent added.

    New response attribute weightDependent added.

    Adding a product to cart

    Deprecated request attribute weightDependent.

    Adding multiple products to cart

    Deprecated request attribute weightDependent.

    Creating a new product

    New request attribute weightDependent added.

    Creating multiple products

    New request attribute weightDependent added.

    Upserting a product

    New request attribute weightDependent added.

    Upserting multiple products

    New request attribute weightDependent added.

    New scope price.price_manage_by_vendor added.

    Retrieving all prices

    New attribute vendorId added to response. New scope price.price_read_by_vendor added.

    Retrieving a price

    New attribute vendorId added to response. New scope price.price_read_by_vendor added.

    Creating a new price

    New scope price.price_manage_by_vendor added.

    Creating multiple prices

    New scope price.price_manage_by_vendor added.

    Upserting a price

    New scope price.price_manage_by_vendor added.

    Upserting multiple prices

    New scope price.price_manage_by_vendor added.

    ,
    __second__
    and
    __country__
    , which are defined in the schema, can have some default values computed when their counterparts are missing in the request body. The default values are derived from the site. Specifically:
    • 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

    Updated endpoints

    Endpoint
    Description

    Query param siteCode added.

    Query param siteCode added.

    Query param siteCode added.

    Known problems

    There are no known problems.

    Deprecated endpoints
    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    coupons endpoints

    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.

  • Modified endpoints

    Endpoint
    Description

    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

    Known problems

    There are no known problems.

    Endpoint
    Description

    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}.

    Known problems

    There are no known problems.

    2025-03-28: Referral Coupon Service - deprecations
  • Customers may still be assigned to different groups in different companies (Legal Entities).

  • The Contact group can always be assigned.

  • Modified endpoints

    Endpoint
    Description

    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.

    Known problems

    There are no known problems.

    Updated endpoints
    Endpoint
    Description

    Added cartCalculationScale field to the request.

    Added cartCalculationScale field to the request.

    Added cartCalculationScale field to the request.

    Added cartCalculationScale field to the responses.

    Known problems

    There are no known problems.

    2025-10-22: AI Service - support for AI agents

    Overview

    We added a new API for managing and communicating with AI agents.

    Added endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-04-03: Schema Service - endpoints for managing custom entities and instances

    Overview

    We added new API for managing custom schema types and custom instances. Custom schema types are custom entities on which you can build custom instances.

    Added endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-02-18: Order Service - deprecated fields

    Overview

    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.

    Deprecated order-level fields:

    • totalPrice - use calculatedPrice.finalPrice instead

    • subTotalPrice - use calculatedPrice.price or calculatedPrice.discountedPrice instead

    • taxAggregate

    Deprecated order item-level fields:

    • price - use unitPrice instead

    • itemPrice - use unitPrice instead

    • itemTaxInfo - use calculatedPrice.price

    Updated endpoints

    Endpoint
    Description

    Known problems

    There are no known problems.

    2025-07-30: Order Service - order splitting

    Overview

    Order was extended with new capabilities of splitting orders by vendor.

    New attributes

    - use
    calculatedPrice.finalPrice.taxAggregate
    instead
  • subtotalAggregate - 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

  • 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

  • Creating a new order as employee

    Deprecated response fields in favor of calculatedPrice and unitPrice

    Creating a new order as customer

    Deprecated response fields in favor of calculatedPrice and unitPrice

    Retrieving order details

    Deprecated response fields in favor of calculatedPrice and unitPrice

    Retrieving a specific order by ID

    Deprecated response fields in favor of calculatedPrice and unitPrice

    Partially updating a product
    Retrieving a product
    Retrieving all of products
    Deleting a price
    Creating a nextId
    Creating a nextId for schema type
    Creating a nextId for schema types

    Validating redeemability of a coupon

    Endpoint will be removed and moved under the /coupon/ base path.

    Retrieving a list of redemptions by criteria

    Endpoint will be removed and moved under the /coupon/ base path.

    Redeeming the coupon by creating a redemption

    Endpoint will be removed and moved under the /coupon/ base path.

    Retrieving a coupon redemption

    Endpoint will be removed and moved under the /coupon/ base path.

    Deleting a coupon redemption

    Endpoint will be removed and moved under the /coupon/ base path.

    Retrieving list of coupons by criteria
    Creating a new coupon
    Retrieving information about particular coupon by code
    Updating the coupon by code
    Partially updating the coupon by code
    Deleting a coupon by code
    Adding a product to cart
    Updating a cart item
    Retrieving all products added to a cart
    Retrieving cart details by ID
    Retrieving cart details by criteria
    Retrieving customer's referral coupon code
    Creating a referral coupon code for a specific customer
    Adding a user to a group
    Upserting a group assignment
    Creating a site
    Fully updating a site
    Partially updating a site
    Retrieving a site

    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.

    Starting agent chat

    It allows chatting with AI agents.

    Starting agent async chat

    It allows chatting with AI agents asynchronously.

    Listing available agent templates

    It retrieves all agent templates.

    Searching agent templates

    It searches for agent templates.

    Creating agent instance based on a template

    It creates a new agent based on the selected template.

    Listing agents

    It retrieves all agents.

    Searching agents

    It searches for agents.

    Retrieving agent by ID

    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.

    Creating a custom schema type

    It creates a new schema type.

    Retrieving all custom schema types

    It retrieves all custom schema types.

    Retrieving a custom schema type

    It retrieves a custom schema type.

    Deleting a custom schema type

    It deletes a custom schema type.

    Upserting a custom schema type

    It upserts custom schema type.

    Creating a custom instance

    It creates a custom instance.

    Retrieving all custom instances

    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

  • New endpoints

    A new endpoint that allows to split an order has been added.

    Modified endpoints

    Endpoint
    Description

    New attributes added.

    New attributes added.

    New attributes added.

    New attributes added.

    New attributes added.

    New attributes added.

    Known problems

    There are no known problems.

    Upserting agent
    Partially updating agent
    Deleting agent
    Listing available jobs
    Searching jobs
    Retrieving available job
    Deleting a job
    Listing commerce events
    Listing MCP servers
    Searching MCP servers
    Retrieving MCP server by ID
    Upserting MCP server
    Partially updating MCP server
    Deleting MCP server
    Listing tokens
    Searching tokens
    Retrieving token by ID
    Upserting token
    Partially updating token
    Deleting token
    Listing tools
    Searching tools
    Retrieving tool by ID
    Upserting tool
    Partially updating tool
    Deleting tool
    Retrieving a custom instance
    Deleting a custom instance
    Upserting a custom instance
    Patching a custom instance
    Searching for custom instances
    Creating custom instances in bulk
    Upserting custom instances in bulk
    Deleting custom instances in bulk

    Retrieving order details

    New attributes added.

    Retrieving a list of orders

    New attributes added.

    Splitting order

    New endpoint for splitting orders.

    Creating a new order
    Retrieving orders
    Retrieving a specific order by ID
    Updating an order
    Partially updating an order
    Creating a new order
    Groups
    Company Shared Orders and Customer Groups