Changelog

Learn more about any recent changes in the Emporix API.

Improvement

Last updated 2024-11-19

Customer Service - custom ID support for addresses

Overview

The Customer Service now supports custom IDs for customer's addresses creation. If the ID is already in use, the service returns a 409 status code.

Updated endpoints

Endpoint	Description
Adding a customer address	The `id` field added.

Known problems

There are no known problems.

Improvement

Last updated 2024-11-15

Customer Management Service - custom ID support

Overview

The Customer Management Service now supports custom IDs for Legal Entities, Locations, Contact Assignments creation. The id field can have 1 - 66 characters and must match ^[a-zA-Z0-9_-]$ regular expression. If the ID is already in use, the service returns a 409 status code.

Updated endpoints

Endpoint	Description
Creating a new legal entity	The `id` field added.
Creating a new location	The `id` field added.
Creating a new contact assignment	The `id` field added.

Known problems

There are no known problems.

Minor

Last updated 2024-11-15

Customer-Management Service - search legal entities endpoint

Overview

The Customer-Management Service has been enhanced with the new endpoint which allows to retrieve legal entities that match criteria provided in request payload.

Added endpoints

Endpoint	Description
Searching for legal entities	The new endpoint which allows to retrieve legal entities by criteria provided in request payload

New Feature

Last updated 2024-11-13

Customer Segment Service - endpoints for managing segments

attention

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

Overview

We added new API for managing customer segments, items assigned to segments and customers assigned to segments.

Added endpoints

Endpoint	Description
Creating a segment	It creates a new segment.
Retrieving segments	It retrieves segments.
Searching for segments	It searches for segments.
Retrieving a segment	It retrieves a segment.
Updating a segment	It updates a segment.
Patching a segment	It partially updates a segment.
Deleting a segment	It deletes a segment.
Creating segments in bulk	It creates segments in bulk.
Updating segments in bulk	It updates segments in bulk.
Deleting segments in bulk	It deletes segments in bulk.
Retrieving customer assignments	It retrieves customer assignments.
Searching for customer assignments	It searches for customer assignments.
Retrieving a customer assignment	It retrieves a customer assignment.
Upserting a customer assignment	It creates or updates a customer assignment.
Deleting a customer assignment	It deletes a customer assignment.
Upserting customer assignments in bulk	It creates or updates customer assignments in bulk.
Deleting customer assignments in bulk	It deletes customer assignments in bulk.
Retrieving item assignments	It retrieves item assignments.
Searching for item assignments	It searches for item assignments.
Retrieving an item assignment	It retrieves an item assignment.
Updating an item assignment	It updates an item assignment.
Removing an item assignment	It removes an item assignment.
Upserting item assignments in bulk	It creates or updates item assignments in bulk.
Deleting item assignments in bulk	It deletes item assignments in bulk.

Known problems

There are no known problems.

Improvement

Last updated 2024-11-13

Customer Service - custom ID support

Overview

The Customer Service now supports custom IDs for customer creation. The id field can have 1 - 66 characters and must match ^[a-zA-Z0-9_-]$ regular expression. If the ID is already in use, the service returns a 409 status code.

Updated endpoints

Endpoint	Description
Creating a new customer	The `id` field added.

Known problems

There are no known problems.

Improvement

Last updated 2024-11-13

Category Service - custom ID support

Overview

The Category Service now supports custom IDs for category creation. If the ID is already in use, the service returns a 409 status code. Along with that upsert operation was introduced that allows to create or update a category based on the provided ID.

Category assignments support upsert operation for single and multiple assignments.

Updated endpoints

Endpoint	Description
Creating a new category	The `id` field added.
Upserting a category	The new endpoint that allows you to either create or update a category with a given id.
Upserting single category assignment	The new endpoint that allows you to either create or update an assignment.
Upserting multiple category assignments	The new endpoint that allows you to either create or update multiple assignments.

Known problems

There are no known problems.

Improvement

Last updated 2024-11-04

Catalog Service - custom ID support

Overview

The Catalog Service now supports custom IDs for catalog creation. The id field can have 1 - 66 characters and must match ^[a-zA-Z0-9_-]$ regular expression. If the ID is already in use, the service will return a 409 status code.

Updated endpoints

Endpoint	Description
Creating a new catalog	The `id` field added.

Known problems

There are no known problems.

Minor

Last updated 2024-10-09

Order Service - discount calculation type

Overview

Updated endpoints

Endpoint	Description
Retrieving all orders	The `discount.discountCalculationType` field added.
Creating an order	The `discount.discountCalculationType` field added.
Retrieving an order	The `discount.discountCalculationType` field added.
Updating an order	The `discount.discountCalculationType` field added.
Partially updating an order	The `discount.discountCalculationType` field added.

Known problems

There are no known problems.

Minor

Last updated 2024-10-09

Cart Service - discount calculation type

Overview

The discount model was expanded with a new field to include the coupon discountCalculationType property, which determines whether the discount is calculated based on the total or subtotal cart value. Also total object was expanded with discount property, which holds discount amount for a given total.

Updated endpoints

Endpoint	Description
Retrieving all carts	The `discount.discountCalculationType` and `total.discount` fields added.
Retrieving a cart	The `discount.discountCalculationType` and `total.discount` fields added.
Applying a discount	The `discountCalculationType` field added.
Retrieving all discounts	The `discountCalculationType` field added.

Known problems

There are no known problems.

Minor

Last updated 2024-10-09

Coupon Service - discount calculation type

Overview

The coupon model was expanded with a discountCalculationType field, which determines whether the discount is calculated based on the total or subtotal order value.

Updated endpoints

Endpoint	Description
Retrieving all coupons	The `discountCalculationType` field added.
Creating a coupon	The `discountCalculationType` field added.
Retrieving a coupon	The `discountCalculationType` field added.
Updating a coupon	The `discountCalculationType` field added.
Partially updating a coupon	The `discountCalculationType` field added.

Known problems

There are no known problems.

Minor

Last updated 2024-10-03

Webhook Service - new event `customer.email-change-request` type

attention

This functionality is now fully operational.

Overview

The event is emitted when a customer requests changing the email. For more information, see Customer events.

Known problems

There are no known problems.

Minor

Last updated 2024-09-26

Order Service - introduction of `feeYrnAggregate` and `fees` fields

Overview

New fields feeYrnAggregate and fees were introduced. The feeYrnAggregate field was added to the order model and the fees field was added to the order entry model. This change allows adding custom externally sources fees to the customer's order.

Updated endpoints

Endpoint	Description
Retrieving orders	The response body schema contains `feeYrnAggregate` and `fees` fields.
Creating a new order	The request body schema contains `feeYrnAggregate` and `fees` fields.
Retrieving a specific order by ID	The response body schema contains `feeYrnAggregate` and `fees` fields.
Updating an order	The request body schema contains `feeYrnAggregate` and `fees` fields.
Partially updating an order	The request body schema contains `feeYrnAggregate` and `fees` fields.
Retrieving a list of orders	The response body schema contains `feeYrnAggregate` and `fees` fields.
Creating a new order	The request body schema contains `feeYrnAggregate` and `fees` fields.
Retrieving order details	The response body schema contains `feeYrnAggregate` and `fees` fields.

Known problems

There are no known problems.

Minor

Last updated 2024-09-26

Cart Service - introduction of `externalFees` field

Overview

New field externalFees was added to the cart item model. This change allows to calculate custom external fees at the customer's cart level.

Updated endpoints

Endpoint	Description
Retrieving a cart's details by criteria	The response body schema of `items` field contains new field `externalFees`.
Retrieving a cart's details by ID	The response body schema of `items` field contains new field `externalFees`.
Adding multiple products to cart	The request body schema contains new field `externalFees`.
Retrieving all products added to a cart	The response body schema contains new field `externalFees`.
Adding a product to cart	The request body schema contains new field `externalFees`.
Retrieving a cart item	The response body schema contains new field `externalFees`.
Updating a cart item	The request body schema contains new field `externalFees`.

Known problems

There are no known problems.

Minor

Last updated 2024-09-11

Site Settings Service - `taxDeterminationBasedOn` property added

Overview

The Site object was expanded with the taxDeterminationBasedOn property, which specifies whether tax calculation is based on a customer's billing or shipping address. Default value is BILLING_ADDRESS.

info

To determine the relevant location to calculate proper taxes, the cart and checkout services read the Tax determination based on setting for the site. This setting determines the proper location by the countryCode from the relevant address. The default setting for a site is the billing address.

If you set the tax determination as shipping address, the country for calculating tax is determined in the following order:

For the cart service:
a. cart's countryCode
b. if the countryCode is not provided for a cart, a customer's default shipping address countryCode
c. if a customer doesn't have a default shipping address, the first customer's shipping address countryCode on the list
d. if a customer doesn't have any shipping addresses, the default countryCode from the site settings
For the checkout service:
a. a shipping address countryCode, provided during checkout
b. if a shipping address is not provided, a customer's billing address countryCode is taken as a fallback

