Changelog 2023
2023-12-14: Availability Service - removal of scopes from GET endpoint
GET endpointOverview
The endpoint for getting product availability does not require any scopes anymore.
Updated endpoints
The endpoint doesn't require scopes.
Known problems
There are no known problems.
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
It fetches all shopping lists. The endpoint requires the shoppinglist.shoppinglist_read scope by an employee.
It creates a shopping list. The endpoint requires the shoppinglist.shoppinglist_manage scope by an employee.
It updates a shopping list. The endpoint requires the shoppinglist.shoppinglist_manage scope by an employee.
It removes a shopping list. The endpoint requires the shoppinglist.shoppinglist_manage scope by an employee.
It fetches a shopping list. The endpoint requires the shoppinglist.shoppinglist_read scope by an employee.
2023-12-14: Shopping-list Service - deprecation of endpoints
All deprecated endpoints will be removed on 2024/07/01.
Deprecated endpoints
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.
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
[Retrieving coupons](https://developer.emporix.io/api-references/api-guides-and-references/rewards-and-promotions/coupon/api-reference/coupon-management
We added mixins and metadata.mixins properties.
We added mixins and metadata.mixins properties.
We added mixins and metadata.mixins properties.
We added mixins and metadata.mixins properties.
We added mixins and metadata.mixins properties.
Known problems
There are no known problems.
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
Properties price.originalAmount and price.effectiveAmount can be optional. Validation is configurable by the system preferences.
Properties price.originalAmount and price.effectiveAmount can be optional. Validation is configurable by the system preferences.
Properties price.originalAmount and price.effectiveAmount can be optional. Validation is configurable by the system preferences.
Known problems
There are no known problems.
2023-11-23: Returns Service - metadata.mixins field
metadata.mixins fieldOverview
There is a new property added to return model - metadata.mixins. It allows for validation of mixins against a provided schema.
Updated endpoints
We added metadata.mixins property.
We added metadata.mixins property.
We added metadata.mixins property.
We added metadata.mixins property.
We added metadata.mixins property.
Known problems
There are no known problems.
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
Depending on the configuration, it flags coupon as deleted or performs permanent deletion from database.
Known problems
There are no known problems.
2023-11-14: Webhook Service - new event types for Client Management Service
Overview
Known problems
There are no known problems.
2023-11-08: Schema Service - new service
This functionality is now fully operational.
Overview
We released the Schema Service that provides validation of custom mixin fields.
New endpoints
It creates a new schema. The endpoint requires schema.schema_manage scope.
It returns all schemas. The endpoint requires schema.schema_read scope.
It returns a schema. The endpoint requires schema.schema_read scope.
It deletes a schema. The endpoint requires schema.schema_manage scope.
It updates a schema. The endpoint requires schema.schema_manage scope.
It updates types of a schema. The endpoint requires schema.schema_manage scope.
It returns types. The endpoint requires schema.schema_read scope.
It parses json schema and returns parsing results. The endpoint requires schema.schema_read scope.
It creates a new reference. The endpoint requires schema.schema_manage scope.
It returns all references. The endpoint requires schema.schema_read scope.
It returns a reference. The endpoint requires schema.schema_read scope.
It deletes a reference. The endpoint requires schema.schema_manage scope.
It updates a reference. The endpoint requires schema.schema_manage scope.
Known problems
There are no known problems.
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
It updates products in bulk.
Known problems
There are no known problems.
2023-11-07: Customer Service (customer-managed) - type property
type propertyOverview
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
We added type property.
We added type property.
We added type property.
Known problems
There are no known problems.
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
Company registration ID property has been added.
Company registration ID property has been added.
Company registration ID property has been added.
Known problems
There are no known problems.
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
We added the company registration ID property and the customer.customer_read_own scope.
We added the company registration ID property and the customer.customer_manage_own scope.
We added the company registration ID property and the customer.customer_manage_own scope.
We added the company registration ID property and the customer.customer_read_own scope.
We added the customer.customer_read_own scope.
Known problems
There are no known problems.
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
It allows the customer to get their own scopes.
Updated endpoints
The added iam.group_read_own scope allows customers to read the groups of customer types.
The added iam.user_read_own scope allows customers to read user assignments. The users have to be from the same company.
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.
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.
2023-11-07: Approval Service - new service
Overview
We released the Approval Service.
New endpoints
It creates a new approval. The endpoint requires the approval.approval_manage_own scope.
It gets all the approvals assigned to the user. The endpoint requires the approval.approval_read_own scope.
It gets a single approval by ID assigned to the user. The endpoint requires the approval.approval_read_own scope.
It updates an approval by ID. The endpoint requires the approval.approval_manage_own scope.
It deletes an approval by ID. The endpoint requires the approval.approval_manage_own scope.
It checks if the user has permission to perform given action on the resource. The endpoint requires the approval.approval_read_own scope.
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.
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
We added assisted buying property.
We added assisted buying property.
Known problems
There are no known problems.
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
We added assisted buying property.
We added assisted buying property.
Known problems
There are no known problems.
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
We added assisted buying property.
We added assisted buying property.
We added assisted buying property.
We added assisted buying property.
We added assisted buying property.
Known problems
There are no known problems.
2023-10-27: Webhook Service - new event types for customer service
This functionality is now fully operational.
Overview
Known problems
There are no known problems.
2023-09-06: AI Service - new service
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
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.
2023-08-07: Reward Points Service - redeem option
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
It updates redeem option with given information.
Updated endpoints
It creates a redeem option for a given tenant.
It gets a redeem option for a given tenant.
Known problems
There are no known problems.
2023-08-07: Reward Points Service - deleting redeem option
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
It deletes redeem option by id for a given tenant.
Known problems
There are no known problems.
2023-08-02: Shipping Service - delivery day shift and time zones support
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
It returns all the delivery times defined for the given tenant.
It creates a single delivery time.
It creates multiple delivery times in a single request.
It retrieves a specific delivery time.
It updates a single delivery time with a given information.
It partially updates a single delivery time with a given information.
Known problems
There are no known problems.
2023-07-11: Shipping Service - delivery cycle management
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
It returns all the delivery times defined for the given tenant.
It creates a single delivery time.
It creates multiple delivery times in a single request.
It retrieves a specific delivery time.
It updates a single delivery time with a given information.
It partially updates a single delivery time with a given information.
It deletes a specific delivery time with all slots that it had created.
It retrieves all the slots for a given delivery time.
It creates a new time slot for the given delivery time.
It deletes all the time slots for the given delivery time.
It retrieves the given delivery time slot's details.
It updates a single delivery time slot with given information.
It partially updates a single delivery time slot with given information.
It deletes a single delivery time slot.
It generates a delivery cycle.
Updated endpoints
Request body contains one new property - slotId.
Response contains new properties - slotId, deliveryMethod, cutOffTime, cutOfDay, deliveryCycle.
Endpoint was deprecated.
Response contains new properties - zones.actualDeliveryWindows.deliveryCycle, zones.actualDeliveryWindows.deliveryMethod, zones.actualDeliveryWindows.cutOffTime, zones.actualDeliveryWindows.slotId.
Response contains a new property - deliveryWindow.
Request body contains a new property - deliveryWindow.
Response contains a new property - deliveryWindow.
Request body contains a new property - deliveryWindow.
Request body contains a new property - deliveryWindow.
Response contains a new property - deliveryWindow.
Request body contains a new property - deliveryWindow.
Response contains a new property - deliveryWindow.
Request body contains a new property - deliveryWindow.
Response contains a new property - deliveryWindow.
Response contains a new property - deliveryWindow.
Request body contains a new property - deliveryWindow.
Known problems
There are no known problems.
2023-07-11: Payment Gateway Service - new service
This functionality is now fully operational.
Overview
We released the Payment Gateway Service.
New endpoints
It creates a new payment mode. The endpoint requires payment-gateway.paymentmodes_manage scope.
It updates an existing payment mode. The endpoint requires payment-gateway.paymentmodes_manage scope.
It deletes an existing payment mode. The endpoint requires payment-gateway.paymentmodes_manage scope.
It fetches a list of configured payment modes. The endpoint requires payment-gateway.paymentmodes_read scope.
It fetches a single, configured payment mode. The endpoint requires payment-gateway.paymentmodes_read scope.
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.
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.
It authorizes a given payment. The endpoint requires payment-gateway.authorize_manage scope.
It captures a given payment. The endpoint requires payment-gateway.capture_manage scope.
It refunds a given payment. The endpoint requires payment-gateway.refund_manage scope.
It captures a given payment. The endpoint requires payment-gateway.cancel_manage scope.
It fetches a list of payment transactions. The endpoint requires payment-gateway.paymenttransactions_read scope.
It fetches a single payment transaction. The endpoint requires payment-gateway.paymenttransactions_read scope.
Known problems
There are no known problems.
2023-06-01: Webhook Service - new event order.deleted type
order.deleted typeThis functionality is now fully operational.
Overview
Known problems
There are no known problems.
2023-05-30: Category Service - new code property
code propertyThis 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
The category resource now contains the code property.
Known problems
There are no known problems.
2023-05-26: Product Service - creation of multiple products
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
It creates products in bulk. Recommended size of a particular batch is up to 500 products.
Known problems
There are no known problems.
2023-05-25: IAM Service - new b2b property
b2b propertyThis 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
The b2b.legalEntityId property indicates the legal entity for which the group has been created.
The b2b.legalEntityId property indicates the legal entity for which the group has been created.
The b2b.legalEntityId property indicates the legal entity for which the group has been created.
The b2b.legalEntityId property indicates the legal entity for which the group has been created.
Known problems
There are no known problems.
2023-05-25: Customer-Management Service - new customermanagement.legalentity_read_own scope
customermanagement.legalentity_read_own scopeThis 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
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.
2023-05-24: Quote Service - quote reasons
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
It creates a new quote reason.
It updates an existing quote reason.
It deletes an existing quote reason.
It gets a list of quote reasons.
It gets a single quote reason.
Updated endpoints
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.
The quote can contain quoteReason object as part of the status field.
The quote can contain quoteReason object as part of the status field.
Changelogs contain changes of the quotes containing quote reasons reference.
Known problems
There are no known problems.
2023-05-23: Quote Service - shipping information in a quote
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
The quote has the shipping object required to the checkout process.
The quote has the shipping object required to the checkout process.
The shipping object can be updated by the PATCH endpoint.
A new optional field shipping was added for quote creation.
Changelogs contain changes of the shipping.
Known problems
There are no known problems.
2023-05-23: Order Service - tax of the shipping cost
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
The shipping line of the response body contains the optional tax object.
The shipping line of the response body contains the tax object.
The shipping line of the response body contains the tax object.
The shipping line of the response body contains the optional tax object.
The shipping line of the response body contains the tax object.
The shipping line of the response body contains the tax object.
Known problems
There are no known problems.
2023-05-23: Checkout Service - quote checkout process
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
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.
2023-05-23: Quote Service - new orderId property
orderId propertyThis 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
It gets the order id from an order that was created basing on the quote.
It gets the order id from an order that was created basing on the quote.
Known problems
There are no known problems.
2023-05-17: Quote Service - mixins feature
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
New properties provide support for mixins and mixins metadata.
New properties provide support for mixins and mixins metadata.
New paths provide support for updating mixins and mixins metadata.
New properties provide support for mixins and mixins metadata.
Changelogs contain changes in the mixins and mixins metadata.
Known problems
There are no known problems.
2023-05-12: Order Service - new quoteId property
quoteId propertyThis 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
This property indicates from which quote the order has been created.
This property indicates from which quote the order has been created.
This property indicates from which quote the order has been created.
Known problems
There are no known problems.
2023-04-04: Reward Points Service - order status changes
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.
2023-03-31:Quote Service - management of quotations
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
It creates a new quote.
It updates an existing quote.
It deletes an existing quote.
It gets a list of quotes.
It gets a single quote.
It gets a single quote changelog.
It generates a quote PDF.
Known problems
There are no known problems.
2023-03-03: Price Service (v2) - validation of mixins
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.
Last updated
Was this helpful?