Changelog

Learn more about any recent changes in the Emporix API.

Minor

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

EndpointDescription
Requesting password reset'site' property added to password reset model

Known problems

There are no known problems.


Minor

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

EndpointDescription
Refreshing a cartA new endpoint that refreshes a specified cart and its items.

Known problems

There are no known problems.


Removed

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

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

EndpointDescription
Calculating the shipping cost for a given slotA new endpoint that retrieves the minimum delivery cost for a given time slot.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Fetching all shopping listsWe added the mixins and metadata.mixins properties.
Creating a shopping listWe added the mixins and metadata.mixins properties.
Updating a shopping listWe added the mixins and metadata.mixins properties.
Fetching a shopping listWe added the mixins and metadata.mixins properties.

Known problems

There are no known problems.


Minor

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

Schema Service - PRICE_LIST type support

Overview

We extended the schema with a new PRICE_LIST type.

Updated endpoints

EndpointDescription
Creating a schemaThe new type is available.
Updating a schemaThe new type is available.
Updating types of a schemaThe new type is available.
Creating a referenceThe new type is available.
Updating a referenceThe new type is available.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating a schemaSchema attribute in the request body can now be of OBJECT type.
Updating a schemaSchema attribute in the request body can now be of OBJECT type.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating a schemaSchema attribute in the request body can now be of ARRAY type.
Updating a schemaSchema attribute in the request body can now be of ARRAY type.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving all cart discountsNew endpoint for getting all discounts from a cart.
Deleting discount by codeNew query param codes that allows to remove discounts by provided code.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving all price listsWe added the mixins and metadata.mixins properties.
Retrieving price list by idWe added the mixins and metadata.mixins properties.
Creating a price listWe added the mixins and metadata.mixins properties.
Updating a price listWe added the mixins and metadata.mixins properties.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating a schemaSchema attribute in the request body can now be nullable.
Updating a schemaSchema attribute in the request body can now be nullable.

Known problems

There are no known problems.

Minor

Schema Service - support for DECIMAL type

Overview

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

Updated endpoints

EndpointDescription
Creating a schemaSchema attribute in the request body can now be of DECIMAL type.
Updating a schemaSchema attribute in the request body can now be of DECIMAL type.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Assigning resources to a categoryNew endpoint for creating category assignments in bulk.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving a list of categories of the assignmentNew expandSupercategoriesIds parameter and supercategoriesIds field in response are available.

Known problems

There are no known problems.


Minor

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

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

EndpointDescription
Triggering a checkoutThe 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

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

EndpointDescription
Creating a single return entityNew requestor.anonymous and requestor.email parameters are available.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Getting CartsResponse contains the couponDiscounts field.
Getting CartResponse contains the couponDiscounts field.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Refreshing an anonymous tokenThe anonymous_token parameter is now deprecated.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating a new quoteUse 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

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

EndpointDescription
Creating a new couponYou can save the code property in both upper and lower case.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating a configYou can define custom headers in the request body.
Updating a configYou can define custom headers in the request body.
Partially updating a configYou can define custom headers in the request body.

Known problems

There are no known problems.


Minor

Invoice Service - invoice API

Overview

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

New endpoints

EndpointDescription
Creating invoice jobIt creates a new invoice job.
Retrieving invoice jobIt retrieves invoice job details.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving category assignmentsWe introduced the hideUnpublishedProducts parameter. Additionally, we added the published attribute into the category assignment model.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Updating customerWe introduced logic for changing a type from CONTACT to CUSTOMER.

Known problems

There are no known problems.


Minor

Customer Management Service - contactDetails.tags field

Overview

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

Updated endpoints