Updated endpoints

Endpoint	Description
Retrieving sites	The `taxDeterminationBasedOn` property allows you to determine the address for relevant tax calculation.
Retrieving a site	The `taxDeterminationBasedOn` property allows you to determine the address for relevant tax calculation.
Creating a site	The `taxDeterminationBasedOn` property allows you to determine the address for relevant tax calculation.
Updating a site	The `taxDeterminationBasedOn` property allows you to determine the address for relevant tax calculation.
Partially updating a site	The `taxDeterminationBasedOn` property allows you to determine the address for relevant tax calculation.

Known problems

There are no known problems.

Minor

Last updated 2024-09-10

Webhook Service - new event `customer.email-change` type

attention

This functionality is now fully operational.

Overview

The event is emitted when a customer confirms changing the email. For more information, see Customer events.

Known problems

There are no known problems.

Minor

Last updated 2024-09-03

Product Service - introduction of `brandId` and `labelIds` field

Overview

New fields brandId and labelIds were added to the product model. Use these fields instead of mixins.productCustomAttributes.brand and mixins.productCustomAttributes.labels.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains two new fields `brandId` and `labelIds`.
Retrieving a product's details	The response body schema contains two new fields `brandId` and `labelIds`.
Retrieving a list of products	The response body schema contains two new fields `brandId` and `labelIds`.
Updating a product's details	The request body schema contains two new fields `brandId` and `labelIds`.
Partially updating a product's details	The request body schema contains two new fields `brandId` and `labelIds`.
Creating multiple products	The request body schema contains two new fields `brandId` and `labelIds`.
Updating products in bulk	The request body schema contains two new fields `brandId` and `labelIds`.

Known problems

There are no known problems.

Minor

Last updated 2024-08-22

Customer Management Service - `name` field not mandatory

Overview

From now on name field is no longer mandatory for creating and updating locations.

Updated endpoints

Endpoint	Description
Creating location	`name` field in request payload is no longer mandatory
Updating location	`name` field in request payload is no longer mandatory

Known problems

There are no known problems.

Minor

Last updated 2024-08-21

Customer Service - `metadataCreatedAt` field in response

Overview

Responses from endpoints for retrieving customers were enriched with the metadataCreatedAt field.

Updated endpoints

Endpoint	Description
Retrieving customers	Response payload contains the `metadataCreatedAt` field.
Retrieving a customer	Response payload contains the `metadataCreatedAt` field.

Known problems

There are no known problems.

Minor

Last updated 2024-08-12

Cart Service - support for external prices

Overview

To handle external prices, the request payload now includes the itemType and tax properties. To fetch external prices, you also need to generate the cart.cart_manage_external_prices scope, set the enableExternalPrices system preference to true, set the price.type to EXTERNAL, and provide the tax values.

Updated endpoints

Endpoint	Description
Adding item to cart	The request includes the `itemType` and `tax` properties.
Adding item to cart in batch	The request includes the `itemType` and `tax` properties.
Updating item in cart	The request includes the `itemType` and `tax` properties.

Known problems

There are no known problems.

Minor

Last updated 2024-08-08

Order Service - introduction of add entries endpoint

Overview

Order Service has a new endpoint that is responsible for modifying and adding new entries to a given order.

New endpoints

Endpoint	Description
Adding entries	A new endpoint for adding entries to existing orders.

Known problems

There are no known problems.

Minor

Last updated 2024-07-23

Configuration Service - introduction of clients endpoint

Overview

Configuration Service has a new endpoint that is responsible for returning list of clients for given tenant.

New endpoints

Endpoint	Description
Retrieving clients	A new endpoint for retrieving clients.

Known problems

There are no known problems.

Minor

Last updated 2024-07-11

Customer Service (customer-managed) - `site` field for password reset requests

Overview

There is a new property site added to password reset model and 'customer.password-reset' event message. It allows to save site from which password reset request was sent.

Updated endpoints

Endpoint	Description
Requesting password reset	The `site` property added to password reset model.

Known problems

There are no known problems.

Minor

Last updated 2024-07-09

Cart Service - introduction of refresh endpoint

Overview

Cart Service has a new endpoint that is responsible for refreshing a specified cart and its items. If the prices assigned to the items in a cart have changed, invoking the endpoint recognizes the changes and reassigns them in the cart.

New endpoints

Endpoint	Description
Refreshing a cart	A new endpoint that refreshes a specified cart and its items.

Known problems

There are no known problems.

Removed

Last updated 2024-07-02

Shopping-list Service - removal of deprecated endpoints

All previously deprecated endpoints are now removed.

Removed endpoints

Endpoint
Fetching all shopping lists - GET /shoppinglists
Creating a shopping list - POST /shoppinglists
Updating a shopping list - PUT /shoppinglists
Removing a shopping list - DELETE /shoppinglists
Fetching a shopping list - GET /shoppinglists/{customerNumber}

Minor

Last updated 2024-06-13

Shipping Service - support for slot delivery method quote

Overview

Shipping Service has a new endpoint that is responsible for calculating the delivery cost for a slot delivery method. Additionally, the cart service can now calculate the shipping cost based on the selected delivery window slot if you provide the slot id and window id.

New endpoints

Endpoint	Description
Calculating the shipping cost for a given slot	A new endpoint that retrieves the minimum delivery cost for a given time slot.

Known problems

There are no known problems.

Minor

Last updated 2024-05-17

Shopping List Service - support for shopping lists mixins

Overview

Shopping List Service from now on supports the mixins feature. Two new properties are available in the model - mixins and metadata.mixins.

Updated endpoints

Endpoint	Description
Fetching all shopping lists	We added the `mixins` and `metadata.mixins` properties.
Creating a shopping list	We added the `mixins` and `metadata.mixins` properties.
Updating a shopping list	We added the `mixins` and `metadata.mixins` properties.
Fetching a shopping list	We added the `mixins` and `metadata.mixins` properties.

Known problems

There are no known problems.

Minor

Last updated 2024-05-15

Webhook Service - new HTTP header for HTTP Webhook Strategy

Overview

A new HTTP header emporix-event-publish-time is from now on attached to all requests sent to destinationUrl of HTTP Webhook Strategy. This header contains a timestamp in RFC3339 UTC "Zulu" format informing about the time at which the message was published.

Known problems

There are no known problems.

Minor

Last updated 2024-05-06

Schema Service - `PRICE_LIST` type support

Overview

We extended the schema with a new PRICE_LIST type.

Updated endpoints

Endpoint	Description
Creating a schema	The new type is available.
Updating a schema	The new type is available.
Updating types of a schema	The new type is available.
Creating a reference	The new type is available.
Updating a reference	The new type is available.

Known problems

There are no known problems.

Minor

Last updated 2024-04-24

Schema Service - support for object attributes

Overview

Schema Service now supports object attributes. The OBJECT type was added to SchemaAttribute.type enum and attributes property was added to SchemaAttribute object. The attributes property contains information about the object's attributes.

Updated endpoints

Endpoint	Description
Creating a schema	Schema attribute in the request body can now be of `OBJECT` type.
Updating a schema	Schema attribute in the request body can now be of `OBJECT` type.

Known problems

There are no known problems.

Minor

Last updated 2024-04-19

Schema Service - support for array attributes

Overview

Schema Service now supports array attributes. ARRAY type was added to SchemaAttribute.type enum and arrayType property was added to SchemaAttribute object. arrayType property contains additional information about array - for example, what is the type of array items.

Updated endpoints

Endpoint	Description
Creating a schema	Schema attribute in the request body can now be of `ARRAY` type.
Updating a schema	Schema attribute in the request body can now be of `ARRAY` type.

Known problems

There are no known problems.

Minor

Last updated 2024-04-15

Cart Service - support for discount deletion by code

Overview

The Cart Service has been updated to enable the removal of discounts using the discount code.

If no discount code is provided, all discounts are removed from the cart, maintaining previous functionality.
A new endpoint has been implemented for retrieving all discounts.
A new attribute called discountIndex has been introduced to allow the removal of discounts by index.

Updated endpoints

Endpoint	Description
Retrieving all cart discounts	New endpoint for getting all discounts from a cart.
Deleting discount by code	New query param `codes` that allows to remove discounts by provided code.

Known problems

There are no known problems.

Minor

Last updated 2024-04-15

Price Service (v2) - support for price lists mixins

Overview

Price Service (v2) from now on supports the mixins feature for price lists. Two new properties are available in the model - mixins and metadata.mixins.

Updated endpoints

Endpoint	Description
Retrieving all price lists	We added the `mixins` and `metadata.mixins` properties.
Retrieving price list by id	We added the `mixins` and `metadata.mixins` properties.
Creating a price list	We added the `mixins` and `metadata.mixins` properties.
Updating a price list	We added the `mixins` and `metadata.mixins` properties.

