Changelog
Learn more about any recent changes in the Emporix API.
Improvement
Last updated 2025-02-19Customer Segments Service - expanded response for retrieving category trees for a customer segments endpoint
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 |
|---|---|
| Retrieving category trees for a customer segments | Added localizedDescription, localizedSlug, ecn, validity, position, and published fields to the responses. |
Known problems
There are no known problems.
Deprecated
Last updated 2025-02-18Cart Service - deprecated fields
Overview
Several fields in cart's response have been deprecated and are now replaced bycalculatedPrice and unitPrice fields. The new fields provide a more comprehensive and consistent way to access price calculations.Deprecated cart-level fields:
totalPrice- usecalculatedPrice.finalPriceinsteadsubTotalPrice- usecalculatedPrice.priceorcalculatedPrice.discountedPriceinsteadtaxAggregate- usecalculatedPrice.finalPrice.taxAggregateinsteadsubtotalAggregate- usecalculatedPrice.priceinsteadtotalDiscount- usecalculatedPrice.totalDiscountinsteadfeeYrnAggregate- usecalculatedPrice.totalFeesanditems[].calculatedPrice.feesinsteadshipping- usecalculatedPrice.totalShippinginsteaditemFeesTotal- usecalculatedPrice.totalFeeinsteadpaymentFeesTotal- usecalculatedPrice.paymentFeesinsteadtotalAuthorizedAmount- usecalculatedPrice.upliftValueinstead
Deprecated cart item-level fields:
price- useunitPriceinsteaditemPrice- useunitPriceinsteaditemTaxInfo- usecalculatedPrice.priceinsteadfees- usecalculatedPrice.feesinsteadauthorizedAmount- usecalculatedPrice.upliftValueinsteadtotalDiscount- usecalculatedPrice.totalDiscountinsteadexternalFees- usecalculatedPrice.feesinsteadcouponDiscounts- usecalculatedPrice.totalDiscounts.appliedDiscountsinstead
Updated endpoints
| Endpoint | Description |
|---|---|
| Retrieving a cart's details by ID | Deprecated response fields are replaced by calculatedPrice and unitPrice. |
| Retrieving a cart's 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. |
Known problems
There are no known problems.
Deprecated
Last updated 2025-02-18Cart service - deprecated field
Overview
When applying discount on a cart, the request allows to specifycalculationType 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 |
|---|---|
| Applying a discount to cart | Deprecated request attribute calculationType |
Known problems
There are no known problems.
Improvement
Last updated 2025-02-18Fee management - new validation added
Overview
A validation rule ensures fee data consistency by requiring ataxCode when creating or updating fees with taxable=true. This enforces the logical dependency between taxation status and tax code identification.Updated endpoints
| Endpoint | Description |
|---|---|
| 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 |
Known problems
There are no known problems.
Improvement
Last updated 2025-02-18Site Settings - new field
Overview
A newcartCalculationScale field has been added to the site setting. The field allows to control the number of decimal points in cart's calculatedPrice attributes.Updated endpoints
| Endpoint | Description |
|---|---|
| Creating a site | Added cartCalculationScale field to the request. |
| Fully updating a site | Added cartCalculationScale field to the request. |
| Partially updating a site | Added cartCalculationScale field to the request. |
| Retrieving a site | Added cartCalculationScale field to the responses. |
Known problems
There are no known problems.
Improvement
Last updated 2025-02-14Customer service - new field
Overview
A newlastLogin 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 |
|---|---|
| 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. |
Known problems
There are no known problems.
Improvement
Last updated 2025-02-05Cart Service - enhanced price calculation details
Overview
The Cart Service now provides detailed price calculation information through thecalculatedPrice field. This enhancement gives a comprehensive breakdown of prices including net values, gross values, tax details, fees, and discounts for both the entire cart and individual line items.Updated endpoints
| Endpoint | Description |
|---|---|
| Retrieving a cart's details by criteria | Added calculatedPrice field to cart and cart items responses. |
| Retrieving a cart's details by ID | Added calculatedPrice field to cart and cart items responses. |
| Retrieving all products added to a cart | Added calculatedPrice field to cart items responses. |
Known problems
There are no known problems.
Improvement
Last updated 2025-02-05Order Service - enhanced price calculation details
Overview
The Order Service now provides detailed price calculation information through thecalculatedPrice field. This enhancement gives a comprehensive breakdown of prices including net values, gross values, tax details, fees, and discounts for both the entire order and individual line items.Updated endpoints
| Endpoint | Description |
|---|---|
| Creating a new order as employee | Added calculatedPrice field to order and order entries. |
| Creating a new order as customer | Added calculatedPrice field to order and order entries. |
| Retrieving order details | Added calculatedPrice field to order and order entries responses. |
| Retrieving a specific order by ID | Added calculatedPrice field to order and order entries responses. |
Known problems
There are no known problems.
Improvement
Last updated 2025-01-30Order - new priceListId field
Overview
ThepriceListId field has been added to the create order endpoint.Updated endpoints
| Endpoint | Description |
|---|---|
| Creating a new order | Added a new priceListId field to the request body. |
Known problems
There are no known problems.
Improvement
Last updated 2025-01-30Cart - new priceListId field added.
Overview
ThepriceListId field has been added to the get a cart endpoint. The field is populated only in the case when a returned price belongs to any price list. Otherwise the field is not returned.Updated endpoints
| Endpoint | Description |
|---|---|
| Retrieving a cart's details by ID | Added a new priceListId (items.price.priceListId) field to the response. |
Known problems
There are no known problems.
Improvement
Last updated 2025-01-29Price Match - new priceListId field added.
Overview
ThepriceListId field has been added to the price match endpoints. The field is populated only in the case when a returned prices belongs to any price list. Otherwise the field is not returned.Updated endpoints
| Endpoint | Description |
|---|---|
| Matching price for a specific attributes | Added a new priceListId field to the response. |
| Matching price for session context | Added a new priceListId field to the response. |
Known problems
There are no known problems.
Improvement
Last updated 2025-01-24Algolia - added information about segments
Overview
The indexed products have a new field -segment_ids - which informs to which segments the given product is assigned.Known problems
There are no known problems.
Deprecated
Last updated 2025-01-13Availability Service - availability endpoints replacement
Overview
The availability endpoints that acceptsite as a query parameter, are now deprecated. They have been replaced with new endpoints that use site as a path parameter.New endpoints
| Endpoint | Description |
|---|---|
| Retrieving a products availability | New endpoint that takes site as a path parameter is now available. |
| Creating a new availability for a product | New endpoint that takes site as a path parameter is now available. |
| Upserting availability information of a product | New endpoint that takes site as a path parameter is now available. |
| Deleting availability information of a product | New endpoint that takes site as a path parameter is now available. |
| Retrieving all availability information for a site | New endpoint that takes site as a path parameter is now available. |
| Retrieving product availabilities for a site | New endpoint that takes site as an optional query parameter is now available. |
Deprecated endpoints
| Endpoint | Description |
|---|---|
| Retrieving a products availability | Endpoint that takes site as a query parameter is now deprecated. |
| Creating a new availability for a product | Endpoint that takes site as a query parameter is now deprecated. |
| Upserting availability information of a product | Endpoint that takes site as a query parameter is now deprecated. |
| Deleting availability information of a product | Endpoint that takes site as a query parameter is now deprecated. |
| Retrieving all availability information for a site | Endpoint that takes site as a query parameter is now deprecated. |
| Retrieving product availabilities for a site | Endpoint that takes site as a mandatory query parameter is now deprecated. |
Known problems
There are no known problems.
Deprecated
Last updated 2025-02-18Order Service - deprecated fields
Overview
Several fields in order's response have been deprecated in favor of newcalculatedPrice and unitPrice fields. The new fields provide a more comprehensive and consistent way to access price calculations.Deprecated order-level fields:
totalPrice- usecalculatedPrice.finalPriceinsteadsubTotalPrice- usecalculatedPrice.priceorcalculatedPrice.discountedPriceinsteadtaxAggregate- usecalculatedPrice.finalPrice.taxAggregateinsteadsubtotalAggregate- usecalculatedPrice.priceinsteadtotalDiscount- usecalculatedPrice.totalDiscountinsteadfeeYrnAggregate- usecalculatedPrice.totalFeesanditems[].calculatedPrice.feesinsteadshipping- usecalculatedPrice.totalShippinginsteaditemFeesTotal- usecalculatedPrice.totalFeeinsteadpaymentFeesTotal- usecalculatedPrice.paymentFeesinsteadtotalAuthorizedAmount- usecalculatedPrice.upliftValueinstead
Deprecated order item-level fields:
price- useunitPriceinsteaditemPrice- useunitPriceinsteaditemTaxInfo- usecalculatedPrice.priceinsteadfees- usecalculatedPrice.feesinsteadauthorizedAmount- usecalculatedPrice.upliftValueinsteadtotalDiscount- usecalculatedPrice.totalDiscountinsteadexternalFees- usecalculatedPrice.feesinsteadcouponDiscounts- usecalculatedPrice.totalDiscounts.appliedDiscountsinstead
Updated endpoints
| Endpoint | Description |
|---|---|
| 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 |
Known problems
There are no known problems.