EndpointDescription
Creating a locationType property contactDetails.tags added.
Retrieving all locationsType property contactDetails.tags added.
Retrieving a locationType property contactDetails.tags added.
Updating a locationType property contactDetails.tags added.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Adding multiple products to cartProperty price.currency can be optional. Validation is configurable by the system preferences.
Adding a product to cartProperty price.currency can be optional. Validation is configurable by the system preferences.
Updating a cart itemProperty price.currency can be optional. Validation is configurable by the system preferences.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Removing a configWe added the force flag, which allows you to remove active configs.

Added endpoints

EndpointDescription
Partially updating a configIt partially updates a webhook config.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving all availabilities for a siteWe added the mixins and metadata.mixins properties.
Retrieving an availabilityWe added the mixins and metadata.mixins properties.
Creating an availabilityWe added the mixins and metadata.mixins properties.
Updating an availability informationWe added the mixins and metadata.mixins properties.
Retrieving product availabilities for a siteWe added the mixins and metadata.mixins properties.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Creating a configIt creates a new index config.
Retrieving configsIt retrieves all index configs.
Updating a configIt updates an index config.
Retrieving a configIt retrieves an index config.
Removing a configIt removes an index config.
Retrieving public configsIt retrieves all index public configs.
Retrieving a public configIt retrieves an index public config.
ReindexingIt triggers reindex operation.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Creating a configIt creates a new webhook config.
Retrieving configsIt retrieves webhook configs.
Updating a configIt updates a webhook config.
Retrieving a configIt retrieves a webhook config.
Removing a configIt removes a webhook config.

Known problems

There are no known problems.


Minor

Schema Service - CUSTOMER.ADDRESS type support

Overview

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

Updated endpoints

EndpointDescription
Creating a schemaThe new type is available.
Updating a schemaThe new type is available.
Updating types of a schemaThe new type is available.
Creating a referenceThe new type is available.
Updating a referenceThe new type is available.

Known problems

There are no known problems.


Minor

Availability Service - removal of scopes from GET endpoint

Overview

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

Updated endpoints

EndpointDescription
Retrieving product availabilityThe endpoint doesn't require scopes.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Fetching all shopping listsIt fetches all shopping lists. The endpoint requires the shoppinglist.shoppinglist_read scope by an employee.
Creating a shopping listIt creates a shopping list. The endpoint requires the shoppinglist.shoppinglist_manage scope by an employee.
Updating a shopping listIt updates a shopping list. The endpoint requires the shoppinglist.shoppinglist_manage scope by an employee.
Removing a shopping listIt removes a shopping list. The endpoint requires the shoppinglist.shoppinglist_manage scope by an employee.
Fetching a shopping listIt fetches a shopping list. The endpoint requires the shoppinglist.shoppinglist_read scope by an employee.

Deprecated

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

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

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

EndpointDescription
Retrieving couponsWe added mixins and metadata.mixins properties.
Creating a couponWe added mixins and metadata.mixins properties.
Retrieving a couponWe added mixins and metadata.mixins properties.
Updating a couponWe added mixins and metadata.mixins properties.
Partially updating a couponWe added mixins and metadata.mixins properties.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Adding multiple products to cartProperties price.originalAmount and price.effectiveAmount can be optional. Validation is configurable by the system preferences.
Adding a product to cartProperties price.originalAmount and price.effectiveAmount can be optional. Validation is configurable by the system preferences.
Updating a cart itemProperties price.originalAmount and price.effectiveAmount can be optional. Validation is configurable by the system preferences.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating a returnWe added metadata.mixins property.
Retrieving returnsWe added metadata.mixins property.
Retrieving a returnWe added metadata.mixins property.
Updating a returnWe added metadata.mixins property.
Partially updating a returnWe added metadata.mixins property.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Deleting a couponDepending on the configuration, it flags coupon as deleted or performs permanent deletion from database.

Known problems

There are no known problems.


Minor

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

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

