You can configure our system to work with various authentication and authorization providers. This is part of the standard system management and tenant configuration process. For details on supported integrations and setup instructions, refer to the System Management – Authentication and Authorization guides.

Emporix comes with the out-of-the-box service that is responsible for sending automated emails to your customers. The email communication is triggered upon certain events happening in the system, such as for example registering a new customer, submitting an order from the storefront, or many more. The service takes care of keeping the customers in the loop and up-to-date with the operations happening in the system, concerning their accounts, orders, etc.

Apart from the default setup, you can enable your custom emailing service and maintain the automated email templates in your database. Emporix allows you to integrate your custom Mailjet account to take care of customer communication.

For more details, see the Mailjet doc.

With Emporix, you get additional ways to enhance search functionality. Check out these resources:

• Universal Search Connector

• Search Configuration

• Indexing Service

The Manage Showcase & Sample Data view of the Emporix Developer Portal is a designed to help you start working with your data and check our Emporix Showcase. The view is available for users with the Admin role.

• Emporix Showcase - see a sample storefront that is built to showcase how you can set up your own one.

• How to import sample data - learn about importing sample data to the selected tenant and then see how you can manage it in the Management Dashboard.

The Tenant List view of the Emporix Developer Portal is the place where you can see all the tenants assigned to your account or you can create a new one.

Creating additional tenants

When you create an account on Emporix and verify your email address, you are asked to set up a tenant — your business subscription to Emporix services. This tenant acts as a production environment that your customers will interact with directly.

You can create more tenants for different purposes, such as a staging environment for testing. This way, you can try out new APIs, get familiar with New features, or verify your assumptions about our system without the risk of breaking the production environment.

1. Go to the Tenant List view.

2. Choose Add Tenant.

3. Provide required details and your preferences and confirm with Create a tenant.

Result: When the tenant is created in the system, you receive an email notification. You can start working with your new tenant.

Social login is a form of single sign-on offered to your customers. Instead of creating a new account specifically to your store, the customers can use their existing social networking service account, such as Facebook, Google, or other, to log in to your online store. Frequently, this is a more convenient option for your customers. Therefore, by facilitating users access, the social login feature enhances the overall user experience.

See how it is used on an example storefront page.

1. Open the login page on the storefront.

1. Choose Social login to log in with some other service credentials.

2. Choose the service to log in with, for example Google. You get redirected to the service to log you in with your existing account.

1. After authorization, you are logged in to the storefront.

Emporix makes it possible to seamlessly integrate your store with external systems, such as Content Management Systems (CMSs) or support platforms. These systems play crucial roles in enhancing your store's functionality. For example, a CMS is software that enables you to create, edit, and publish your store's content. Similarly, a support system allows you to manage customer interactions, resolve issues, and provide assistance efficiently, ensuring a smooth customer experience.

See what you can connect to:

• Emporix Contentful App - integrate your product data from Emporix to Contentful platform

• Emporix Builder.io Plugin - create websites using the data from Commerce Engine

• - integrate product data using Magnolia CMS

• - integrate with Zendesk to enhance customer support experience

• - integrate with Storyblok to create content displaying your products and categories

Our system is built with flexibility in mind and offers a wide range of integration options. Whether you're connecting third-party tools, internal platforms, or external services, we provide APIs and event-driven capabilities to make integration smooth and reliable. This documentation covers the available methods and practical examples to help you get started quickly.

Check the following guides:

• Auth Integrations

• ERP Integrations

The Manage API Keys view of the Emporix Developer Portal is the place where you access the API keys connected to your tenants. API keys allow you to access API from either business or a customer's perspectives.

When you create an Emporix tenant, you obtain keys to the following types of :

Emporix Commerce Engine is a cloud-native, API-first platform that provides all the core building blocks of modern digital commerce — from product catalogs and pricing to carts, orders, and promotions. Designed with a composable, MACH-based architecture, it gives enterprises the flexibility to scale, customize, and integrate commerce into any digital ecosystem. Choose it to power complex B2B and advanced B2C scenarios where agility, extensibility, and customer-specific experiences are critical to growth.

The My Account view of the is the place where you can manage your account information, change password, or set up the MFA.

Personal settings

In Personal settings, you can view and edit your personal information and see the specific roles you are assigned to in the and .

The Custom Roles section is visible if you have specific user groups assigned in the . These can be managed directly in the by CE Administrator users.

The System Management category contains overviews of the Emporix system management functionalities. Each document describes the way that a particular concept is designed in our system.

As an innovative commerce software, Commerce Engine (CE) can closely integrate with Orchestration Engine (OE), which is responsible for enhancing and improving business processes. We integrate CE and OE to enable a fully automated end-to-end process chain. This step is crucial for increasing efficiency, saving time, and providing seamless, fast, and reliable services to our customers. By eliminating manual processes and ensuring seamless collaboration between CE and OE, we strengthen excellence and innovation in digital commerce.

This documentation is build as a showcase to present business use cases that can be solved with a combination of CE and OE working together and creating one end-to-end process.

See the below business scenario as an example of an end-to-end business process:

is a visual and headless CMS platform that allows you to build webpages faster thanks to predefined building elements. You might want to use this solution to create or enhance your online store website or application. To facilitate integration between Emporix Commerce Engine and Builder.io, we have created a plugin that helps you connect your data and build your store even faster. The Builder.io Emporix plugin is made available through .

Within the Builder tool, you can find the plugin on the plugins list:

Purpose

There are numbers of marketing strategies you might use to gain new customers for your online store. One of them could be a Welcome Campaign that offers a discount coupon for first time users that register at your store. Here, you might use the power of value streams that come with Orchestration Engine. You can create such a scenario with a simple value stream, like the one presented in the example.

Overview video

In an e-commerce environment, data is often sourced from multiple systems. Commerce Engine provides the ability to extend the platform with additional tooling, ensuring seamless integration of data between business applications. Learn how you can extend Commerce Engine to streamline your operations.

At Emporix, we care much about security of our systems to protect your data. One of the security measures that Emporix undertakes is enabling appropriate user authentication and authorization. The tools within Emporix system allow for adequate verification of user identity and access rights.

To learn more about the tools and their configuration, see:

Emporix Commerce Engine is a modern digital commerce platform tailored for B2B businesses and sophisticated B2C, leveraging a composable architecture to enhance flexibility and scalability. Built on MACH principles (Microservices, API-first, Cloud-native, and Headless), it offers a robust infrastructure for various business needs. For B2B commerce, Emporix provides a suite of features tailored to enhance business operations and customer experience. These features include:

• Customer-Specific Pricing: Manage individual pricing agreements and frame contracts.

• Bulk Pricing and Discounts: Support volume-based pricing and discount algorithms.

• Rebate Schemes: Create custom rebate programs.

• Advanced Quoting and Approval Workflows: Streamline quoting processes and compliance workflows.

Additional Services:

• Authorization

• Artificial Intelligence

• Configuration

• Catalog, Product, and Price

For more details, visit .

Further, CE is integrated with OE to support a wide range of commerce-driven business processes.

Multi-tenancy

Site

The Emporix Commerce Engine ensures a seamless and integrated digital commerce experience, supporting various front-end interfaces and delivering high performance, scalability, and future-proofing. The headless commerce architecture allows businesses to choose their front-end presentation layers, providing flexibility in how they engage with customers. Additionally, the cloud-native design ensures high availability and dynamic scalability, allowing businesses to focus on innovation and growth without worrying about underlying infrastructure.

Tenants

Emporix is a multi-tenant SaaS solution. All tenants share the same hardware and software infrastructure. They are virtually separated by tenant IDs and access tokens.

API Settings

Regions

Emporix is hosted on Google Cloud in Europe, Netherlands - Eemshaven.

API Base URL

https://api.emporix.io

Authorization

All requests sent to the Emporix API require authorization with a valid access token. To obtain an access token, you need to know your Emporix API keys. The keys are automatically generated when you create a tenant.

JSON

The majority of the HTTP API endpoints consume and produce standard application/json payloads. To ensure that payloads are encoded correctly, use Content-type: application/json in your HTTP header when sending POST requests. When consuming a JSON response, ignore any unrecognized fields in JSON objects of responses, or deal with them such that it does not cause the client application to crash. The API assumes clients behave properly and considers the addition of new fields to be backward-compatible for existing clients. In addition, client applications should not rely on the presence of undocumented fields. Fields returned by an undocumented endpoint can be renamed or removed at any time without prior notice.

Identifiers

Some resources contain a field named id that uniquely identifies a resource. The id value is generated by Emporix when a resource is created. Some resources contain an additional field named code that also uniquely identifies a resource. However, the code field needs to be specified in the request body when creating a resource.

Update guarantees

Different kinds of requests in the Emporix API offer one of two update guarantees as described below.

Strong consistency (read-after-write consistency)

Whenever a resource is successfully updated or created, it is guaranteed that in a subsequent read (called read-after-write), the returned resource contains all the values from the latest successful update.

This type of consistency is usually available for all CRUD endpoints that do not require complex background processing. For example an update to the Customer.firstName field will be accessible across the Emporix API immediately.

Eventual consistency

