2024
2024-12-19: Customer Segment Service - new endpoint for checking match criteria
This functionality is in preview mode — some of the features may not be fully operational yet.
Overview
We extended the service with a new endpoint for checking which items match specified criteria. This endpoint allows you to specify IDs of products and IDs of segments to check which of the products are assigned to any of the provided segments. The response includes the IDs of products that belong to one of the provided segments (directly or indirectly through a category).
Added endpoints
Checking which items belong to segment.
Known problems
There are no known problems.
2024-12-19: Cart Service - added information about legalEntity
Overview
The request and response bodies of endpoints for managing carts were extended with legalEntityId field.
Updated endpoints
The request body has a new field - legalEntityId.
The request body has a new field - legalEntityId.
The response body has a new field - legalEntityId.
The response body has a new field - legalEntityId.
Known problems
There are no known problems.
2024-12-19: Customer Segment Service - endpoints for retrieving items assignments
This functionality is in preview mode — some of the features may not be fully operational yet.
Overview
We added new API for retrieving items assignments and category trees of category assignments.
Added endpoints
It retrieves category trees for the customer segments.
It retrieves all items assignments for the customer segments.
Known problems
There are no known problems.
2024-12-19: Category Service - new query parameter
Overview
Query parameter segmentsIds has been added to GET category assignments endpoint. The new query parameter allows to filter the assigned resources by the segmentsIds - only category assignments will be returned which category is assigned to provided segments list.
Updated endpoints
The new query parameter segmentsIds has been added.
Known problems
There are no known problems.
2024-12-17: AI Service - Completion functionality
Overview
The AI Service supports completion functionality. Generates a completion based on conversation history.
Updated endpoints
Generates a completion based on conversation history.
Known problems
There are no known problems.
2024-12-16: Order Service - Q-param behaviour
Overview
The q-param accepts string values both with and without quotes, while number values should be provided without quotes.
Updated endpoints
Q-param accepts string values both with and without quotes. Number values should be provided without quotes.
Q-param accepts string values both with and without quotes. Number values should be provided without quotes.
Known problems
There are no known problems.
2024-12-11: Availability Service - upsert operation support
Overview
The Availability Service supports UPSERT operation. The PUT method updates the availability for given product and site or creates a new one if such a availability does not exist yet.
Updated endpoints
Sending a request to the upsert endpoint with a non-existing product availability creates a new availability for the given product and site.
Known problems
There are no known problems.
2024-12-11: Price Service - upsert operation support
Overview
The Price Service supports UPSERT operation. The PUT method updates the price with the given id or creates a new one if such a price does not exist yet.
Updated endpoints
Sending a request to the upsert endpoint with a non-existing price id creates a new price with the given id.
Sending a request to the upsert endpoint with a non-existing price id creates a new price with the given id.
Sending a request to the upsert endpoint with a non-existing price model id creates a new price model with the given id.
Sending a request to the upsert endpoint with a non-existing price list id creates a new price list with the given id.
Sending a request to the upsert endpoint with a non-existing price id creates a new price with the given id for the specified price list.
Sending a request to the upsert endpoint with a non-existing price id creates a new price with the given id for the specified price list.
Known problems
There are no known problems.
2024-12-11: Product Service - upsert operation support
Overview
The Product Service supports UPSERT operation. The PUT method updates the product with the given id or creates a new one if such a product does not exist yet. The Product Service has a new product.product_manage was added to the product service. The scopes product.product_update, product.product_create and product.product_delete have been deprecated in favour of product.product_manage.
Updated endpoints
The endpoint requires a new product.product_manage scope, as the product.product_create scope is deprecated.
The endpoint requires a new product.product_manage scope, as the product.product_create scope is deprecated.
The endpoint requires a new product.product_manage scope, as the product.product_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing product id creates a new product with the given id.
The endpoint requires a new product.product_manage scope, as the product.product_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing product id creates a new product with the given id.
The endpoint requires a new product.product_manage scope, as the product.product_update scope is deprecated.
The endpoint requires a new product.product_manage scope, as the product.product_delete scope is deprecated.
Known problems
There are no known problems.
2024-12-11: Customer Management Service - upsert operation support
Overview
The Customer Management Service supports UPSERT operation. For LegalEntity, Location and ContactAssignment the PUT method updates an entity with the given id or creates a new one if such a entity does not exist yet.
Updated endpoints
Sending a request to the upsert endpoint with a non-existing legal entity id creates a new legal entity with the given id.
Sending a request to the upsert endpoint with a non-existing location id creates a new location with the given id.
Sending a request to the upsert endpoint with a non-existing contact assignment id creates a new contact assignment with the given id.
Known problems
There are no known problems.
2024-12-10: Coupon Service - new segment-related fields
Overview
Fields segmentRestricted and restrictions.segments were added to coupon's model. The new fields allow to keep information about segments restrictions in the coupon.
Updated endpoints
The request body has new fields - segmentRestricted and restrictions.segments.
The request body has new fields - segmentRestricted and restrictions.segments.
The request body has new fields - segmentRestricted and restrictions.segments.
The response body has new fields - segmentRestricted and restrictions.segments.
[Retrieving list of coupons by criteria](https://developer.emporix.io/api-references/api-guides/rewards-and-promotions/coupon/api-reference/coupon-management
The response body has new fields - segmentRestricted and restrictions.segments.
Known problems
There are no known problems.
2024-12-10: Coupon Service - added information about legalEntity to redemption endpoints
Overview
The request and response bodies of endpoints for redeeming coupons were extended with legalEntityId field. It means that if a customer is assigned to many legal entities then he can redeem coupons separately for each of them.
Updated endpoints
The request body has a new field - legalEntityId.
The request body has a new field - legalEntityId.
The response body has a new field - legalEntityId.
The response body has a new field - legalEntityId.
Known problems
There are no known problems.
2024-12-10: Customer Service - added information about legalEntities and businessModel
Overview
Fields legalEntities and businessModel were added to customer's model. The new fields are readonly and gives instant information whether customer is of B2B or B2C business model.
Updated endpoints
The response has two new fields - b2b.legalEntities and businessModel.
The response has two new fields - b2b.legalEntities and businessModel.
The response has two new fields - b2b.legalEntities and businessModel.
Known problems
There are no known problems.
2024-12-10: IAM Service Service - upsert operation support for groups and assignments
Overview
The IAM Service supports UPSERT operation for groups and assignment. The PUT method updates the user group with the given id or creates a new one if such a group does not exist yet. A new scope iam.group_manage was added to the IAM service. The scopes iam.group_update, iam.group_create and iam.group_delete have been deprecated in favour of iam.group_manage.
Updated endpoints
The endpoint requires a new iam.group_manage scope, as the iam.group_create scope is deprecated.
The endpoint requires a new iam.group_manage scope, as the iam.group_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing group id creates a new catalog with the given id.
The endpoint requires a new iam.group_manage scope, as the iam.group_delete scope is deprecated.
The endpoint requires a new iam.assignment_manage scope, as the iam.assignment_create scope is deprecated.
The endpoint requires a new iam.assignment_manage scope, as the iam.assignment_delete scope is deprecated.
The endpoint requires a new iam.assignment_manage scope, as the iam.assignment_delete scope is deprecated.
The endpoint requires a new iam.assignment_manage scope, as the iam.assignment_delete scope is deprecated.
New endpoint that allows to create or update group assignment.
Known problems
There are no known problems.
2024-12-09: Catalog Service - upsert operation support
Overview
The Catalog Service supports UPSERT operation. The PUT method updates the catalog with the given id or creates a new one if such a catalog does not exist yet. A new scope catalog.catalog_manage was added to the catalog service. The scopes catalog.catalog_update, catalog.catalog_create and catalog.catalog_delete have been deprecated in favour of catalog.catalog_manage.
Updated endpoints
The endpoint requires a new catalog.catalog_manage scope, as the catalog.catalog_create scope is deprecated.
The endpoint requires a new catalog.catalog_manage scope, as the catalog.catalog_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing catalog id creates a new catalog with the given id.
The endpoint requires a new catalog.catalog_manage scope, as the catalog.catalog_update scope is deprecated.
The endpoint requires a new catalog.catalog_manage scope, as the catalog.catalog_delete scope is deprecated.
Known problems
There are no known problems.
2024-12-09: Customer Service - upsert operation support
Overview
The Customer Service support the UPSERT operation. The PUT method updates the customer with the given id or creates a new one if such a customer does not exist yet. The same applies to customer's address PUT method. The field metadata.version is now optional to support the UPSERT operation. When you don't provide the value, the optimistic locking is not enabled. The Customer Service has a new customer.customer_manage scope. The scopes customer.customer_update, customer.customer_create and customer.customer_delete have been deprecated in favour of customer.customer_manage.
Updated endpoints
The endpoint requires a new customer.customer_manage scope, as the customer.customer_create scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing customer id creates a new customer with the given id.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_delete scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing address id creates a new address with the given id.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated.
The endpoint requires a new customer.customer_manage scope, as the customer.customer_update scope is deprecated.
Known problems
There are no known problems.
2024-12-09: Category Service - upsert improvements
Overview
The field metadata.version is now optional to support the UPSERT operation. When you don't provide the value, the optimistic locking is not enabled. The Category Service as a new category.category_manage scope. The scopes category.category_update, category.category_create and category.category_delete have been deprecated in favour of category.category_manage.
Updated endpoints
The endpoint requires a new category.category_manage scope, as the category.category_create scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing category id creates a new category with the given id.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_delete scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated. Sending a request to the upsert endpoint with a non-existing category assignment id creates a new assignment with the given id.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
The endpoint requires a new category.category_manage scope, as the category.category_update scope is deprecated.
Known problems
There are no known problems.
2024-11-21: Webhook Service - new events
This functionality is now fully operational.
Overview
The new events were added to webhook-service.
Added events
client-management.contactassignment-created
The event is emitted when contact assignment is created.
client-management.contactassignment-deleted
The event is emitted when contact assignment is deleted.
client-management.contactassignment-updated
The event is emitted when contact assignment is updated.
customer-segment.segment-created
The event is emitted when a customer segment is created.
customer-segment.segment-deleted
The event is emitted when a customer segment is deleted.
customer-segment.segment-updated
The event is emitted when a customer segment is updated.
customer-segment.customer-assignment-created
The event is emitted when a customer assignment to a customer segment is created.
customer-segment.customer-assignment-updated
The event is emitted when a customer assignment to a customer segment is updated.
customer-segment.customer-assignment-deleted
The event is emitted when a customer assignment to a customer segment is deleted.
customer-segment.item-assignment-created
The event is emitted when an item is assigned to a customer segment.
customer-segment.item-assignment-deleted
The event is emitted when an item is unassigned from a customer segment.
customer-segment.item-assignment-updated
The event is emitted when an item assignment to a customer segment is updated.
site.site-created
The event is emitted when site is created.
site.site-deleted
The event is emitted when site is deleted.
site.site-updated
The event is emitted when site is updated.
Known problems
There are no known problems.
2024-12-02: Customer Segment Service - endpoints for managing B2C customer assignments
This functionality is in preview mode — some of the features may not be fully operational yet.
Overview
We added new API for managing B2C customer assignments.
Added endpoints
It retrieves a customer assignment.
It creates or updates a customer assignment.
It deletes a customer assignment.
Known problems
There are no known problems.
2024-11-22: Category Service - mixins validation
Overview
A new property is available in the category model - metadata.mixins. It allows validation of mixins against the 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.
We added metadata.mixins property.
We added metadata.mixins property.
Known problems
There are no known problems.
2024-11-21: IAM Service - custom ID support for groups
Overview
The IAM Service now supports custom IDs for group creation. If the ID is already in use, the service returns a 409 status code.
Updated endpoints
The id field added.
Known problems
There are no known problems.
2024-11-19: Customer Service - custom ID support for addresses
Overview
The Customer Service now supports custom IDs for customer's addresses creation. If the ID is already in use, the service returns a 409 status code.
Updated endpoints
The id field added.
Known problems
There are no known problems.
2024-11-15: Customer Management Service - custom ID support
Overview
The Customer Management Service now supports custom IDs for Legal Entities, Locations, Contact Assignments creation. The id field can have 1 - 66 characters and must match ^[a-zA-Z0-9_-]$ regular expression. If the ID is already in use, the service returns a 409 status code.
Updated endpoints
The id field added.
The id field added.
The id field added.
Known problems
There are no known problems.
2024-11-15: Customer-Management Service - search legal entities endpoint
Overview
The Customer-Management Service has been enhanced with the new endpoint which allows to retrieve legal entities that match criteria provided in request payload.
Added endpoints
The new endpoint which allows to retrieve legal entities by criteria provided in request payload
2024-11-13: Customer Segment Service - endpoints for managing segments
This functionality is in preview mode — some of the features may not be fully operational yet.
Overview
We added new API for managing customer segments, items assigned to segments and customers assigned to segments.
Added endpoints
It creates a new segment.
It retrieves segments.
It searches for segments.
It retrieves a segment.
It updates a segment.
It partially updates a segment.
It deletes a segment.
It creates segments in bulk.
It updates segments in bulk.
It deletes segments in bulk.
It retrieves customer assignments.
It searches for customer assignments.
It retrieves a customer assignment.
It creates or updates a customer assignment.
It deletes a customer assignment.
It creates or updates customer assignments in bulk.
It deletes customer assignments in bulk.
It retrieves item assignments.
It searches for item assignments.
It retrieves an item assignment.
It updates an item assignment.
It removes an item assignment.
It creates or updates item assignments in bulk.
It deletes item assignments in bulk.
Known problems
There are no known problems.
2024-11-13: Customer Service - custom ID support
Overview
The Customer Service now supports custom IDs for customer creation. The id field can have 1 - 66 characters and must match ^[a-zA-Z0-9_-]$ regular expression. If the ID is already in use, the service returns a 409 status code.
Updated endpoints
The id field added.
Known problems
There are no known problems.
2024-11-13: Category Service - custom ID support
Overview
The Category Service now supports custom IDs for category creation. If the ID is already in use, the service returns a 409 status code. Along with that upsert operation was introduced that allows to create or update a category based on the provided ID.
Category assignments support upsert operation for single and multiple assignments.
Updated endpoints
The id field added.
The new endpoint that allows you to either create or update a category with a given id.
The new endpoint that allows you to either create or update an assignment.
The new endpoint that allows you to either create or update multiple assignments.
Known problems
There are no known problems.
2024-11-04: Catalog Service - custom ID support
Overview
The Catalog Service now supports custom IDs for catalog creation. The id field can have 1 - 66 characters and must match ^[a-zA-Z0-9_-]$ regular expression. If the ID is already in use, the service will return a 409 status code.
Updated endpoints
The id field added.
Known problems
There are no known problems.
2024-10-09: Order Service - discount calculation type
Overview
The discount model was expanded with a new field to include the coupon discountCalculationType property, which determines whether the discount is calculated based on the total or subtotal cart value.
Updated endpoints
The discount.discountCalculationType field added.
The discount.discountCalculationType field added.
The discount.discountCalculationType field added.
The discount.discountCalculationType field added.
The discount.discountCalculationType field added.
Known problems
There are no known problems.
2024-10-09: Cart Service - discount calculation type
Overview
The discount model was expanded with a new field to include the coupon discountCalculationType property, which determines whether the discount is calculated based on the total or subtotal cart value. Also total object was expanded with discount property, which holds discount amount for a given total.
Updated endpoints
The discount.discountCalculationType and total.discount fields added.
The discount.discountCalculationType and total.discount fields added.
The discountCalculationType field added.
The discountCalculationType field added.
Known problems
There are no known problems.
2024-10-09: Coupon Service - discount calculation type
Overview
The coupon model was expanded with a discountCalculationType field, which determines whether the discount is calculated based on the total or subtotal order value.
Updated endpoints
[Retrieving all coupons](https://developer.emporix.io/api-references/api-guides/rewards-and-promotions/coupon/api-reference/coupon-management
The discountCalculationType field added.
The discountCalculationType field added.
The discountCalculationType field added.
The discountCalculationType field added.
The discountCalculationType field added.
Known problems
There are no known problems.
2024-10-03: Webhook Service - new event customer.email-change-request type
This functionality is now fully operational.
Overview
The event is emitted when a customer requests changing the email. For more information, see Customer events.
Known problems
There are no known problems.
2024-09-26: Order Service - introduction of feeYrnAggregate and fees fields
Overview
New fields feeYrnAggregate and fees were introduced. The feeYrnAggregate field was added to the order model and the fees field was added to the order entry model. This change allows adding custom externally sources fees to the customer's order.
Updated endpoints
The response body schema contains feeYrnAggregate and fees fields.
The request body schema contains feeYrnAggregate and fees fields.
The response body schema contains feeYrnAggregate and fees fields.
The request body schema contains feeYrnAggregate and fees fields.
The request body schema contains feeYrnAggregate and fees fields.
The response body schema contains feeYrnAggregate and fees fields.
The request body schema contains feeYrnAggregate and fees fields.
The response body schema contains feeYrnAggregate and fees fields.
Known problems
There are no known problems.
2024-09-26: Cart Service - introduction of externalFees field
Overview
New field externalFees was added to the cart item model. This change allows to calculate custom external fees at the customer's cart level.
Updated endpoints
The response body schema of items field contains new field externalFees.
The response body schema of items field contains new field externalFees.
The request body schema contains new field externalFees.
The response body schema contains new field externalFees.
The request body schema contains new field externalFees.
The response body schema contains new field externalFees.
The request body schema contains new field externalFees.
Known problems
There are no known problems.
2024-09-11: Site Settings Service - taxDeterminationBasedOn property added
Overview
The Site object was expanded with the taxDeterminationBasedOn property, which specifies whether tax calculation is based on a customer's billing or shipping address. Default value is BILLING_ADDRESS.
To determine the relevant location to calculate proper taxes, the cart and checkout services read the Tax determination based on setting for the site. This setting determines the proper location by the countryCode from the relevant address. The default setting for a site is the billing address.
If you set the tax determination as shipping address, the country for calculating tax is determined in the following order:
For the cart service: a. cart's
countryCodeb. if thecountryCodeis not provided for a cart, a customer's default shipping addresscountryCodec. if a customer doesn't have a default shipping address, the first customer's shipping addresscountryCodeon the list d. if a customer doesn't have any shipping addresses, the defaultcountryCodefrom the site settingsFor the checkout service: a. a shipping address
countryCode, provided during checkout b. if a shipping address is not provided, a customer's billing addresscountryCodeis taken as a fallback
Updated endpoints
The taxDeterminationBasedOn property allows you to determine the address for relevant tax calculation.
The taxDeterminationBasedOn property allows you to determine the address for relevant tax calculation.
The taxDeterminationBasedOn property allows you to determine the address for relevant tax calculation.
The taxDeterminationBasedOn property allows you to determine the address for relevant tax calculation.
The taxDeterminationBasedOn property allows you to determine the address for relevant tax calculation.
Known problems
There are no known problems.
2024-09-10: Webhook Service - new event customer.email-change type
This functionality is now fully operational.
Overview
The event is emitted when a customer confirms changing the email. For more information, see Customer events.
Known problems
There are no known problems.
2024-09-03: Product Service - introduction of brandId and labelIds field
Overview
New fields brandId and labelIds were added to the product model. Use these fields instead of mixins.productCustomAttributes.brand and mixins.productCustomAttributes.labels.
Updated endpoints
The request body schema contains two new fields brandId and labelIds.
The response body schema contains two new fields brandId and labelIds.
The response body schema contains two new fields brandId and labelIds.
The request body schema contains two new fields brandId and labelIds.
The request body schema contains two new fields brandId and labelIds.
The request body schema contains two new fields brandId and labelIds.
The request body schema contains two new fields brandId and labelIds.
Known problems
There are no known problems.
2024-08-22: Customer Management Service - name field not mandatory
Overview
From now on name field is no longer mandatory for creating and updating locations.
Updated endpoints
name field in request payload is no longer mandatory
name field in request payload is no longer mandatory
Known problems
There are no known problems.
2024-08-21: Customer Service - metadataCreatedAt field in response
Overview
Responses from endpoints for retrieving customers were enriched with the metadataCreatedAt field.
Updated endpoints
Response payload contains the metadataCreatedAt field.
Response payload contains the metadataCreatedAt field.
Known problems
There are no known problems.
2024-08-12: Cart Service - support for external prices
Overview
To handle external prices, the request payload now includes the itemType and tax properties. To fetch external prices, you also need to generate the cart.cart_manage_external_prices scope, set the enableExternalPrices system preference to true, set the price.type to EXTERNAL, and provide the tax values.
Updated endpoints
The request includes the itemType and tax properties.
The request includes the itemType and tax properties.
The request includes the itemType and tax properties.
Known problems
There are no known problems.
2024-08-08: Order Service - introduction of add entries endpoint
Overview
Order Service has a new endpoint that is responsible for modifying and adding new entries to a given order.
New endpoints
A new endpoint for adding entries to existing orders.
Known problems
There are no known problems.
2024-07-23: Configuration Service - introduction of clients endpoint
Overview
Configuration Service has a new endpoint that is responsible for returning list of clients for given tenant.
New endpoints
A new endpoint for retrieving clients.
Known problems
There are no known problems.
2024-07-11: Customer Service (customer-managed) - site field for password reset requests
Overview
There is a new property site added to password reset model and 'customer.password-reset' event message. It allows to save site from which password reset request was sent.
Updated endpoints
The site property added to password reset model.
Known problems
There are no known problems.
2024-07-09: Cart Service - introduction of refresh endpoint
Overview
Cart Service has a new endpoint that is responsible for refreshing a specified cart and its items. If the prices assigned to the items in a cart have changed, invoking the endpoint recognizes the changes and reassigns them in the cart.
New endpoints
A new endpoint that refreshes a specified cart and its items.
Known problems
There are no known problems.
2024-07-02: Shopping-list Service - removal of deprecated endpoints
All previously deprecated endpoints are now removed.
Removed endpoints
Fetching all shopping lists - GET /shoppinglists
Creating a shopping list - POST /shoppinglists