Known problems

There are no known problems.

Minor

Last updated 2024-04-15

Schema Service - support for nullable attributes

Overview

Schema Service now supports nullable attributes. nullable boolean property was added to SchemaAttribute.metadata object and this property informs whether the attribute could accept null or not. Default value is false.

Updated endpoints

Endpoint	Description
Creating a schema	Schema attribute in the request body can now be nullable.
Updating a schema	Schema attribute in the request body can now be nullable.

Known problems

There are no known problems.

Minor

Last updated 2024-04-10

Schema Service - support for `DECIMAL` type

Overview

Schema Service now supports DECIMAL type. Supported multiplicity is 0.01.

Updated endpoints

Endpoint	Description
Creating a schema	Schema attribute in the request body can now be of `DECIMAL` type.
Updating a schema	Schema attribute in the request body can now be of `DECIMAL` type.

Known problems

There are no known problems.

New Feature

Last updated 2024-03-29

Category Service - new endpoint for creating category assignments in bulk

Overview

A new endpoint has been introduced for creating category assignments in bulk. It allows to create up to 200 assignments by one request.

Updated endpoints

Endpoint	Description
Assigning resources to a category	New endpoint for creating category assignments in bulk.

Known problems

There are no known problems.

Minor

Last updated 2024-03-28

Category Service - `supercategoriesIds` in response

Overview

The endpoint for retrieving a list of categories for which the reference ID is assigned was enriched with expandSupercategoriesIds boolean query parameter. The parameter adds information about IDs of supercategories of a given category to the supercategoriesIds response field.

Updated endpoints

Endpoint	Description
Retrieving a list of categories of the assignment	New `expandSupercategoriesIds` parameter and `supercategoriesIds` field in response are available.

Known problems

There are no known problems.

Minor

Last updated 2024-03-22

Webhook Service - new event `customer.opt-in` type

attention

This functionality is now fully operational.

Overview

The event is emitted when a customer opts in. For more information, see Customer events.

Known problems

There are no known problems.

New Feature

Last updated 2024-03-15

Checkout Service - guest checkout

Overview

We introduce the guest checkout functionality that makes it possible to complete a purchase without a customer account. The customer object in the request now contains the guest field that indicates if a purchase is made by an anonymous or logged in customer.

Updated endpoints

Endpoint	Description
Triggering a checkout	The `customer` object contains the `guest` field. If set to `true`, the checkout process proceeds for a guest customer without the need for registering or logging in.

Known problems

There are no known problems.

Minor

Last updated 2024-03-15

Returns Service - returns for anonymous orders

Overview

The new requestor.anonymous and requestor.email parameters allow creating returns for orders that were created by guest users without a customer account.

Updated endpoints

Endpoint	Description
Creating a single return entity	New `requestor.anonymous` and `requestor.email` parameters are available.

Known problems

There are no known problems.

Minor

Last updated 2024-03-15

Cart Service - `couponDiscounts` field in response

Overview

Responses from endpoints for retrieving cart details were enriched with the couponDiscounts field. The couponDiscounts is an array which contains pairs of couponId and value parameters that indicate how much the item's price was lowered by the given coupon.

Updated endpoints

Endpoint	Description
Getting Carts	Response contains the `couponDiscounts` field.
Getting Cart	Response contains the `couponDiscounts` field.

Known problems

There are no known problems.

Minor

Last updated 2024-03-07

OAuth Service - deprecation of `anonymous_token` parameter

Overview

The anonymous_token parameter is now deprecated when refreshing an anonymous token. We recommend using the refresh_token parameter instead. The deprecated parameter will be removed in 6 months.

Updated endpoints

Endpoint	Description
Refreshing an anonymous token	The `anonymous_token` parameter is now deprecated.

Known problems

There are no known problems.

Minor

Last updated 2024-03-07

Quote Service - generation of quotes using the customer's email and usage of service tokens possibility

Overview

We introduced a new attribute customerEmail for the quote creation schema that allows you to create a quote using the customer's email address.

We updated the Quote Service so that it allows for using a service token (generated from the API Keys in Developer Portal), which is not linked to any specific user. You can perform all Quote Service API operations using the service token. The merchant and customer access tokens can still be used with the Quote API. For more information, see Developer Portal.

Updated endpoints

Endpoint	Description
Creating a new quote	Use the `customerEmail` property to generate a quote for a user's contact email address instead of the customer ID.

Known problems

There are no known problems.

Minor

Last updated 2024-02-26

Coupon Service - coupon code in both upper and lower cases

Overview

A new system preference enableCouponCodeCaseSensitivity is available. It allows you to save the coupon code both in upper and lower case.

Updated endpoints

Endpoint	Description
Creating a new coupon	You can save the `code` property in both upper and lower case.

Known problems

There are no known problems.

Minor

Last updated 2024-02-26

Webhook Service - custom headers

Overview

Config for HTTP provider is now enriched with the headers property. It allows you to define a list of custom headers which are added to the HTTP request.

Updated endpoints

Endpoint	Description
Creating a config	You can define custom `headers` in the request body.
Updating a config	You can define custom `headers` in the request body.
Partially updating a config	You can define custom `headers` in the request body.

Known problems

There are no known problems.

Minor

Last updated 2024-02-22

Invoice Service - invoice API

Overview

There is a new API for generating and verifying invoice creation tasks.

New endpoints

Endpoint	Description
Creating invoice job	It creates a new invoice job.
Retrieving invoice job	It retrieves invoice job details.

Known problems

There are no known problems.

Minor

Last updated 2024-02-09

Category Service - `published` field for assignments

Overview

There is a new property published added to assignment model that is updated automatically based on product published attribute. It allows you to filter out assignments with unpublished products.

Updated endpoints

Endpoint	Description
Retrieving category assignments	We introduced the `hideUnpublishedProducts` parameter. Additionally, we added the `published` attribute into the category assignment model.

Known problems

There are no known problems.

Minor

Last updated 2024-02-06

Customer Management Service - contact to customer transformation

Overview

We introduced a new functionality for transforming a contact to a customer. The transformation happens when type property is changed from CONTACT to CUSTOMER. The action causes sending two emails (if the emails are configured):

reset password email
account activation confirmation email

Updated endpoints

Endpoint	Description
Updating customer	We introduced logic for changing a type from `CONTACT` to `CUSTOMER`.

Known problems

There are no known problems.

Minor

Last updated 2024-02-05

Customer Management Service - `contactDetails.tags` field

Overview

The location model has a new contactDetails.tags property. It allows for labeling the location.

Updated endpoints

Endpoint	Description
Creating a location	Type property `contactDetails.tags` added.
Retrieving all locations	Type property `contactDetails.tags` added.
Retrieving a location	Type property `contactDetails.tags` added.
Updating a location	Type property `contactDetails.tags` added.

Known problems

There are no known problems.

Minor

Last updated 2024-02-05

Cart Service - making cart item properties optional

Overview

Property price.currency for a cart item can be set as optional. There are new system preferences that allow you to disable validation for the property.

Updated endpoints

Endpoint	Description
Adding multiple products to cart	Property `price.currency` can be optional. Validation is configurable by the system preferences.
Adding a product to cart	Property `price.currency` can be optional. Validation is configurable by the system preferences.
Updating a cart item	Property `price.currency` can be optional. Validation is configurable by the system preferences.

Known problems

There are no known problems.

Minor

Last updated 2024-01-23

Webhook Service - configuration API update

attention

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

Overview

We extended config API. PATCH operation is now available and DELETE endpoint now includes the force flag.

Updated endpoints

Endpoint	Description
Removing a config	We added the `force` flag, which allows you to remove active configs.

Added endpoints

Endpoint	Description
Partially updating a config	It partially updates a webhook config.

Known problems

There are no known problems.

Minor

Last updated 2024-01-22

Availability Service - support for mixins

Overview

Availability Service from now on supports the mixins feature. Two new properties are available in the model - mixins and metadata.mixins.

Updated endpoints

Endpoint	Description
Retrieving all availabilities for a site	We added the `mixins` and `metadata.mixins` properties.
Retrieving an availability	We added the `mixins` and `metadata.mixins` properties.
Creating an availability	We added the `mixins` and `metadata.mixins` properties.
Updating an availability information	We added the `mixins` and `metadata.mixins` properties.
Retrieving product availabilities for a site	We added the `mixins` and `metadata.mixins` properties.

Known problems

There are no known problems.

New Feature

Last updated 2024-01-22

Indexing Service - configuration API

Overview

We released new API for configuring indexing providers. The functionality allows you to configure custom Algolia subscription and trigger reindexing the index.

Added endpoints

Endpoint	Description
Creating a config	It creates a new index config.
Retrieving configs	It retrieves all index configs.
Updating a config	It updates an index config.
Retrieving a config	It retrieves an index config.
Removing a config	It removes an index config.
Retrieving public configs	It retrieves all index public configs.
Retrieving a public config	It retrieves an index public config.
Reindexing	It triggers reindex operation.

