Changelog 2022
Last updated
Was this helpful?
Last updated
Was this helpful?
Overview
The media assets functionality makes it possible to manage public and private assets.
New endpoints
It creates a new media asset.
It updates an existing media asset.
It deletes an existing media asset.
It gets a list of media assets.
It gets a single media asset.
It downloads a single media asset.
Known problems
When particular endpoints become available, they will be announced in the .
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
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.
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.
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
It creates a new price model.
It creates a new price.
It creates new prices in bulk.
It creates a new price list.
It creates a new price list price.
It creates new price list prices in bulk.
Known problems
There are no known problems.
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
It retrieves a session context.
It updates a session context.
It adds a new attribute to session context.
It deletes an attribute from a session context.
It retrieves own session context.
It updates own session context.
It adds a new attribute to own session context.
It deletes an attribute from own session context.
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
It creates a new order return.
It updates an existing order return.
It deletes an existing order return.
It gets a list of order returns.
It gets a single order return.
Known problems
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.
Updated endpoints
The response body contains two new fields localizedName and localizedDescription. Filtering is now supported using the q query parameter.
The response body contains two new optional fields — localizedName and localizedDescription.
The response body contains two new fields localizedName and localizedDescription.
The response body contains two new optional fields localizedName and localizedDescription.
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
The request body schema contains two new fields variantAttributes and parentVariantId.
The request body schema contains two new fields variantAttributes and parentVariantId.
The request body schema contains two new fields variantAttributes and parentVariantId.
The request body schema contains one new field variantAttributes.
The request body schema contains one new optional field variantAttributes.
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
It retrieves all events with associated subscription details.
It updates the subscriptions list by either subscribing or unsubscribing from specified events.
It retrieves a Svix magic login link (authentication embedded) and an authentication token needed to connect a tenant to their consumer application portal.
It retrieves statistics on the number of emitted events and provides information on the limit of webhook notifications configured for a specific tenant.
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
The request body schema contains a new optional field relatedItems.
The request body schema contains a new optional field relatedItems.
The request body schema contains a new optional field relatedItems.
The request body schema contains a new optional field relatedItems.
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
The request body schema contains two optional fields productType and bundledProducts.
The request body schema contains two optional fields productType and bundledProducts.
The request body schema contains two optional fields productType and bundledProducts.
The request body schema contains one optional field bundledProducts.
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
The response body schema of the order.entries.product model contains two optional fields productType and bundledProducts.
The response body schema of the order.entries.product model contains two optional fields productType and bundledProducts.
The request body schema of the order.entries.product model contains two optional fields productType and bundledProducts.
The request body schema of the order.entries.product model contains two optional fields productType and bundledProducts.
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
It creates a new product template.
It retrieves a single product template.
It retrieves a list of product templates.
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.
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
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
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
The request body schema contains a new optional field relatedItems.
The request body schema contains a new optional field relatedItems.
The request body schema contains a new optional field relatedItems.
The request body schema contains a new optional field relatedItems.
Known problems
Overview
The customer management functionality makes it possible to manage information about your business customers.
New endpoints
operations for managing legal entities. A legal entity is a representation of a company or its subsidiary.
CRUD operations for managing locations. A location is a physical address where a company operates, such as its headquarters, office, or warehouse.
CRUD operations for contact management. A contact is an employee of one or more legal entities who can be contacted regarding business matters.
CRUD operations for assignments of contacts to legal entities. A contact can be assigned to a company or a subsidiary.
Known problems
The following changes have been introduced to the Emporix Product Service:
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.
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.
The 204 status code is now returned in two cases:
A successful product removal.
Removal of a product that does not exist.
Overview
The webhooks functionality makes it possible to subscribe to events that are broadcast by the Emporix e-commerce system.
New endpoints
It retrieves all events with associated subscription details.
It updates the subscriptions list by either subscribing or unsubscribing from specified events.
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
Deprecated endpoint for deleting all products assigned to the tenant has been removed from the Emporix API Product Service Reference.
Removed endpoints
It deletes all products assigned to the tenant.
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
The request body schema contains two optional fields productType and bundledProducts.
The request body schema contains two optional fields productType and bundledProducts.
The request body schema contains two optional fields productType and bundledProducts.
The request body schema contains one optional field bundledProducts.
Known problems
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
It creates a new product template.
It retrieves a single product template.
It retrieves a list of product templates.
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.
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
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
The request body schema contains a new optional field called template. The template field consists of two fields: id and version.
Known problems
When particular endpoints become available, they will be announced in the .
For more detailed information, check out the API Reference documentation for the endpoint.
When particular endpoints become available, they will be announced in .
When particular endpoints become available, they will be announced in .
When particular endpoints become available, they will be announced in .
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 .
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 .