EndpointDescription
Creating a schemaIt creates a new schema. The endpoint requires schema.schema_manage scope.
Retrieving schemasIt returns all schemas. The endpoint requires schema.schema_read scope.
Retrieving a schemaIt returns a schema. The endpoint requires schema.schema_read scope.
Deleting a schemaIt deletes a schema. The endpoint requires schema.schema_manage scope.
Updating a schemaIt updates a schema. The endpoint requires schema.schema_manage scope.
Updating types of a schemaIt updates types of a schema. The endpoint requires schema.schema_manage scope.
Retrieving typesIt returns types. The endpoint requires schema.schema_read scope.
Providing a fileIt parses json schema and returns parsing results. The endpoint requires schema.schema_read scope.
Creating a referenceIt creates a new reference. The endpoint requires schema.schema_manage scope.
Retrieving referencesIt returns all references. The endpoint requires schema.schema_read scope.
Retrieving a referenceIt returns a reference. The endpoint requires schema.schema_read scope.
Deleting a referenceIt deletes a reference. The endpoint requires schema.schema_manage scope.
Updating a referenceIt updates a reference. The endpoint requires schema.schema_manage scope.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Updating multiple productsIt updates products in bulk.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Updating a customer profileWe added type property.
Retrieving a customer profileWe added type property.
Creating a new customerWe added type property.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Patch a customer profileCompany registration ID property has been added.
Get a customer profileCompany registration ID property has been added.
Post a new customerCompany registration ID property has been added.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Getting customersWe added the company registration ID property and the customer.customer_read_own scope.
Creating a customerWe added the company registration ID property and the customer.customer_manage_own scope.
Patching a customerWe added the company registration ID property and the customer.customer_manage_own scope.
Getting a single customerWe added the company registration ID property and the customer.customer_read_own scope.
Deleting a customerWe added the customer.customer_read_own scope.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Retrieving own scopesIt allows the customer to get their own scopes.

Updated endpoints

EndpointDescription
Retrieving all groupsThe added iam.group_read_own scope allows customers to read the groups of customer types.
Retrieving users assigned to a groupThe 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 groupThe 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 groupThe 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

Approval Service - new service

Overview

We released the Approval Service.

New endpoints

EndpointDescription
Creating an approvalIt creates a new approval. The endpoint requires the approval.approval_manage_own scope.
Retrieving a list of approvalsIt gets all the approvals assigned to the user. The endpoint requires the approval.approval_read_own scope.
Retrieving an approvalIt gets a single approval by ID assigned to the user. The endpoint requires the approval.approval_read_own scope.
Updating an approvalIt updates an approval by ID. The endpoint requires the approval.approval_manage_own scope.
Deleting an approvalIt deletes an approval by ID. The endpoint requires the approval.approval_manage_own scope.
Checking the resource approvalIt 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 usersIt 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

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

EndpointDescription
Retrieving a list of returnsWe added assisted buying property.
Retrieving a single returnWe added assisted buying property.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Retrieving ordersWe added assisted buying property.
Retrieving a specific orderWe added assisted buying property.

Known problems

There are no known problems.


New Feature

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

EndpointDescription
Retrieving sitesWe added assisted buying property.
Retrieving a siteWe added assisted buying property.
Creating a siteWe added assisted buying property.
Updating a siteWe added assisted buying property.
Partially updating a siteWe added assisted buying property.

Known problems

There are no known problems.


New Feature

Customer Service (tenant-managed) - assisted buying login endpoint

Overview

The functionality provides a possibility to generate an auth token by an employee on behalf of a customer. Only the employees that belong to the support group, meaning they have customer.assistedBuying_manage scope assigned, can perform the action.

New endpoints

EndpointDescription
Generating a customer tokenIt generates an auth token on behalf of a customer.

Known problems

There are no known problems.


Minor

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

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

New endpoints

EndpointDescription
Generating text for an object descriptionIt 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

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

EndpointDescription
Updating redemption optionIt updates redeem option with given information.

Updated endpoints

EndpointDescription
Creating redemption optionIt creates a redeem option for a given tenant.
Retrieving redemption optionsIt gets a redeem option for a given tenant.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Deleting redemption optionsIt deletes redeem option by id for a given tenant.