Known problems

There are no known problems.

New Feature

Last updated 2024-01-11

Webhook Service - configuration API

attention

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

Overview

We added new API for configuring webhook providers.

Added endpoints

Endpoint	Description
Creating a config	It creates a new webhook config.
Retrieving configs	It retrieves webhook configs.
Updating a config	It updates a webhook config.
Retrieving a config	It retrieves a webhook config.
Removing a config	It removes a webhook config.

Known problems

There are no known problems.

Minor

Last updated 2024-01-02

Schema Service - `CUSTOMER.ADDRESS` type support

Overview

We extended the schema with a new CUSTOMER.ADDRESS type.

Updated endpoints

Endpoint	Description
Creating a schema	The new type is available.
Updating a schema	The new type is available.
Updating types of a schema	The new type is available.
Creating a reference	The new type is available.
Updating a reference	The new type is available.

Known problems

There are no known problems.

Minor

Last updated 2023-12-14

Availability Service - removal of scopes from `GET` endpoint

Overview

The endpoint for getting product availability does not require any scopes anymore.

Updated endpoints

Endpoint	Description
Retrieving product availability	The endpoint doesn't require scopes.

Known problems

There are no known problems.

Minor

Last updated 2023-12-14

Shopping-list Service - new endpoints

We introduced new endpoints for shopping-list. They allow for managing a shopping-list either by an employee or by a customer (so far, only a customer was able to manage it).

Added endpoints

Endpoint	Description
Fetching all shopping lists	It fetches all shopping lists. The endpoint requires the `shoppinglist.shoppinglist_read` scope by an employee.
Creating a shopping list	It creates a shopping list. The endpoint requires the `shoppinglist.shoppinglist_manage` scope by an employee.
Updating a shopping list	It updates a shopping list. The endpoint requires the `shoppinglist.shoppinglist_manage` scope by an employee.
Removing a shopping list	It removes a shopping list. The endpoint requires the `shoppinglist.shoppinglist_manage` scope by an employee.
Fetching a shopping list	It fetches a shopping list. The endpoint requires the `shoppinglist.shoppinglist_read` scope by an employee.

Deprecated

Last updated 2023-12-14

Shopping-list Service - deprecation of endpoints

All deprecated endpoints will be removed on 2024/07/01.

Deprecated endpoints

Endpoint
Fetching all shopping lists
Creating a shopping list
Updating a shopping list
Removing a shopping list
Fetching a shopping list

Minor

Last updated 2023-12-07

Coupon Service - creation of coupons after hard deletion

Overview

After a hard deletion of a coupon, it is now possible to create a new coupon with the same code and to reset redemptions count.

Known problems

There are no known problems.

Minor

Last updated 2023-12-01

Coupon Service - support for mixins

Overview

Coupon Service from now on supports the mixins feature. There are two new properties available - mixins and metadata.mixins, which allow you to work with custom fields.

Updated endpoints

Endpoint	Description
Retrieving coupons	We added `mixins` and `metadata.mixins` properties.
Creating a coupon	We added `mixins` and `metadata.mixins` properties.
Retrieving a coupon	We added `mixins` and `metadata.mixins` properties.
Updating a coupon	We added `mixins` and `metadata.mixins` properties.
Partially updating a coupon	We added `mixins` and `metadata.mixins` properties.

Known problems

There are no known problems.

Minor

Last updated 2023-11-23

Cart Service - making cart item properties optional

Overview

Properties price.originalAmount and price.effectiveAmount for a cart item can be optional. There are new system preferences that allow you to disable validation of these properties.

Updated endpoints

Endpoint	Description
Adding multiple products to cart	Properties `price.originalAmount` and `price.effectiveAmount` can be optional. Validation is configurable by the system preferences.
Adding a product to cart	Properties `price.originalAmount` and `price.effectiveAmount` can be optional. Validation is configurable by the system preferences.
Updating a cart item	Properties `price.originalAmount` and `price.effectiveAmount` can be optional. Validation is configurable by the system preferences.

Known problems

There are no known problems.

Minor

Last updated 2023-11-23

Returns Service - `metadata.mixins` field

Overview

There is a new property added to return model - metadata.mixins. It allows for validation of mixins against a provided schema.

Updated endpoints

Endpoint	Description
Creating a return	We added `metadata.mixins` property.
Retrieving returns	We added `metadata.mixins` property.
Retrieving a return	We added `metadata.mixins` property.
Updating a return	We added `metadata.mixins` property.
Partially updating a return	We added `metadata.mixins` property.

Known problems

There are no known problems.

Minor

Last updated 2023-11-17

Coupon Service - permanent deletion of coupons

Overview

There is new property in system preferences, which allows you to permanently delete coupons. If the property is not set or is set to false, the delete coupon endpoint just flags the coupon as deleted. If set to true, the endpoint permanently removes the coupon from the database.

Updated endpoints

Endpoint	Description
Deleting a coupon	Depending on the configuration, it flags coupon as deleted or performs permanent deletion from database.

Known problems

There are no known problems.

Minor

Last updated 2023-11-14

Webhook Service - new event types for Client Management Service

Overview

There are four new events which are emitted during: legal entity creation, legal entity update, legal entity deletion and when user is assigned to a legal entity. For more information, check out Client Management Service events.

Known problems

There are no known problems.

New Feature

Last updated 2023-11-08

Schema Service - new service

attention

This functionality is now fully operational.

Overview

We released the Schema Service that provides validation of custom mixin fields.

New endpoints

Endpoint	Description
Creating a schema	It creates a new schema. The endpoint requires `schema.schema_manage` scope.
Retrieving schemas	It returns all schemas. The endpoint requires `schema.schema_read` scope.
Retrieving a schema	It returns a schema. The endpoint requires `schema.schema_read` scope.
Deleting a schema	It deletes a schema. The endpoint requires `schema.schema_manage` scope.
Updating a schema	It updates a schema. The endpoint requires `schema.schema_manage` scope.
Updating types of a schema	It updates types of a schema. The endpoint requires `schema.schema_manage` scope.
Retrieving types	It returns types. The endpoint requires `schema.schema_read` scope.
Providing a file	It parses json schema and returns parsing results. The endpoint requires `schema.schema_read` scope.
Creating a reference	It creates a new reference. The endpoint requires `schema.schema_manage` scope.
Retrieving references	It returns all references. The endpoint requires `schema.schema_read` scope.
Retrieving a reference	It returns a reference. The endpoint requires `schema.schema_read` scope.
Deleting a reference	It deletes a reference. The endpoint requires `schema.schema_manage` scope.
Updating a reference	It updates a reference. The endpoint requires `schema.schema_manage` scope.

Known problems

There are no known problems.

Minor

Last updated 2023-11-08

Product Service - update of multiple products

Overview

The Product Service API has a new endpoint to update multiple products in bulk. Response for a particular product is returned at the same position (index) at which that product is located in the request body.

New endpoints

Endpoint	Description
Updating multiple products	It updates products in bulk.

Known problems

There are no known problems.

New Feature

Last updated 2023-11-07

Customer Service (customer-managed) - `type` property

Overview

There is a new property in the Customer object. The property is related to the Customer and Contact functionality. It indicates that a particular customer is a standard customer that has access to a storefront, or that the customer is a contact person. If the type field is not provided, the customer is recognized as a standard customer with a storefront access.

Updated endpoints

Endpoint	Description
Updating a customer profile	We added `type` property.
Retrieving a customer profile	We added `type` property.
Creating a new customer	We added `type` property.

Known problems

There are no known problems.

New Feature

Last updated 2023-11-07

Customer Service (customer-managed) - company registration ID property

Overview

A new property is available in the Customer object. The property is related to the Customer Rights and Roles functionality. It indicates if a particular customer is assigned to a particular company. If you provide the company registration ID during the customer sign up, such customer is assigned to existing company straight away. If the company does not exist, it will be created.

Updated endpoints

Endpoint	Description
Patch a customer profile	Company registration ID property has been added.
Get a customer profile	Company registration ID property has been added.
Post a new customer	Company registration ID property has been added.

Known problems

There are no known problems.

New Feature

Last updated 2023-11-07

Customer Service (tenant-managed) - company registration ID property and new scopes

Overview

The Customer object has a new property. The property is related to the Customer Rights and Roles functionality.

We added a new scope customer.customer_read_own to the GET customers endpoints. The scope allows users to read customers, who are assigned to the same company. We added a new scope customer.customer_manage_own to the endpoints. The scope allows users to manage customers who are assigned to the same company.

Updated endpoints

Endpoint	Description
Getting customers	We added the company registration ID property and the `customer.customer_read_own` scope.
Creating a customer	We added the company registration ID property and the `customer.customer_manage_own` scope.
Patching a customer	We added the company registration ID property and the `customer.customer_manage_own` scope.
Getting a single customer	We added the company registration ID property and the `customer.customer_read_own` scope.
Deleting a customer	We added the `customer.customer_read_own` scope.