Eventual consistency guarantee applies to all APIs that require background processing that is conducted in a non-blocking manner, usually through event-based processing or batching. In this scenario, it is guaranteed that all successful updates are processed and reflected by the system as soon as possible (or according to a particular API's detailed specification). However, a read subsequent to a successful write may result in returning non-updated values. An example of eventual consistency is the Product search API that requires indexing of Product data. As this is a costly operation that leverages an integration, the indexing is run asynchronously and may last longer than a subsequent read to a successful write.

Customer audit logs

You can request customer audit logs from Emporix by reaching out to our and sending the email request. The logs are kept for 2 years. You can retrieve information about create, update or delete operations. The records contain information about the tenant, timestamp and the person who performed the actions.

Free trial

You can try out the Emporix e-commerce features completely free of charge for 14 days. With our free trial, you get full access to the production-ready e-commerce system, together with our storefront and so you can test all of functionalities before you decide to become our partner.

When your free trial ends, the Emporix sales team will contact you to hear about your experience with our products.

Use Case

As a B2B seller, you'd like to set permissions and scopes to your end customers and respond to their specific needs. While the buyer companies have multiple representatives, with frequently different liability levels, it is crucial for them to manage the users and assign relevant permissions to the organization resources in your store. For example, they'd like to keep their purchase orders under control and therefore they'd like to be able to view the orders made not only by themselves but also the other orders that were related to their company (legal entity).

In this case, customer groups and shared orders features come very useful on the storefront. With the right access, the end customers are able to take care of user management on their own, without the need to contact your support team.

Customer Groups in the Management Dashboard

As a B2B seller, you have an option in the Management Dashboard to create and manage B2B customer groups. Customer groups are legal-entity-aware, so the information relevant to the company can be read by the relevant customer group.

A customer group is automatically created when creating a company in the system. A customer assigned to the legal entity (company) is assigned to the customer group. Also, a new customer that signs up to the storefront, gets assigned to the customer group related to the company they provide during the registration.

To manage a customer group on behalf of your B2B customer in the Management Dashboard, go to the Customer Management -> Groups. You can create and edit customer groups from there. You can change and add permission scopes or manage group members.

Adding company related orders visibility

To allow your customers to view the orders associated with the same organization, assign the read scope for legal entity in relation to the order objects.

Viewing shared orders on the storefront

Your B2B customer now has an option to monitor what has already been ordered on behalf of their organization. After logging in, they go to their account details.

In My Orders, they can view the orders placed by themselves:

But, if they have been assigned to a group with the read for legal entity scope for orders, they can also view the history of orders placed by other members of their company:

Viewing the orders related to the company improves the collaboration and transparency for your customers as it allows them to check the order details, return the items, or make the same order if needed.

Thanks to the scopes and permissions, they can consciously control who gets access to the company's shared information. If they don't have the right scope assigned, they're not able to see the company-related orders:

Thanks to the Single sign-on functionality, working with Emporix Commerce Engine is even easier for your employees.

Purpose

Single sign-on is an authentication scheme that allows users to log in to different business applications with a single ID without the need to re-enter authentication credentials. Enabling SSO enhances the user experience, bolsters security measures and simplifies identity management within your organization. As the SSO ensures standardized integration for backend logins, the employees can access Emporix Management Dashboard of Commerce Engine with the same login they use for other systems you've integrated with your identity provider. The Emporix SSO functionality has been implemented flexibly for you to integrate with an identity provider of your choice. The identity provider has to be compatible with OpenID Connect (OIDC). For example, you can integrate with Azure AD, Google, Apache Directory Server, or other.

Features

Overview

The following diagram presents the general process:\

Configuration

Emporix SSO functionality enables integration of external identity providers (IDP) with the Emporix authentication system. You can choose any identity provider that is compatible with OpenID Connect (OIDC) standard.

As a customer, you have to configure the IDP system of your choice and provide the required credentials to Emporix so that we can enable SSO for your tenants.

As the IDP configuration is tool-specific and dependent on your needs, we don't impose any configuration steps. Once you have the application registered in your identity provider, provide the credential details to Emporix. Depending on your IDP, these may be called differently, but should be equivalent to a unique identifier (for example `Application ID`) and secret password (for example `client secret`). These details are essential to enable the SSO functionality on the Emporix side.

Redirect URI

In your IDP system, register a redirect URI with a callback function: https://auth.emporix.io/oauth2/v1/authorize/callback. The URL is where the identity platform redirects a user's client and sends security tokens after authentication.

Login page

The login page contains the option to log in to Emporix systems using Single sign-on once you enter the configured email address:

If your email domain is configured to use SSO, once you enter it, the option to Login with SSO appears, and you get redirected to the IDP provider to verify your credentials. Once you are logged in, you don't have to re-enter the password to log in to the Emporix Management Dashboard.

SSO connection

After the SSO has been properly configured on IDP and Emporix, the authentication happens in the background. See how it works together on the following diagram:

Each time an employee logs in to the Developer Portal or Emporix Management Dashboard system, a request is sent to the Emporix user authentication solution with the proper IDP ID. The solution communicates with the Identity Provider system. The IDP returns a token that allows the user to log in to the Emporix Management Dashboard.

This is to demonstrate how our Coupon Service and Reward Point Management Service can be used.

Coupons

Coupons can be managed within the Management Dashboard, two different types are supported:

• Percentage

• Absolute

1. Login as a customer and add products to the cart.

2. Go to the checkout and add a coupon to the cart.

1. Choose Apply, the discount is calculated based on the Subtotal without VAT.

1. Go through the normal check out and submit the order. The discount is also displayed within the My Orders overview page.

Reward Points

Reward points can be exchanged for coupons by customers within the B2B Showcase. To have that functionality available it is necessary to create rewards points first using the endpoint.

In case a customer already had points, use Adding to add additional points to a customer.

Points can be exchanged to coupons, which then can be used for future purchases. Redemption options are not limited and can be configured by your employees

To use it within the B2B Showcase follow the steps:

1. Login and add a product to the cart.

2. Go to the checkout and click on Get coupons for points.

1. The redeem options are displayed which were configured beforehand. Select one redeem coupon and click on Redeem selected.

Result: The discount should appear in green and the points are counted down.

1. Proceed with the checkout and submit the order.

Optimistic locking is a concurrency control mechanism that prevents overriding another user's changes when multiple transactions accessing the same data are happening simultaneously. The main idea behind it is to avoid the use of locks and instead assume that conflicts between operations are rare. With optimistic locking, we can ensure better performance of the Emporix applications. Within Commerce Engine, optimistic locking is based on the metadata.version field. It's supported at the API level, but it also works within Management Dashboard directly.

All the metadata fields are set during a document creation in the database, and their values are as follows:

• version = 1

• createdAt = Instant.now()

• modifiedAt = Instant.now()

Here’s how optimistic locking works:

1. Version check: Triggered by an API request or an action within Management Dashboard, the optimistic locking mechanism checks if the request includes the metadata.version field.

2. Transaction processing: The transaction proceeds with the requested changes and updates the data tentatively only in memory, excluding id and metadata fields from the payload.

3. Document update: The mechanism updates the metadata

The Emporix Contentful App allows you to visually select your store's products from Emporix and reference them in Contentful entries.

Prerequisites

To use the Emporix Contentful App, you need:

• A Contentful content type. It needs to include at least one field with its type set to either Short text or Short text, list.

Emporix credentials for integrating with Contentful:

• Search API Key

• Index Name

Installing the Emporix app on Contentful

1. Log in to .

2. Navigate to Apps -> Manage apps.

3. Select the Emporix app and click Authorize access.

4. Fill out the Emporix app fields with your Algolia credentials. a. Paste your Search API Key in the Search Key field. b. Paste your

1. Click Install.

Using the product picker to select products

1. Navigate to the Content tab.

2. Select or create a new entry of the content type for which you installed the app.

3. Find the field and click Select products.

1. Use the search bar to search for products by name.

2. Select the products and click Save products.

1. Selected products should now appear in the content editor.

Here you can find an overview of the universal search connector in Emporix, along with its features and benefits.

Purpose

With the Emporix universal search connector, it is possible to gather all events happening in the system and set up automated actions that will ensue in relation to those events. Every time an object is created, updated, or deleted, the events are being indexed and sent to the Webhook Service. The webhook events are further sent out to the Svix application, which in turn updates the search engine database of your choice. The actions, as configured in Svix, can be executed in various third-party applications, as the solution is universal and widely applicable.

Features

Overview

The indexing process consists of the following sequence of events:

1. When a product-related event takes place, it is processed by CE.

2. The event is consumed by a messaging system and undergoes indexing.

3. An indexing message is sent to the Webhook Service.

1. The Webhook Service forwards the message to the Svix Event Gateway.

2. The Event Gateway passes the event to your pre-configured endpoint for this particular event, and updates the search engine database of your choice.

To ensure smooth shopping experience for your customers, your online store has to have some backend mechanism to check availability of the products in your storefront site.

In B2B world, typically customers get assigned to a specific warehouse based on their address. The warehouse is determined when a customer logs in to the online store. Basing on the assigned warehouse, the customer can see the relevant availability of products in the store. Frequently, the availability data comes from external systems such as ERP or OMS. When the customer adds a product to cart, the background process has to retrieve its availability information from an external system and return it to the storefront to allow or disallow the customer complete the checkout.

In this use case, we demonstrate how you can use CE together with OE to automate the process of assigning a customer to a warehouse and triggering availability check from an external system for a product added to a cart. Additionally, when a product is not available, the automated process notifies a merchant and asks for their approval to transfer the goods delivery to another warehouse where the product is available. The product availability is reflected in the storefront making it possible to complete the checkout. The customer in turn gets a coupon code for free shipping as a form of making up for the delayed delivery. The value stream enhances customer satisfaction and increases retention rate.

Sounds like a valid use case for your business? Let's take a look at how such a value stream can be configured.

Process flow

In this value stream, we cover the following flow:

We are going to create two value streams that can run separately: one value stream responsible for getting the right warehouse data, and another value stream taking care of checking products availability and taking appropriate actions when products are out of stock.

Warehouse availability

When a customer logs in to the online store, the value stream for assigning a corresponding warehouse starts. OE listens to the webhook event when a customer logs in and based on the customer's address information it writes down the warehouse information in the session context.

This way, the availability of products in the storefront reflects the stock levels in the particular warehouse that the customer got assigned to. The session context holds the information about the warehouse that is later retrieved when a customer adds a product to cart.

The value stream ends here, but if the customer decides to make some purchases on the storefront, their action triggers another value stream.

Item added to cart

1. This value stream starts when a customer adds an item to cart. Orchestration Engine is subscribed to the webhook event of logging in that triggers the workflow.

2. The product availability is checked against the warehouse stock levels and is updated in the cart.

• If the product is available, the flow ends. The customer can proceed with the checkout and complete the purchase.

• If the product is out of stock, we add conditional logic for additional steps.

  • OE sends a form to a merchant with a request for transferring the missing product from another warehouse. The merchant gets a magic link to a form where they can directly act on the request.

  When the merchant approves the change and the goods are transferred, it serves as a trigger to check availability and update it in the customer's cart to notify them that the items are ready to be purchased again.

Introduction

The Emporix system allows to integrate with Unzer as the payment provider.

What we support, is the Pay by Invoice solution as the post-checkout approach. No other Unzer integration is possible at the moment.

The diagram shows how Unzer sequence looks like when it's integrated with Emporix:

Gateway configuration

Prerequisite

For the Emporix and Unzer configuration, you need to have the private key and the public key from your Unzer account.

Creating the payment mode

To create the new payment mode, execute the following request:

• UNZER_PAYMENT_METHOD_TYPE - PAYLATER_INVOICE is the supported payment method.

• UNZER_PUBLIC_KEY - The public key from your Unzer account.

• UNZER_PRIVATE_KEY - The private key from your Unzer account.

• UNZER_CUSTOMER_TYPE - Either B2B or B2C.

Storefront implementation

The integration with Unzer does not require any specific implementation on the storefront side. Emporix implements the server-side-only integration with Unzer, therefore there is no need to generate any token - it's done by the Emporix Payment Gateway service.

The only thing you need to ensure is that you’re providing the following data during the authorization request:

• ORDER_ID - Identifier of an order.

• paymentModeId - Identifier of the payment mode that you got from https://api.emporix.io/payment-gateway/{TENANT}/paymentmodes/frontend endpoint.

The is designed to help you manage your company account at Emporix.

Login page

You can log in to the Developer Portal using one of the following methods:

• Password-based authentication

In this scenario, we'll explore how AI is used by Orchestration Engine and Commerce Engine to automate Order Entry across various sales channels. Handling sales orders by email channels requires manual involvement, which is often very time consuming and inefficient. The integration of CE, OE and AI enhances and improves business processes by minimizing manual work. You can see how Emporix contributes to automating the quote and order entry process.

The scenario covers a use case when a customer sends an email with a PDF order form. Information about this event works as a trigger for OE to start the process and then for AI to begin a quote preparation that finally leads to completing the order for the customer.

Process flow

With the HTTP webhook strategy active, all the events are sent to the configured destinationURL through HTTP POST requests. These requests can be (optionally) authenticated using HMAC (Hash-based message authentication code). By using HMAC, you can add authentication layer and verify that the incoming data is correct and authentic.

To enable such an authentication mechanism, provide the secretKey

Integrating two systems can be a complex task, especially when it comes to ensuring consistent data synchronization across platforms. Emporix is designed to simplify this process with its robust and flexible APIs. Its extensible data models, together with mixins possibilities, allow for seamless customization to meet specific business needs. Most importantly, Emporix reduces the challenges of integration by providing an integration-friendly API architecture, streamlining the process and enabling efficient connections between systems.

To facilitate integration with other systems, Emporix offers the following capabilities:

Custom ID

Typically, the integration layer and ERP systems lack visibility into the entity IDs generated by the Commerce Engine during creation. Emporix resolves this issue by enabling the configuration of custom IDs.

The Core Commerce category contains overviews of the Emporix e-commerce solutions. Each document describes the way that a particular concept is designed in our system and how it can benefit your business.

Emporix allows for configuration of a variety of payment methods. In the scenarios below, you can see how the configuration works with the example of Emporix demo storefront.

User scenarios

Examples of the payment methods seen from the user perspective when creating an order on a storefront.

Credit Card with Spreedly Express

When users choose to pay with a credit card, they have to follow the standard payment process and provide their credit card details for payment authorization.

1. As a checkout step, the user sees a list of available payment methods and selects the Credit card payment option.

1. The user chooses the Enter Payment Info button and then provided the credit card details.

1. The user chooses Pay Now and finished the checkout process. The payment amount is authorized automatically and it is captured during the invoice generation.

Credit Card 3D Secure with Spreedly Express

Users can choose to pay with a 3D secure credit card. In comparison to the standard credit card, 3D secure adds an additional security layer to the payment process. Users have to provide an authorization token that is generated and sent to them during the payment process.

1. As a checkout step, the user sees a list of available payment methods and selects the Credit card (3D Secure) payment option.

2. The user chooses the Enter Payment Info button and then has to provide the credit card details.

3. The user chooses Pay Now and sees the 3D Secure window.

1. The user finishes the checkout with the credit card authorization. Spreedly sends a callback to the Emporix payment gateway with a result of the authorization. The payment amount is authorized automatically and it is captured during the invoice generation.

Spreedly Sprel

Spreedly Sprel is a solution to use for the off-site payments. It means the payments are done after an order is placed.

1. As a checkout step, the user sees a list of available payment methods and selects the Sprel payment option.

1. The user completes the checkout and after the order is completed sees the option to finish the payment.

1. The user chose the Finish Payment button and completed the payment process. Spreedly sends a callback to the Emporix payment gateway with a result of the authorization. The payment amount is authorized automatically and it is captured during the invoice generation.

Payment operations

Details of the payment possibilities, cancellations and returns.

Payment statuses

To check a payment status of an order, go to Management Dashboard -> Orders -> Payment Info tab.

• In the Payment information section, you have information about the payment provider, payment method, transaction ID (an internal Emporix transaction ID), current status, authorized amount, paid amount and the last message.

• In the Transaction logs section you can see all the payment events. Usually the following events are included there:

  • AUTHORIZATION_START - when an order is created

All possible statuses:

• PENDING - an order has been created but payment is not done yet

• AUTHORIZATION_SUCESS - an authorization flow finished with success

• AUTHORIZATION_FAILURE - an authorization flow finished with failure

• CAPTURE_SUCCESS - a capture flow finished with success

Payment capture

Capture is a process done during an invoice generation. It's when a payment is completed by settling funds for the transaction.

1. To generate the invoice, go to Management Dashboard -> Orders.

2. Select the order and go to the Data tab.

3. Choose the Send Invoice button.

Result: The payment capture is done with the invoice generation. After that, the invoice is sent to a customer.

Payment refund

The payment refund is possible only when a payment has been invoiced and capture done. The user can get a full or partial refund of the order, but it's not possible to return more than the captured value.

1. To create the refund, go to Management Dashboard -> Orders.

2. Select the order for which the payment should be revoked and go to the Payment Info tab.

3. In the Refund section add a value that should be refunded and confirm it by choosing the Refund button.

Result: The refund is confirmed and the event is visible in the Transaction logs.

Payment cancellation

Payment cancellation can happen for many reasons, for example when a user requests to cancel an order, or an order cannot be completed by a store.

If for any reason the order is not completed and the payment should be cancelled, the merchant can set the order status to cancelled. The cancellation is then done automatically after the status change.

1. To set the status as cancelled, go to Management Dashboard -> Orders.

2. Select the order for which the payment is cancelled and go to the Data tab.

3. In the Order section choose Cancelled as the extended order status.

Result: The order payment cancellation is visible in the Payment Info tab. The status is displayed as Cancellation Success.

The Manage Users view of the Emporix Developer Portal is designed to help you manage team members who can access your Emporix tenant and also set proper access to the Management Dashboard.

To find a specific user, search by their name or email address. You can also use the filters options for users of a specific application: Management Dashboard or Developer Portal, or of a specific role they have within the tenant, which means in what capacity they access the Developer Portal.

To edit user's personal details or access settings, choose the Edit icon next to the chosen user and amend the details accordingly.

Adding users

The Developer Portal ADMINS can add new tenant users.

Adding a single user

To add a single user:

1. Choose + Add user.

2. Provide personal details and email address.

3. Select a relevant Developer Portal role, and the Management Dashboard role.

4. Confirm with Save.

Adding multiple users

Adding multiple users and specifying their roles is possible by CSV import option.

To add multiple users:

1. Choose +CSV Import users.

2. Download the CSV file with a template for multiple user import. The template includes the name of the user, their email address, and roles within the Developer Portal and Management Dashboard.

3. Add the users to your CSV file. The pattern is name,surname,email address,tenant role, MD role, for example: john,doe,[email protected],User,CE Manager.

1. Save the file.

2. Import the CSV file using the drag-and-drop or by browsing your files.

After the file is uploaded, you get a notification with confirmation that the users were added to the tenant.

As a result of user creation, each new user gets an email with activation code to confirm their account details and a welcome email inviting them to join the tenant. When they activate their account, they have to set the password. With the first login to the tenant, they can also opt in for the Emporix newsletter.

Resetting a user's password

If a user forgets their password, they can use the reset option on the login page. The user gets an email with the recovery code thanks to which they are able to set a new password.

The ADMIN users in the Developer Portal also have the option to trigger resetting a password for a user in the Developer Portal.

To reset a user's password:

1. Select a particular user and use Edit to see their details.

2. Go to the Change password tab and choose Reset user password.

The user gets an email with the recovery code and a link to change the password.

The Emporix use cases documentation is to demonstrate how the Emporix API can be used on a frontend. No middleware was used to build the showcase and every API call is visible from the browser developer network tab.

Below you can see a general explanation how the B2B Showcase is structured and some description about core elements.

My Account

When you log in to the showcase as a valid user, you can see the name of your account on the right hand side of the menu. Clicking on the name gives you the option to go to your account settings.

The account details page includes such information as your personal details, company details, orders, quotes, carts, returns, or discounts.

• My Orders: All the orders are visible together with their details.

• My Quotes: All the quotes are visible together with their details. Here, you can decide to approve, decline or request a change for a specific quote.

• Addresses: It is possible to add, edit or create a new address for the B2B customer.

• My Returns: All the returns created by a user and their corresponding statuses.

Navigation menu

The reference store navigation menu consists of two layers:

• The top layer has a site, language and currency selector, a customer user login link and a sign-up link. This layer shows a sign up page, which allows you to create a new showcase Customer and Customer ID accessible with the Emporix Management Dashboard.

• The lower layer has:

  • Catalog link, which dynamically builds a menu out of the category structure in the demo data from the connected tenant

Catalog

Product display

The Product display is split into a facet or filter list on the left hand side, and a grid or list view on the right.

When you are not logged in the display shows the default catalog price. When you are logged in, it shows your personalized pricing, assuming you have a corresponding Emporix price list defined.

When you click on an individual product tile in the grid, or row in the list, it opens up the Product Details page for that product.

Product details page

The Quantity and Add to Cart buttons work to add the item to the Cart. All the displayed data like product name, product description, images and attributes comes from a demo catalog.

Contacts

In case of questions please contact Emporix at or .

To submit new ideas, visit the .

As a B2B customer, with Emporix you can easily manage your company data and your company users' data directly from your storefront.

Company setup while registering as a customer

When a new customer registers at your storefront, all the registration data are automatically reflected in your Emporix account. This includes the company data, like address and contact information that your new customer provided during the registration. The most important piece of information is the customer's email address. By default, the customer is created with the admin role and becomes a primary contact for the company, if no other primary contact exists.

Creating users within the storefront

1. Log in to your storefront account and go to My account -> Manage Users.

2. To start creating a new user, choose Create new user.

3. Enter the user data, and choose the role for the user: you can select between Admin, Purchaser and Requester.

After you create the new user, they receive an email notification to set the account password.

All of the users' data is reflected and visible in the Emporix account in the backend system.

B2B sign-up process

During the sign-up process, when the customer has a defined b2b.companyRegistrationId property, an additional validation takes place. The populated b2b property indicates that the registration process is for the B2B customers. The properties that are required for the B2B customers are:

• firstName

• lastName

• company

By default, a B2B customer is added to a legal entity matched by the name. If such a legal entity doesn’t exist, the company is created in the system, but only after an address is assigned to the newly created customer.

When the Admin customer creates a customer, the customer is automatically assigned to the legal entity of the Admin customer. When the customer is created for the B2B flow, then the default employee is informed about that by an email notification. The default employee is defined by the default_employee property.

Approval requests flow

Having different user roles within a company helps in keeping the purchasing process in an ordered and transparent way. Anytime an order that is created has to be approved, the approval process starts.

Requesting an approval

As a purchaser or material manager, you can create orders within the storefront and then request an approval. To request the approval, a user has to create a standard order first and then go through the standard checkout flow. During the checkout, the user can create an approval request for ordering the items in the cart.

1. To start the approval process, choose the Request approval option.

2. Choose the person who should be an approver of the request and add any additional information if necessary. After that, use the Submit button to send the request.

Result: After sending the approval request an email notification is sent to the approver. You can also see a confirmation message that the approval was requested. In your Saved Carts , you can check the status of your request.

Approving the request

As an admin, you have the permission to approve the order requests that are sent by a purchaser or a material manager. When such a request is created, you get an email notification informing you about a pending approval.

1. To start working on the approval requests, go to the Saved Carts in your storefront account. Here, you can check the requests that are pending processing.

2. Choose the approval request to view the checkout details for the order.

3. Review the order, change the shipping information if needed, and decide if you approve or decline the request.

   • If you decide to approve, choose the

Offering personalized experiences to your customers can be a game changer for your business. Tailored content and responding to what your customers need is the key to gaining loyalty and trust. Customer Segments is a convenient tool for targeting the right group of people with the relevant products or promotions. Let's see in action how you can use the functionality in your online store.

Let's assume that for certain customers, for example, of a specific industry, you want to display some dedicated categories and products only. You'd also like to promote some specific products and make a special price offer for these customers. When the customers of that segment log in to your store, they see only the offer that is best suited to their industry needs and fulfill their shopping lists. The customers receive a special discount coupon that they can redeem at checkout. With customer segments you can easily achieve that and respond to any similar scenario.

Segment creation

1. First, create a segment. To demonstrate the case, create a segment for the DE site with some categories assigned, and a few additional products that you want to sell to the segment customers. Remember to save your changes at every step of the segment configuration.

1. Assign the chosen category to the segment:

And assign a few additional products:

1. Add a coupon that is valid only for the segment assignments:

1. Add customers as the segment members:

Personalized shopping

Now, the customers who are members of the Golden Card segment get a personalized shopping experience on the DE site.

To demonstrate the difference, first log in as a customer that is not assigned to any segments. Judy Wilson, from Company XYZ, is not assigned to any segment and she can browse all the products and categories on the storefront:

Now, check what's available for a customer that belongs to the segment with a dedicated category and products. John Doe, is one of the customers assigned to the Golden Card segment. When Mr Doe logs in to the online store, he can browse only the Golden Card assortment plus the additional products assigned to the segment.

The dedicated segment products are available under the Assigned Products tab.

Mr Doe has received an email notification with the special coupons details. He decides to make some purchases and adds chosen items to the cart. He continues to the checkout where he's able to apply the coupon codes that are valid for the segment assignments only. The coupons in this case use the subtotal amounts as tax calculation base.

As this example demonstrates, the customer gets a personalized shopping experience, which leads to greater customer satisfaction. Customer segments feature facilitates the way how you can increase customer loyalty by tailoring the storefront content to the dedicated customers and responding quickly to the ever-changing market requirements.

Segmented search offer in the showcase

To further personalize the shopping experience and ensure that customers can only search relevant products, we have added segments to for our showcase. For example, only search results that match the segment are displayed. This additional enhancement ensures a customized and efficient shopping experience for all customers.

Here you can find an overview of the Emporix Webhook Service, along with its features and benefits.

Purpose

To move towards an event-driven architecture, we are introducing the Webhook Event Publishing functionality. This feature, implemented through the Emporix API Webhook Service, allows external systems to subscribe to internal events published by the Commerce Engine. Thanks to the Webhook Service, you do not need to call specific API endpoints to look for recent changes in services — you will be automatically notified instead.

Features

The Webhook Service introduces the following features:

Webhooks strategies

You can apply one of the following strategies to your tenant:

• Svix-Shared - default strategy allowing you to use the shared Svix subscription offered by Emporix

• Svix - strategy that allows you to connect your own Svix licence

• HTTP - strategy that provides possibility to receive events notification as HTTP requests to a declared URL

Overview

The Emporix Webhook Event Publishing process consists of the following sequence of events:

1. When an event that you subscribed to takes place, a message is sent to the Webhook Service.

2. The Webhook Service forwards the message to the Event Gateway.

3. The Event Gateway passes the event to your pre-configured endpoint for this particular event.

Introduction

Keycloak is an open-source Identity and Access Management (IAM) solution that supports standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0. Integrating Keycloak with Emporix allows for secure management of user authentication and access across applications. At the same time it reduces development effort and aligns with enterprise compliance needs.

As a centralized identity provider, Keycloak supports Single Sign-On (SSO), external identity federation and fine-grained access control.

You can integrate Emporix with Keycloak and ensure clean separation between identity management and business functionality, while at the same time meeting the diverse needs for authentication, federation, and security.

Integration setup request

If you have a Keycloak account and want to integrate with Emporix, contact our and provide us with the following data:

• The domain is the Keycloak domain value, for example, keycloak.eu.yourdomain.com.

• The token_endpoint is the endpoint that is used for the token call, for Keycloak it’s usually protocol/openid-connect/token.

• The provider

See the request example:

Cart

When a customer is browsing products on your storefront and finds something interesting, they can put it in cart with a standard Add to cart option. When they're done with selecting products, they select the Cart icon to see all the chosen items. It's possible to edit the cart content, add or subtract the product quantities or remove items from the cart before proceeding to checkout.

Very often customers want to negotiate the price regarding the products they want to buy. For such a process, it is important that an eCommerce platform supports a more sophisticated process. Requesting a quote is a common use case especially for B2B business model, but within the Emporix platform, the quotes for B2C customers are also supported.

Below you can see the general, simplified flow:

Not only the customer is able to request quotes, but also the merchant's employee or a sales manager can generate a quote on behalf of the customer. This is described step by step in the 2nd demo scenario - Employee creates quote on behalf of a customer.

Roles included:

• B2B or B2C customer

Emporix is designed to integrate seamlessly with ERP systems. To integrate an ERP system like SAP with Emporix, an integration layer (such as a middleware solution or API management platform) can be utilized to handle data exchange efficiently. This layer can collect and transform data, for example IDocs from SAP, into a suitable format, such as JSON, and make the necessary API calls to Emporix. Options for integration include using an IPaaS platform or an API management layer that supports OData, REST API, or other protocols, enabling flexible and scalable integration tailored to the specific requirements of the ERP and target systems.

Given SAP’s significant presence in the ERP software space, we highlight a scenario in which asynchronous pricing and order replication occur from the Emporix Commerce Engine to SAP ERP. In this example, we selected SAP BTP Integration Suite (formerly known as SCPI) to streamline the integration process, leveraging Emporix flexible API capabilities.

Emporix - SAP integration

Purpose

The localization concept in the Emporix e-commerce system helps you adapt your business's content to international audiences.

Localizable data

Here you can find an overview of the customer groups feature and its benefits.

Purpose

B2B scenarios require applying more structure to the management of your end customers. With Customer Groups, you can easily manage your customers to ensure the right level of authorization and access is granted to the customers within a company (legal entity).

Magnolia CMS is a content management system (CMS) designed to help businesses manage and deliver digital content across multiple channels.

The Magnolia eCommerce Connector developed by Arvato Systems Switzerland, enables seamless integration of products managed in directly into the Magnolia CMS. The provides several out-of-the-box features, such as apps that allow users to view and manage products, catalogs, and categories from directly within Magnolia. It also includes searchable products and categories, a local cache mechanism and an e-commerce integration registry.

Each catalog contains a list of products that have been assigned to it.

Selecting a specific product allows you to view all the relevant details associated with it.

Here you can find an overview of the Emporix Brand Service, along with its features and benefits.

Here you can find an overview of the Emporix Label Service, along with its features and benefits.

Here you can find an overview of the Emporix AI Assistance, along with its features and benefits.

In case a customer is not satisfied with the product, they can call the merchant (customer service) and ask for a return of a complete order, partial order or from different orders for different products.

Scenario - Customer calls Merchant Support to return items

A customer created several orders with several items. After the delivery the customer calls the merchant customer service to ask for a return of one or more items.

1. As a customer service employee, log in to the Management Dashboard and open the returns overview page.

1. To open the edit mode, click the Create return button.

2. Select the order you want to make a return for:

a. Existing customers: Select the corresponding customer from the list.

After selecting the customer, go to the Orders tab to select the orders which the customer wants to create the return for.

b. Guest customers: Go to Orders tab to find the relevant order. You can filter the orders by email from the purchase.

1. In the Products tab, all the related products are displayed for these selected orders. The following screen shows the selected orders and the corresponding products.

If different reason codes and reason details are necessary, it is possible to maintain a different reason for separate materials.

1. Select the products which should be returned. With selecting the items the pricing calculation takes place.

1. The return total is calculated with the selected products. Within the last step, in the review tab, it is possible to check the whole return.

Check the return under review and save the return.

Result: After saving the return it is visible under the Returns overview with status pending.

1. It is possible to change the statuses within the details of the return.

Let's assume everything is booked in the corresponding backend systems (integration work for a project). The status is selected and set to Approved within the Management Dashboard.

1. Save the return, the status gets updated.

Scenario - Customer creates a return from the storefront

Within this scenario, we provide the possibility to enable the self service for your customer. This means your customer is able to create a return from your storefront.

1. Customer logs in and opens the My Orders overview under My Account.

1. The customer clicks on Return and the order that is to be returned is opened.

1. The customer clicks the Submit return button, a return is created within the showcase and Management Dashboard.

• Storefront view:

• Backend view: Overview page - return is created with status pending

• Return details:

1. The employee can decide if the return is rejected, approved or just closed. In this case, the return is approved.

1. The status is updated for the customer under My Account → My Returns.

Return details:

It is not possible to create a second return for the same order in the showcase.

Here you can find an overview of the Emporix identity and access management (IAM) concept, along with its features and benefits.

Purpose

The IAM feature has been introduced to help you control the user access level in specific services. By defining clear-cut roles and permissions, you can be sure that unauthorized users won't be able to modify or view sensitive data. We have prepared a set of predefined access control templates so that you can get started quickly.

Features

The Emporix IAM concept introduces a set of features that make identity and access management easier:

Overview

The following diagram presents an example of the information flow in the IAM Service.

Access control templates

Emporix provides you with several predefined access control templates that you can apply to a group:

Here you can find an overview of the Emporix Vendor Management Service, along with its features and benefits.

Purpose

The Vendor Management feature in Emporix enables efficient management of the relationships with external suppliers. It offers a structured way to onboard, maintain, and govern vendors while ensuring proper access control and data integrity. Vendors and their employees are granted restricted access, allowing them to interact only with their own products, orders, and data.

Features

The Emporix API Vendor Management Service introduces a set of features that make managing your orders and suppliers easier:

Here you can find an overview of the Emporix Reward Points Service, along with its features and benefits.

Purpose

With the Emporix API Reward Points Service, you can ensure customer engagement and satisfaction by giving your customers reward points for every successfully completed order, or regardless of the orders made. In the former case, the reward points are automatically added, which significantly minimizes the effort on the side of your employees. In the latter, your employees can add reward points manually as an additional form of rewarding your customers, for example on their birthday. Points can be exchanged to coupons, which then can be used for future purchases. Redemption options are not limited and can be configured by your employees. By that token, you can adjust the service to your and your customers' needs.

Features

Here you can find an overview of the Emporix API Media Management Service, along with its features and benefits.

Purpose

You can upload media files, such as images or video, and/or documents, for example contracts or specification sheets, by using the Emporix Media Management Service. By specifying the access types of the files, you can decide whether they should be accessible to the public on your storefront, or meant for internal purposes only.

The assets, either linked from an external webpage, or uploaded directly from your internal storage, can serve to better reflect the categories and products your business offers, and to facilitate category and product management within your company.

Features

Overview

The following combinations of assets are possible:

• Public access files linked from an external site

• Public access files uploaded directly from a local repository

• Private access files linked from an external site

• Private access files uploaded directly from a local repository

Zendesk is a customer service and engagement platform designed to help businesses improve their customer support operations. Emporix enhances the support workflow by connecting seamlessly with the platform.

With Emporix Connect for Zendesk Support, order information is integrated directly into the ticket view, providing support agents with instant access to key details such as ordered products or shipping and billing addresses.

By eliminating the need to switch between systems, this integration streamlines the process, enabling faster, more accurate responses. The outcome is a more efficient support operation and higher customer satisfaction.

To start working with Emporix Connect for Support:

1. Download the application from Zendesk App Marketplace.

2. Get your Emporix API Credentials. Go to -> . In the API Key section you can check your clientID and Secret values.

1. Copy your credentials (Client ID, Secret, and tenant) as they are required in the next installation steps.

2. Install the Emporix Connect for Support and provide the Emporix API keys credentials when requested.

3. During the installation process you can also set the OrderDisplayLimit. By default, the limit is set to 3.

The Customer Management module of the Emporix Management Dashboard is designed to help you manage companies, customers, contacts and discount coupons.

The Customer Management module is made of three sections:

• Companies - where you can manage details of the companies assigned to the customers

• Customers - where you can manage all the customers and contacts' details

• - where you can manage customer groups and their access permissions

• - where you can manage customers' groupings together with featured products and categories

• - where you can manage discounts for the customers

Here you can find an overview of the Emporix orders concept, along with its features and benefits.

Purpose

The orders functionality at Emporix manages the entire lifecycle of customer orders, ensuring a smooth experience for both customers and businesses. It allows customers to place, manage, and track their purchases effortlessly while enabling businesses to process and fulfill orders in a scalable, automated manner.

Features

The Emporix orders functionality combines a set of features:

Overview

Orders operations can be handled end-to-end by Emporix or integrated with external systems, providing businesses with multiple approaches to order management.

The Order Service is built to support both B2B and B2C commerce. Additionally, the service offers dedicated endpoints for different use cases like allowing customers to create and retrieve their own orders, while also enabling employees to handle orders through tenant-managed processes.

To learn more about the different order management approaches and the service possibilities, see the .

Mixin Schemas

Emporix Commerce Engine provides an extensibility mechanism that allows you to customize the platform adjusting it to the customers needs. The mixin schemas concept allows you to easily extend the data model so that you can boost default objects with customer-specific fields.

Purpose

To meet customer-specific requirements, it is sometimes necessary to extend the default entities and provide additional information. The mixin schemas feature offers a simple and centralized way of adding customized fields to different objects that provide more industry-specific context. The customized fields are displayed in the Management Dashboard and can be managed from there.

Overview video

The diagram shows in a nutshell how creating a schema works:

Features

Mixin schemas come with a few features that make the management of customized schemas easier:

Thanks to HTTP webhook strategy, you can choose the event service that enables communication between Emporix and external systems. This article demonstrates how you can connect Amazon Simple Queue Service to receive events notifications from Emporix. Follow the steps to set up the connection on both sides. Adjust the actual implementation to your needs. Amazon Simple Queue Service (SQS) is a service that allows for sending, storing, and receiving messages between distributed systems. As such, you can choose it as one of the solutions to connect Emporix with some other systems in your company through the webhooks functionality.

Preparing Amazon infrastructure

The integration between Emporix and Amazon Simple Queue Service in this example will use Amazon Lambda that is able to receive the HTTP request, validate HMAC signature and then send the request body to the specified queue.

The cart and checkout functionality typically enables customers to purchase items listed in your store's database. During checkout, the system calculates the total price, taking into account the listed prices, shipping costs and any applicable discounts. However, in B2B use cases, you may need to integrate an external system to calculate prices, custom fees or even allow the purchase of products sourced from an external ERP system, bypassing the standard product catalog.

Emporix recognizes that B2B transactions often demand competitive pricing tailored to various factors, such as product relationships, purchase volume, customer loyalty, and more. It also understands that sometimes you might require to calculate additional fees for shipping, freight and more.

To address this, Commerce Engine allows seamless integration with external systems that handle product management, price calculations and custom fee management. By leveraging external applications, businesses can ensure accurate and tailored pricing for each customer, streamline pricing and fee processes, and enhance overall operational efficiency. This can be accomplished by leveraging the extensibility features of the Cart Service.

The extended cart supports the following integration scenarios:

Introduction

offers a versatile, ready-to-use solution for integrating authentication and authorization services into your applications.

Auth0 facilitates simplified authentication for users. Instead of having to log in separately to each individual application or platform, users can enter their credentials once and subsequently be authenticated across multiple websites or applications.

The following diagram shows the authentication and authorization flow:

Here you can find an overview of the Emporix API Availability Service, along with its features and benefits.

Here you can find an overview of the company shared orders concept, along with its features and benefits.

Here you can find an overview of the Emporix Customer Management Service, along with its features and benefits.

The catalog concept allows you to create and manage catalogs.

The category management concept allows you to create and manage categories, subcategories, and category trees.

Learn more about the Customer Segments feature in the Emporix Commerce Engine.

Here you can find an overview of the Emporix Returns Service, along with its features and benefits.

The Emporix Management Dashboard is designed to help you manage your store's resources.

User Interface

Emporix Management Dashboard allows you to smoothly navigate through the modules and manage your business configuration settings, customers, orders, catalogs, products, pricing, and other.