Known problems

There are no known problems.


Minor

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

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

Known problems

There are no known problems.


New Feature

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

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

Updated endpoints

EndpointDescription
Increasing the delivery window counterRequest body contains one new property - slotId.
Retrieving delivery windows by cartResponse contains new properties - slotId, deliveryMethod, cutOffTime, cutOfDay, deliveryCycle.
Retrieving delivery windows by delivery areaEndpoint was deprecated.
Finding sites by postal codeResponse contains new properties - zones.actualDeliveryWindows.deliveryCycle, zones.actualDeliveryWindows.deliveryMethod, zones.actualDeliveryWindows.cutOffTime, zones.actualDeliveryWindows.slotId.
Retrieving ordersResponse contains a new property - deliveryWindow.
Creating a new orderRequest body contains a new property - deliveryWindow.
Retrieving a specific order by IDResponse contains a new property - deliveryWindow.
Updating an orderRequest body contains a new property - deliveryWindow.
Partially updating an orderRequest body contains a new property - deliveryWindow.
Retrieving a list of ordersResponse contains a new property - deliveryWindow.
Creating a new orderRequest body contains a new property - deliveryWindow.
Retrieving order detailsResponse contains a new property - deliveryWindow.
Creating a new cartRequest body contains a new property - deliveryWindow.
Retrieving a cart's details by criteriaResponse contains a new property - deliveryWindow.
Retrieving a cart's details by IDResponse contains a new property - deliveryWindow.
Updating a cartRequest body contains a new property - deliveryWindow.

Known problems

There are no known problems.


New Feature

Payment Gateway Service - new service

attention

This functionality is now fully operational.

Overview

We released the Payment Gateway Service.

New endpoints

EndpointDescription
Creating a new payment modeIt creates a new payment mode. The endpoint requires payment-gateway.paymentmodes_manage scope.
Updating an existing payment modeIt updates an existing payment mode. The endpoint requires payment-gateway.paymentmodes_manage scope.
Deleting an existing payment modeIt deletes an existing payment mode. The endpoint requires payment-gateway.paymentmodes_manage scope.
Fetching payment modesIt fetches a list of configured payment modes. The endpoint requires payment-gateway.paymentmodes_read scope.
Fetching payment modeIt fetches a single, configured payment mode. The endpoint requires payment-gateway.paymentmodes_read scope.
Fetching payment modes publiclyIt 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 publiclyIt 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 paymentIt authorizes a given payment. The endpoint requires payment-gateway.authorize_manage scope.
Capturing a paymentIt captures a given payment. The endpoint requires payment-gateway.capture_manage scope.
Refunding a paymentIt refunds a given payment. The endpoint requires payment-gateway.refund_manage scope.
Cancelling a paymentIt captures a given payment. The endpoint requires payment-gateway.cancel_manage scope.
Fetching transactionsIt fetches a list of payment transactions. The endpoint requires payment-gateway.paymenttransactions_read scope.
Fetching transactionIt fetches a single payment transaction. The endpoint requires payment-gateway.paymenttransactions_read scope.

Known problems

There are no known problems.


Minor

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

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

EndpointDescription
Creating a new categoryThe category resource now contains the code property.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating multiple productsIt creates products in bulk. Recommended size of a particular batch is up to 500 products.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving all groupsThe b2b.legalEntityId property indicates the legal entity for which the group has been created.
Retrieving a groupThe b2b.legalEntityId property indicates the legal entity for which the group has been created.
Creating a new groupThe b2b.legalEntityId property indicates the legal entity for which the group has been created.
Updating a groupThe b2b.legalEntityId property indicates the legal entity for which the group has been created.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving all legal entitiesThere 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

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