Known problems

There are no known problems.

New Feature

Last updated 2023-11-07

IAM service - new endpoint and scopes

Overview

IAM service is enhanced with new scopes to give customers more access rights. A new endpoint was added for retrieving customer scopes.

New endpoints

Endpoint	Description
Retrieving own scopes	It allows the customer to get their own scopes.

Updated endpoints

Endpoint	Description
Retrieving all groups	The added `iam.group_read_own` scope allows customers to read the groups of customer types.
Retrieving users assigned to a group	The added `iam.user_read_own` scope allows customers to read user assignments. The users have to be from the same company.
Adding a user to a group	The added `iam.assignment_create_own` scope allows customers to assign other users to the group. The users have to be from the same company.
Removing a user from a group	The added `iam.assignment_delete_own` scope allows customers to unassign users from the group. The users have to be from the same company.

Known problems

There are no known problems.

New Feature

Last updated 2023-11-07

Approval Service - new service

Overview

We released the Approval Service.

New endpoints

Endpoint	Description
Creating an approval	It creates a new approval. The endpoint requires the `approval.approval_manage_own` scope.
Retrieving a list of approvals	It gets all the approvals assigned to the user. The endpoint requires the `approval.approval_read_own` scope.
Retrieving an approval	It gets a single approval by ID assigned to the user. The endpoint requires the `approval.approval_read_own` scope.
Updating an approval	It updates an approval by ID. The endpoint requires the `approval.approval_manage_own` scope.
Deleting an approval	It deletes an approval by ID. The endpoint requires the `approval.approval_manage_own` scope.
Checking the resource approval	It checks if the user has permission to perform given action on the resource. The endpoint requires the `approval.approval_read_own` scope.
Searching for approver users	It retrieves all the users who can approve the approval for a given action on the resource. The endpoint requires the `approval.approval_read_own` scope.

Known problems

There are no known problems.

New Feature

Last updated 2023-10-30

Returns Service - assisted buying property

Overview

The Return object was expanded with a new property. The property is related to Assisted Buying functionality and it indicates that a particular action has been performed by an employee on behalf of a customer.

New endpoints

Endpoint	Description
Retrieving a list of returns	We added assisted buying property.
Retrieving a single return	We added assisted buying property.

Known problems

There are no known problems.

New Feature

Last updated 2023-10-26

Order Service - assisted buying property

Overview

Order object was expanded with a new property. The property is related to Assisted Buying functionality and it indicates that a particular action has been performed by an employee on behalf of a customer.

New endpoints

Endpoint	Description
Retrieving orders	We added assisted buying property.
Retrieving a specific order	We added assisted buying property.

Known problems

There are no known problems.

New Feature

Last updated 2023-10-26

Site Setting Service - assisted buying property

Overview

The Site object was expanded with a new property. The property is related to Assisted Buying functionality and it provides an information about the storefront URL that should be opened when the action is triggered.

New endpoints

Endpoint	Description
Retrieving sites	We added assisted buying property.
Retrieving a site	We added assisted buying property.
Creating a site	We added assisted buying property.
Updating a site	We added assisted buying property.
Partially updating a site	We added assisted buying property.

Known problems

There are no known problems.

Minor

Last updated 2023-10-27

Webhook Service - new event types for customer service

attention

This functionality is now fully operational.

Overview

There are five new events which are emitted during: customer creation, customer update, customer deletion, sending a request to reset a customer's password and resending an account activation link to a customer. For more information, check out Customer Service events.

Known problems

There are no known problems.

New Feature

Last updated 2023-09-06

AI Service - new service

attention

This functionality is now fully operational.

Overview

The service facilitates and streamlines e-commerce processes of product marketing.

Key Features

Integration with https://platform.openai.com/ platform
Possibility to generate product descriptions

New endpoints

Endpoint	Description
Generating text for an object description	It generates a text based on a prompt. Currently supported AI engines for text generation: https://platform.openai.com/.

Known problems

There are no known problems.

Minor

Last updated 2023-08-07

Reward Points Service - redeem option

attention

This functionality is now fully operational.

Overview

The Reward Points Service is enhanced with the new endpoint, which allows employees to update redeem options. We also added metadata to redeem options and from now on when you create a redeem option, metadata is added to it. When retrieving redeem options, the ones without metadata are decorated with metadata version 1.

New endpoints

Endpoint	Description
Updating redemption option	It updates redeem option with given information.

Updated endpoints

Endpoint	Description
Creating redemption option	It creates a redeem option for a given tenant.
Retrieving redemption options	It gets a redeem option for a given tenant.

Known problems

There are no known problems.

Minor

Last updated 2023-08-07

Reward Points Service - deleting redeem option

attention

This functionality is now fully operational.

Overview

The Reward Points Service was enhanced with the new endpoint, which allows employees to delete redeem options by id.

New endpoints

Endpoint	Description
Deleting redemption options	It deletes redeem option by id for a given tenant.

Known problems

There are no known problems.

Minor

Last updated 2023-08-02

Shipping Service - delivery day shift and time zones support

attention

This functionality is now fully operational.

Overview

The Delivery Cycle Management functionality was updated with several new features to enhance user experience and efficiency. It now includes the Delivery Day Shift attribute, which offers users control over the delay period between the cut-off day and the delivery day. To make delivery timings more comprehensible, the functionality now supports timezone specifications, making it clear for which timezone the delivery time is defined.

Updated endpoints

Endpoint	Description
Retrieving all delivery times	It returns all the delivery times defined for the given tenant.
Creating a delivery time	It creates a single delivery time.
Creating multiple delivery times	It creates multiple delivery times in a single request.
Getting a delivery time	It retrieves a specific delivery time.
Updating a delivery time	It updates a single delivery time with a given information.
Partial updating of a delivery time	It partially updates a single delivery time with a given information.

Known problems

There are no known problems.

New Feature

Last updated 2023-07-11

Shipping Service - delivery cycle management

attention

This functionality is now fully operational.

Overview

The Delivery Cycle Management functionality allows for more detailed way of controlling delivery process. It includes creating multiple slots for a single delivery time each with different cut-off times.

New endpoints

Endpoint	Description
Retrieving all delivery times	It returns all the delivery times defined for the given tenant.
Creating a delivery time	It creates a single delivery time.
Creating multiple delivery times	It creates multiple delivery times in a single request.
Getting a delivery time	It retrieves a specific delivery time.
Updating a delivery time	It updates a single delivery time with a given information.
Partial updating of a delivery time	It partially updates a single delivery time with a given information.
Deleting a delivery time	It deletes a specific delivery time with all slots that it had created.
Getting all the delivery time slots	It retrieves all the slots for a given delivery time.
Creating a delivery time slot	It creates a new time slot for the given delivery time.
Deleting all the delivery time slots	It deletes all the time slots for the given delivery time.
Getting a delivery time slot	It retrieves the given delivery time slot's details.
Updating a delivery time slot	It updates a single delivery time slot with given information.
Partial updating of a delivery time slot	It partially updates a single delivery time slot with given information.
Deleting a delivery time slot	It deletes a single delivery time slot.
Generating a delivery cycle	It generates a delivery cycle.

Updated endpoints

Endpoint	Description
Increasing the delivery window counter	Request body contains one new property - `slotId`.
Retrieving delivery windows by cart	Response contains new properties - `slotId`, `deliveryMethod`, `cutOffTime`, `cutOfDay`, `deliveryCycle`.
Retrieving delivery windows by delivery area	Endpoint was deprecated.
Finding sites by postal code	Response contains new properties - `zones.actualDeliveryWindows.deliveryCycle`, `zones.actualDeliveryWindows.deliveryMethod`, `zones.actualDeliveryWindows.cutOffTime`, `zones.actualDeliveryWindows.slotId`.
Retrieving orders	Response contains a new property - `deliveryWindow`.
Creating a new order	Request body contains a new property - `deliveryWindow`.
Retrieving a specific order by ID	Response contains a new property - `deliveryWindow`.
Updating an order	Request body contains a new property - `deliveryWindow`.
Partially updating an order	Request body contains a new property - `deliveryWindow`.
Retrieving a list of orders	Response contains a new property - `deliveryWindow`.
Creating a new order	Request body contains a new property - `deliveryWindow`.
Retrieving order details	Response contains a new property - `deliveryWindow`.
Creating a new cart	Request body contains a new property - `deliveryWindow`.
Retrieving a cart's details by criteria	Response contains a new property - `deliveryWindow`.
Retrieving a cart's details by ID	Response contains a new property - `deliveryWindow`.
Updating a cart	Request body contains a new property - `deliveryWindow`.

Known problems

There are no known problems.

New Feature

Last updated 2023-07-11

Payment Gateway Service - new service

attention

This functionality is now fully operational.

Overview

We released the Payment Gateway Service.

New endpoints

Endpoint	Description
Creating a new payment mode	It creates a new payment mode. The endpoint requires `payment-gateway.paymentmodes_manage` scope.
Updating an existing payment mode	It updates an existing payment mode. The endpoint requires `payment-gateway.paymentmodes_manage` scope.
Deleting an existing payment mode	It deletes an existing payment mode. The endpoint requires `payment-gateway.paymentmodes_manage` scope.
Fetching payment modes	It fetches a list of configured payment modes. The endpoint requires `payment-gateway.paymentmodes_read` scope.
Fetching payment mode	It fetches a single, configured payment mode. The endpoint requires `payment-gateway.paymentmodes_read` scope.
Fetching payment modes publicly	It fetches a list of configured payment modes. The endpoint does not require any scope to be invoked and it returns properties that can be considered as publicly available. It can be used on a frontend.
Fetching payment modes publicly	It fetches a single, configured payment mode. The endpoint does not require any scope to be invoked and it returns properties that can be considered as publicly available. It can be used on a frontend.
Authorizing a payment	It authorizes a given payment. The endpoint requires `payment-gateway.authorize_manage` scope.
Capturing a payment	It captures a given payment. The endpoint requires `payment-gateway.capture_manage` scope.
Refunding a payment	It refunds a given payment. The endpoint requires `payment-gateway.refund_manage` scope.
Cancelling a payment	It captures a given payment. The endpoint requires `payment-gateway.cancel_manage` scope.
Fetching transactions	It fetches a list of payment transactions. The endpoint requires `payment-gateway.paymenttransactions_read` scope.
Fetching transaction	It fetches a single payment transaction. The endpoint requires `payment-gateway.paymenttransactions_read` scope.

Known problems

There are no known problems.

Minor

Last updated 2023-06-01

Webhook Service - new event `order.deleted` type

attention

This functionality is now fully operational.

Overview

The event is emitted when an order is being deleted. For more information, check out Order Service events.

Known problems

There are no known problems.

Minor

Last updated 2023-05-30

Category Service - new `code` property

attention

This functionality is now fully operational.

Overview

The Category Service API has been enhanced with the new property - code.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Creating a new category	The category resource now contains the `code` property.

Known problems

There are no known problems.

Minor

Last updated 2023-05-26

Product Service - creation of multiple products

attention

This functionality is now fully operational.

Overview

The Product Service API has been enhanced with the new endpoint to create multiple products in bulk. The endpoint accepts a list of products. Recommended size of a particular batch is up to 500 products. Response for a particular product is returned at the same position (index) at which that product is located in the request body.

New endpoints

Endpoint	Description
Creating multiple products	It creates products in bulk. Recommended size of a particular batch is up to 500 products.

Known problems

There are no known problems.

Minor

Last updated 2023-05-25

IAM Service - new `b2b` property

attention

This functionality is now fully operational.

Overview

The IAM Service API contains a new property - b2b. Users are now able to link the identifier of legal entity with the tenant group.

Updated endpoints

Endpoint	Description
Retrieving all groups	The `b2b.legalEntityId` property indicates the legal entity for which the group has been created.
Retrieving a group	The `b2b.legalEntityId` property indicates the legal entity for which the group has been created.
Creating a new group	The `b2b.legalEntityId` property indicates the legal entity for which the group has been created.
Updating a group	The `b2b.legalEntityId` property indicates the legal entity for which the group has been created.

Known problems

There are no known problems.

Minor

Last updated 2023-05-25

Customer-Management Service - new `customermanagement.legalentity_read_own` scope

attention

This functionality is now fully operational.

Overview

The Customer-Management Service API has been enhanced with the new scope - customermanagement.legalentity_read_own. Customers are now able to retrieve all their legal entities with the customermanagement.legalentity_read_own scope.

Updated endpoints

Endpoint	Description
Retrieving all legal entities	There is a possibility to retrieve legal entities of the customer using new `customermanagement.legalentity_read_own` scope.

Known problems

There are no known problems.

New Feature

Last updated 2023-05-24

Quote Service - quote reasons

attention

This functionality is now fully operational.

Overview

The quote reason functionality enables the creation and management of quote reasons. Quote reasons contain information why a given quote was declined or a change was requested. They are defined as separate entities through dedicated API and can be used as a reference during status change of the quote.

New endpoints

Endpoint	Description
Creating a quote reason	It creates a new quote reason.
Updating a quote reason	It updates an existing quote reason.
Deleting a quote reason	It deletes an existing quote reason.
Retrieving quote reasons	It gets a list of quote reasons.
Retrieving a single quote reason	It gets a single quote reason.

Updated endpoints

Endpoint	Description
Partially updating a quote	The quote has the `quoteReasonId` property as part of the status which should be provided when changing status of the quote to `DECLINED`, `DECLINED_BY_MERCHANT` or `IN_PROGRESS`.
Retrieving a single quote	The quote can contain `quoteReason` object as part of the `status` field.
Retrieving quotes	The quote can contain `quoteReason` object as part of the `status` field.
Retrieving quote history	Changelogs contain changes of the quotes containing quote reasons reference.

Known problems

There are no known problems.

Minor

Last updated 2023-05-23

Quote Service - shipping information in a quote

attention

This functionality is now fully operational.

Overview

The Quote Service API has been enhanced with shipping object. Users are now able to specify shipping of the quote.

Updated endpoints

Endpoint	Description
Retrieving quotes	The quote has the `shipping` object required to the checkout process.
Retrieving a single quote	The quote has the `shipping` object required to the checkout process.
Partially updating a quote	The `shipping` object can be updated by the PATCH endpoint.
Creating a quote	A new optional field `shipping` was added for quote creation.
Retrieving quote history	Changelogs contain changes of the shipping.

Known problems

There are no known problems.

Major

Last updated 2023-05-23

Order Service - tax of the shipping cost

attention

This functionality is now fully operational.

Overview

The Order Service now contains the tax of the shipping costs. Previously, the order did not store the information about the tax or the tax rate of the shipping costs.

Updated endpoints

Endpoint	Description
Creating a sales order	The shipping line of the response body contains the optional `tax` object.
Retrieving a single sales order	The shipping line of the response body contains the `tax` object.
Retrieving sales order	The shipping line of the response body contains the `tax` object.
Creating an order	The shipping line of the response body contains the optional `tax` object.
Retrieving a single order	The shipping line of the response body contains the `tax` object.
Retrieving orders	The shipping line of the response body contains the `tax` object.

Known problems

There are no known problems.

Minor

Last updated 2023-05-23

Checkout Service - quote checkout process

attention

This functionality is now fully operational.

Overview

The Checkout Service API has been enhanced with the checkout process of the quote. When the request contains quoteId field, the checkout is triggered for the given quote.

Updated endpoints

Endpoint	Description
Triggering a checkout	The `triggering a checkout` request contains the optional `quoteId` field. In case of triggering a checkout of the quote, the `shipping`, `addresses`, and `customer` information is fetched directly from the quote.

Known problems

There are no known problems.

Major

Last updated 2023-05-23

Quote Service - new `orderId` property

attention

This functionality is now fully operational.

Overview

The Quote Service API has been enhanced with the new property - orderId. Users are now able to see the order id from an order created based on the quote.

Updated endpoints

Endpoint	Description
Retrieving quotes	It gets the order id from an order that was created basing on the quote.
Retrieving a single quote	It gets the order id from an order that was created basing on the quote.

Known problems

There are no known problems.

Major

Last updated 2023-05-17

Quote Service - mixins feature

attention

This functionality is now fully operational.

Overview

The Quote Service API has been enhanced with mixins feature. Users are now able to add, manage and read the mixins custom properties.

Updated endpoints

Endpoint	Description
Retrieving quotes	New properties provide support for mixins and mixins metadata.
Retrieving a single quote	New properties provide support for mixins and mixins metadata.
Partially updating a quote	New paths provide support for updating mixins and mixins metadata.
Creating a quote	New properties provide support for mixins and mixins metadata.
Retrieving quote history	Changelogs contain changes in the mixins and mixins metadata.

Known problems

There are no known problems.

Minor

Last updated 2023-05-12

Order Service - new `quoteId` property

attention

This functionality is now fully operational.

Overview

The Order Service API has been enhanced with the new property - quoteId. Merchants are now able to see the id of the quote from which the order has been created.

Updated endpoints

Endpoint	Description
Creating an order	This property indicates from which quote the order has been created.
Getting a list of the orders	This property indicates from which quote the order has been created.
Getting an order	This property indicates from which quote the order has been created.

Known problems

There are no known problems.

Major

Last updated 2023-04-04

Reward Points Service - order status changes

attention

This functionality is now fully operational.

Overview

The Reward Points Service reacts now on the order status changes. When the order status is changed to COMPLETED, the reward points are added to the customer account.

New endpoints

No new endpoints have been introduced.

Known problems

There are no known problems.