EndpointDescription
Creating a quote reasonIt creates a new quote reason.
Updating a quote reasonIt updates an existing quote reason.
Deleting a quote reasonIt deletes an existing quote reason.
Retrieving quote reasonsIt gets a list of quote reasons.
Retrieving a single quote reasonIt gets a single quote reason.

Updated endpoints

EndpointDescription
Partially updating a quoteThe 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 quoteThe quote can contain quoteReason object as part of the status field.
Retrieving quotesThe quote can contain quoteReason object as part of the status field.
Retrieving quote historyChangelogs contain changes of the quotes containing quote reasons reference.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Retrieving quotesThe quote has the shipping object required to the checkout process.
Retrieving a single quoteThe quote has the shipping object required to the checkout process.
Partially updating a quoteThe shipping object can be updated by the PATCH endpoint.
Creating a quoteA new optional field shipping was added for quote creation.
Retrieving quote historyChangelogs contain changes of the shipping.

Known problems

There are no known problems.


Major

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

EndpointDescription
Creating a sales orderThe shipping line of the response body contains the optional tax object.
Retrieving a single sales orderThe shipping line of the response body contains the tax object.
Retrieving sales orderThe shipping line of the response body contains the tax object.
Creating an orderThe shipping line of the response body contains the optional tax object.
Retrieving a single orderThe shipping line of the response body contains the tax object.
Retrieving ordersThe shipping line of the response body contains the tax object.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Triggering a checkoutThe 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

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

EndpointDescription
Retrieving quotesIt gets the order id from an order that was created basing on the quote.
Retrieving a single quoteIt gets the order id from an order that was created basing on the quote.

Known problems

There are no known problems.


Major

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

EndpointDescription
Retrieving quotesNew properties provide support for mixins and mixins metadata.
Retrieving a single quoteNew properties provide support for mixins and mixins metadata.
Partially updating a quoteNew paths provide support for updating mixins and mixins metadata.
Creating a quoteNew properties provide support for mixins and mixins metadata.
Retrieving quote historyChangelogs contain changes in the mixins and mixins metadata.

Known problems

There are no known problems.


Minor

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

EndpointDescription
Creating an orderThis property indicates from which quote the order has been created.
Getting a list of the ordersThis property indicates from which quote the order has been created.
Getting an orderThis property indicates from which quote the order has been created.

Known problems

There are no known problems.


Major

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

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

EndpointDescription
Creating a quoteIt creates a new quote.
Partially updating a quoteIt updates an existing quote.
Deleting a quoteIt deletes an existing quote.
Retrieving quotesIt gets a list of quotes.
Retrieving a single quoteIt gets a single quote.
Retrieving quote historyIt gets a single quote changelog.
Creating a quote PDFIt generates a quote PDF.

Known problems

There are no known problems.


Major

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

Media Service - public and private assets

Overview

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

New endpoints

EndpointDescription
Creating a new assetIt creates a new media asset.
Updating an existing assetIt updates an existing media asset.
Deleting an existing assetIt deletes an existing media asset.
Getting list of asset entitiesIt gets a list of media assets.
Getting single asset entityIt gets a single media asset.
Downloading an assetIt downloads a single media asset.

Known problems

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


Minor

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

EndpointDescription
Updating an orderThis 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 orderThis 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

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

EndpointDescription
Creating a new price modelIt creates a new price model.
Creating a new priceIt creates a new price.
Creating new prices in bulkIt creates new prices in bulk.
Creating a new price listIt creates a new price list.
Creating a new price list priceIt creates a new price list price.
Creating new price list prices in bulkIt creates new price list prices in bulk.

Known problems

There are no known problems.


New Feature

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

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

In progress

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

EndpointDescription
Creating a new return entityIt creates a new order return.
Updating an existing return entityIt updates an existing order return.
Deleting an existing return entityIt deletes an existing order return.
Getting list of return entitiesIt gets a list of order returns.
Getting single return entitiesIt gets a single order return.

Known problems

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


Major

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