New Feature

Last updated 2023-03-31

Quote Service - management of quotations

attention

This functionality is now fully operational.

Overview

The quote management functionality enables the creation and management of quotations. Both the customer flow (accessible from the storefront) and the merchant flow (accessible from the Management Dashboard) are supported.

New endpoints

Endpoint	Description
Creating a quote	It creates a new quote.
Partially updating a quote	It updates an existing quote.
Deleting a quote	It deletes an existing quote.
Retrieving quotes	It gets a list of quotes.
Retrieving a single quote	It gets a single quote.
Retrieving quote history	It gets a single quote changelog.
Creating a quote PDF	It generates a quote PDF.

Known problems

There are no known problems.

Major

Last updated 2023-03-03

Price Service (v2) - validation of mixins

attention

This functionality is now fully operational.

Overview

The Price Service (v2) API has been enhanced with the validation of mixins. Before that, price mixins were not validated against any schema.

New endpoints

No new endpoints have been introduced.

Known problems

There are no known problems.

In progress

Last updated 2022-12-15

Media Service - public and private assets

Overview

The media assets functionality makes it possible to manage public and private assets.

New endpoints

Endpoint	Description
Creating a new asset	It creates a new media asset.
Updating an existing asset	It updates an existing media asset.
Deleting an existing asset	It deletes an existing media asset.
Getting list of asset entities	It gets a list of media assets.
Getting single asset entity	It gets a single media asset.
Downloading an asset	It downloads a single media asset.

Known problems

When particular endpoints become available, they will be announced in the Release Notes.

Minor

Last updated 2022-12-13

Order Service - new recalculate parameter

attention

This functionality is now fully operational.

Overview

The Order Service API has been enhanced with the possibility of recalculating all entries from the order. Users are now able to recalculate prices and coupons of entries.

Updated endpoints

Endpoint	Description
Updating an order	This parameter allows for recalculation of all entries from the order. If set to `true`, the prices and coupons of the entries are recalculated. By default, the `recalculate` parameter is set to `false`.
Partially updating an order	This parameter allows for recalculation of all entries from the order. If set to `true`, the prices and coupons of the entries are recalculated. By default, the `recalculate` parameter is set to `false`.

Known problems

There are no known problems.

Major

Last updated 2022-12-12

Price Service - custom ID support

attention

This functionality is now fully operational.

Overview

The Price Service API has been enhanced with the possibility of specifying custom IDs for prices. Users are now able to specify price IDs during price creation. In this case, the IDs are no longer generated automatically.

Updated endpoints

Endpoint	Description
Creating a new price model	It creates a new price model.
Creating a new price	It creates a new price.
Creating new prices in bulk	It creates new prices in bulk.
Creating a new price list	It creates a new price list.
Creating a new price list price	It creates a new price list price.
Creating new price list prices in bulk	It creates new price list prices in bulk.

Known problems

There are no known problems.

New Feature

Last updated 2022-11-30

Session Context Service - session context

attention

This functionality is now fully operational.

Overview

The Session Context Service provides the ability to manage a customer's browser session context, enabling the application of contextual pricing based on the user's session.

New endpoints

Endpoint	Description
Retrieving a session context	It retrieves a session context.
Updating a session context	It updates a session context.
Adding a new attribute to a session context	It adds a new attribute to session context.
Deleting an attribute from a session context	It deletes an attribute from a session context.
Retrieving own session context	It retrieves own session context.
Partially updating own session context	It updates own session context.
Adding a new attribute to own session context	It adds a new attribute to own session context.
Deleting an attribute from own session context	It deletes an attribute from own session context.

In progress

Last updated 2022-11-17

Returns Service - returns lifecycle

Overview

The order return functionality makes it possible to manage a lifecycle of an order return. A return can be managed by a customer or by an employee (on behalf of a customer).

New endpoints

Endpoint	Description
Creating a new return entity	It creates a new order return.
Updating an existing return entity	It updates an existing order return.
Deleting an existing return entity	It deletes an existing order return.
Getting list of return entities	It gets a list of order returns.
Getting single return entities	It gets a single order return.

Known problems

When particular endpoints become available, they will be announced in the Release Notes.

Major

Last updated 2022-11-09

Brands Service - localization and filtering

attention

This functionality is now fully operational.

Overview

The names and descriptions of brands present in the system can now be localized.

The q param notation was introduced to the Retrieving all brands endpoint, so it is now possible to filter the results by every field.

info

For more detailed information, check out the API Reference documentation for the Retrieving all brands endpoint.

Updated endpoints

Endpoint	Description
Retrieving all brands	The response body contains two new fields `localizedName` and `localizedDescription`. Filtering is now supported using the `q` query parameter.
Adding a new brand	The response body contains two new optional fields — `localizedName` and `localizedDescription`.
Retrieving a brand	The response body contains two new fields `localizedName` and `localizedDescription`.
Updating a brand	The response body contains two new optional fields `localizedName` and `localizedDescription`.

Major

Last updated 2022-11-08

Product Service - product bundles

attention

This functionality is now fully operational.

Overview

The product variants functionality makes it possible to create many variants of a product based on variant attributes.

The original product model is now extended with two optional fields:

variantAttributes — can only be set to a product of the PARENT_VARIANT type. It defines the combination of variants to be created.
parentVariantId — can only be set to a product of the VARIANT type. It indicates the id of the PARENT_VARIANT product.

The productType field can be set to the following new values:

productType — can be set to either BASIC, BUNDLE, PARENT_VARIANT orVARIANT. The productType value is immutable - once set, it cannot be changed during the product update.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains two new fields `variantAttributes` and `parentVariantId`.
Retrieving a product's details	The request body schema contains two new fields `variantAttributes` and `parentVariantId`.
Retrieving a list of products	The request body schema contains two new fields `variantAttributes` and `parentVariantId`.
Updating a product's details	The request body schema contains one new field `variantAttributes`.
Partially updating a product's details	The request body schema contains one new optional field `variantAttributes`.

Major

Last updated 2022-10-04

Webhooks Service - subscription to events

attention

This functionality is now fully operational.

Overview

The webhooks functionality makes it possible to subscribe to events that are broadcast by the Emporix e-commerce system.

New endpoints

Endpoint	Description
Retrieving all subscriptions	It retrieves all events with associated subscription details.
Subscribing and unsubscribing from events	It updates the subscriptions list by either subscribing or unsubscribing from specified events.
Retrieving a dashboard access URL	It retrieves a Svix magic login link (authentication embedded) and an authentication token needed to connect a tenant to their consumer application portal.
Retrieving webhook statistics	It retrieves statistics on the number of emitted events and provides information on the limit of webhook notifications configured for a specific tenant.

Major

Last updated 2022-09-23

Product Service - product accessories / consumables

attention

This functionality is now fully operational.

Overview

The product accessories / consumables functionality makes it possible to define information about related items, like accessories.

The original product model is now extended with an optional field:

relatedItems — array of relatedItem objects.

The relatedItem object consists of the following mandatory fields:

refId — identifier of a product that is related to the main product. The product identifier has to exist.
type — relation type. The type has to exist in the system. All relation types are defined in configuration service under the relation_types key. There are two relation types available out of the box: ACCESSORY and CONSUMABLE.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains a new optional field `relatedItems`.
Retrieving a product's details	The request body schema contains a new optional field `relatedItems`.
Retrieving a list of products	The request body schema contains a new optional field `relatedItems`.
Updating a product's details	The request body schema contains a new optional field `relatedItems`.

Major

Last updated 2022-09-19

Product Service - product bundles

attention

This functionality is now fully operational.

Overview

The product bundles functionality makes it possible to create products that consist of other products.

The original product model is now extended with two optional fields:

productType — can be set to either BASIC or BUNDLE. The productType value is immutable - once set, it cannot be changed during product update.
bundledProducts — a list containing IDs of products that are included in the bundle.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains two optional fields `productType` and `bundledProducts`.
Retrieving a product's details	The request body schema contains two optional fields `productType` and `bundledProducts`.
Retrieving a list of products	The request body schema contains two optional fields `productType` and `bundledProducts`.
Updating a product's details	The request body schema contains one optional field `bundledProducts`.

Major

Last updated 2022-09-19

Order Service - PDF-mashup for product bundles

attention

This functionality is now fully operational.

Overview

The pdf-mashup service allows you to define product bundles in a new way. When the product is of the BUNDLE type (productType: BUNDLE) and contains products' ids in the bundledProducts fields, the pdf-mashup service generates the packlist.pdf and picklist.pdf files that list all products constituting the bundle.To support this feature, the Order Service has been extended with the order.entries.product model by introducing two new fields:

productType — provides information about the product's type. Possible values: BASIC, BUNDLE, PARENT_VARIANT, VARIANT.
bundledProducts — lists the productId and amount pairs that contain information about products assigned to a given bundle.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Retrieving details about an order (by a customer)	The response body schema of the `order.entries.product` model contains two optional fields `productType` and `bundledProducts`.
Retrieving a list of orders (for customer)	The response body schema of the `order.entries.product` model contains two optional fields `productType` and `bundledProducts`.
Creating new order (by a merchant)	The request body schema of the `order.entries.product` model contains two optional fields `productType` and `bundledProducts`.
Updating order (by a merchant)	The request body schema of the `order.entries.product` model contains two optional fields `productType` and `bundledProducts`.

Major

Last updated 2022-09-15

Product Service - product templates

attention

This functionality is now fully operational.

Overview

The product template functionality makes it possible to define a set of attributes that are common for all product instances based on a particular product template.

New endpoints

Endpoint	Description
Creating a new product template	It creates a new product template.
Getting a product template	It retrieves a single product template.
Getting a list of product templates	It retrieves a list of product templates.
Updating a product template	It updates an existing product template. Each update creates a new version of the template. Products based on earlier versions of the template are not updated automatically. In order to see the changes (such as new attributes) on the product level, you need to update the product template's `version` in a relevant `Product` object.
Deleting a product template	It deletes a product template. All products based on a deleted template will be unassigned from the template, but not deleted in a cascade way.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.
Retrieving a product's details	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.
Retrieving a list of products	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.
Updating a product's details	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.

In progress

Last updated 2022-09-13

Product Service - product accessories / consumables

Overview

The product accessories / consumables functionality makes it possible to define information about related items, like accessories.

The original product model is now extended with an optional field:

relatedItems — array of relatedItem objects.

The relatedItem object consists of the following mandatory fields:

refId — identifier of a product that is related to the main product. The product identifier has to exist.
type — relation type. The type has to exist in the system. All relation types are defined in configuration service under the relation_types key. There are two relation types available out of the box: ACCESSORY and CONSUMABLE.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains a new optional field `relatedItems`.
Retrieving a product's details	The request body schema contains a new optional field `relatedItems`.
Retrieving a list of products	The request body schema contains a new optional field `relatedItems`.
Updating a product's details	The request body schema contains a new optional field `relatedItems`.

Known problems

When particular endpoints become available, they will be announced in Release Notes.

In progress

Last updated 2022-09-06

Customer Management Service - business customers

Overview

The customer management functionality makes it possible to manage information about your business customers.

New endpoints

Endpoint	Description
Legal entities management	CRUD¹ operations for managing legal entities. A legal entity is a representation of a company or its subsidiary.
Location management	CRUD operations for managing locations. A location is a physical address where a company operates, such as its headquarters, office, or warehouse.
Contact management	CRUD operations for contact management. A contact is an employee of one or more legal entities who can be contacted regarding business matters.
Contact assignments	CRUD operations for assignments of contacts to legal entities. A contact can be assigned to a company or a subsidiary.

Known problems

When particular endpoints become available, they will be announced in Release Notes.

Minor

Last updated 2022-08-26

Product Service - improvements

The following changes have been introduced to the Emporix Product Service:

Endpoint	Description
Creating a new product	Localized fields have been introduced. The `Content-Language` header has been introduced. It can be set to one of the following values: `*` — localized fields should provided in the form of a map, where each key is a language code (compliant with the ISO 639-1 standard) and each value represents a translation in the specified language. `en` — localized fields should be provided in the form of strings, where values represent translations in the specified language. — when the value is empty or the header is not specified, localized fields should be provided in the form of strings, where values represent translations in the tenant's default language.
Updating a product	In case of a successful product update, a `204` status code is now returned. Before the changes, the status code was `200`. Optimistic locking has been introduced. The `metadata.version` field is required during update.
Deleting a product	The `204` status code is now returned in two cases: A successful product removal. Removal of a product that does not exist.

In progress

Last updated 2022-08-05

Webhooks Service - subscription to events

Overview

The webhooks functionality makes it possible to subscribe to events that are broadcast by the Emporix e-commerce system.

New endpoints

Endpoint	Description
Retrieving all subscriptions	It retrieves all events with associated subscription details.
Subscribing and unsubscribing from events	It updates the subscriptions list by either subscribing or unsubscribing from specified events.
Retrieving a dashboard access URL	It retrieves a Svix magic login link (authentication embedded) and an authentication token needed to connect a tenant to their consumer application portal.

Known problems

When particular endpoints become available, they will be announced in Release Notes.

Deprecated

Last updated 2022-08-02

Product Service - removal of a deprecated endpoint

Deprecated endpoint for deleting all products assigned to the tenant has been removed from the Emporix API Product Service Reference.

Removed endpoints

Endpoint	Description
Deleting all products	It deletes all products assigned to the tenant.

New Feature

Last updated 2022-07-28

Product Service - product bundles

attention

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

Overview

The product bundles functionality makes it possible to create products that consist of other products.

The original product model is now extended with two optional fields:

productType — can be set to either BASIC or BUNDLE. The productType value is immutable - once set, it cannot be changed during product update.
bundledProducts — a list containing IDs of products that are included in the bundle.

New endpoints

No new endpoints have been introduced.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains two optional fields `productType` and `bundledProducts`.
Retrieving a product's details	The request body schema contains two optional fields `productType` and `bundledProducts`.
Retrieving a list of products	The request body schema contains two optional fields `productType` and `bundledProducts`.
Updating a product's details	The request body schema contains one optional field `bundledProducts`.

Known problems

The product bundles functionality is in preview mode, which means the new endpoints may not be fully operational yet. When particular endpoints become available, they will be announced in Release Notes.

In progress

Last updated 2022-07-27

Product Service - product templates

attention

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

Overview

The product template functionality makes it possible to define a set of attributes that are common for all product instances based on a particular product template.

New endpoints

Endpoint	Description
Creating a new product template	It creates a new product template.
Getting a product template	It retrieves a single product template.
Getting a list of product templates	It retrieves a list of product templates.
Updating a product template	It updates an existing product template. Each update creates a new version of the template. Products based on earlier versions of the template are not updated automatically. In order to see the changes (such as new attributes) on the product level, you need to update the product template's `version` in a relevant `Product` object.
Deleting a product template	It deletes a product template. All products based on a deleted template will be unassigned from the template, but not deleted in a cascade way.

Updated endpoints

Endpoint	Description
Creating a new product	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.
Retrieving a product's details	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.
Retrieving a list of products	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.
Updating a product's details	The request body schema contains a new optional field called `template`. The `template` field consists of two fields: `id` and `version`.

Known problems

The product templates functionality is in preview mode, which means the new endpoints may not be fully operational yet. When particular endpoints become available, they will be announced in Release Notes.

CRUD — create, read, update, delete.↩

Changelog

Customer Service - custom ID support for addresses

Overview

Updated endpoints

Known problems

Customer Management Service - custom ID support

Overview

Updated endpoints

Known problems

Customer-Management Service - search legal entities endpoint

Overview

Added endpoints

Customer Segment Service - endpoints for managing segments

attention

Overview

Added endpoints

Known problems

Customer Service - custom ID support

Overview

Updated endpoints

Known problems

Category Service - custom ID support

Overview

Updated endpoints

Known problems

Catalog Service - custom ID support

Overview

Updated endpoints

Known problems

Order Service - discount calculation type

Overview

Updated endpoints

Known problems

Cart Service - discount calculation type

Overview

Updated endpoints

Known problems

Coupon Service - discount calculation type

Overview

Updated endpoints

Known problems

Webhook Service - new event customer.email-change-request type

attention

Overview

Known problems

Order Service - introduction of feeYrnAggregate and fees fields

Overview

Updated endpoints

Known problems

Cart Service - introduction of externalFees field

Overview

Updated endpoints

Known problems

Site Settings Service - taxDeterminationBasedOn property added

Overview

info

Updated endpoints

Known problems

Webhook Service - new event customer.email-change type

attention

Overview

Known problems

Product Service - introduction of brandId and labelIds field

Overview

Updated endpoints

Known problems

Customer Management Service - name field not mandatory

Overview

Updated endpoints

Known problems

Customer Service - metadataCreatedAt field in response

Overview

Updated endpoints

Known problems

Cart Service - support for external prices

Overview

Updated endpoints

Known problems

Order Service - introduction of add entries endpoint

Overview

Webhook Service - new event `customer.email-change-request` type

Order Service - introduction of `feeYrnAggregate` and `fees` fields

Cart Service - introduction of `externalFees` field

Site Settings Service - `taxDeterminationBasedOn` property added

Webhook Service - new event `customer.email-change` type

Product Service - introduction of `brandId` and `labelIds` field

Customer Management Service - `name` field not mandatory

Customer Service - `metadataCreatedAt` field in response

Customer Service (customer-managed) - `site` field for password reset requests

Schema Service - `PRICE_LIST` type support

Schema Service - support for `DECIMAL` type

Category Service - `supercategoriesIds` in response

Webhook Service - new event `customer.opt-in` type