EndpointDescription
Retrieving all brandsThe response body contains two new fields localizedName and localizedDescription. Filtering is now supported using the q query parameter.
Adding a new brandThe response body contains two new optional fields — localizedName and localizedDescription.
Retrieving a brandThe response body contains two new fields localizedName and localizedDescription.
Updating a brandThe response body contains two new optional fields localizedName and localizedDescription.

Major

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

EndpointDescription
Creating a new productThe request body schema contains two new fields variantAttributes and parentVariantId.
Retrieving a product's detailsThe request body schema contains two new fields variantAttributes and parentVariantId.
Retrieving a list of productsThe request body schema contains two new fields variantAttributes and parentVariantId.
Updating a product's detailsThe request body schema contains one new field variantAttributes.
Partially updating a product's detailsThe request body schema contains one new optional field variantAttributes.

Major

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

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

Major

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

EndpointDescription
Creating a new productThe request body schema contains a new optional field relatedItems.
Retrieving a product's detailsThe request body schema contains a new optional field relatedItems.
Retrieving a list of productsThe request body schema contains a new optional field relatedItems.
Updating a product's detailsThe request body schema contains a new optional field relatedItems.

Major

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

EndpointDescription
Creating a new productThe request body schema contains two optional fields productType and bundledProducts.
Retrieving a product's detailsThe request body schema contains two optional fields productType and bundledProducts.
Retrieving a list of productsThe request body schema contains two optional fields productType and bundledProducts.
Updating a product's detailsThe request body schema contains one optional field bundledProducts.

Major

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

EndpointDescription
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

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

EndpointDescription
Creating a new product templateIt creates a new product template.
Getting a product templateIt retrieves a single product template.
Getting a list of product templatesIt retrieves a list of product templates.
Updating a product templateIt 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 templateIt 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

EndpointDescription
Creating a new productThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Retrieving a product's detailsThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Retrieving a list of productsThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Updating a product's detailsThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.

In progress

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

EndpointDescription
Creating a new productThe request body schema contains a new optional field relatedItems.
Retrieving a product's detailsThe request body schema contains a new optional field relatedItems.
Retrieving a list of productsThe request body schema contains a new optional field relatedItems.
Updating a product's detailsThe 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

Customer Management Service - business customers

Overview

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

New endpoints

EndpointDescription
Legal entities managementCRUD1 operations for managing legal entities. A legal entity is a representation of a company or its subsidiary.
Location managementCRUD operations for managing locations. A location is a physical address where a company operates, such as its headquarters, office, or warehouse.
Contact managementCRUD operations for contact management. A contact is an employee of one or more legal entities who can be contacted regarding business matters.
Contact assignmentsCRUD 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

Product Service - improvements

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

EndpointDescription
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 productThe 204 status code is now returned in two cases:
  • A successful product removal.
  • Removal of a product that does not exist.

In progress

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

EndpointDescription
Retrieving all subscriptionsIt retrieves all events with associated subscription details.
Subscribing and unsubscribing from eventsIt updates the subscriptions list by either subscribing or unsubscribing from specified events.
Retrieving a dashboard access URLIt 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

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

EndpointDescription
Deleting all productsIt deletes all products assigned to the tenant.

New Feature

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

EndpointDescription
Creating a new productThe request body schema contains two optional fields productType and bundledProducts.
Retrieving a product's detailsThe request body schema contains two optional fields productType and bundledProducts.
Retrieving a list of productsThe request body schema contains two optional fields productType and bundledProducts.
Updating a product's detailsThe 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

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

EndpointDescription
Creating a new product templateIt creates a new product template.
Getting a product templateIt retrieves a single product template.
Getting a list of product templatesIt retrieves a list of product templates.
Updating a product templateIt 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 templateIt 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

EndpointDescription
Creating a new productThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Retrieving a product's detailsThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Retrieving a list of productsThe request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Updating a product's detailsThe 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.


  1. CRUD — create, read, update, delete.