This page documents known and recurring challenges with Custom Applications and potential solutions to them.
Something is not working as expected? Do you need general guidance? Do you have a technical question or are you simply looking for some advice?
We strongly encourage and recommend to use GitHub Discussions as a way of communicating with us (commercetools) and with the community. You can ask questions, share ideas, showcase your work, etc.
commercetools officially supports the latest two versions of all major browsers (Google Chrome, Mozilla Firefox, Apple Safari, Microsoft Edge), unless otherwise noted.
The following browsers are not supported any longer:
IE 11and below
It is recommended to always keep your browser up-to-date for security reasons.
Using a test or staging environment for my Custom Application
During the development cycle of new features for a Custom Application, it can be helpful to showcase or test those new features before publishing them to the production environment. This can be accomplished using deployment previews which allow you to inspect different versions of a Custom Application.
This approach is no longer recommended. Instead, you can use the deployment previews feature to have a simpler setup.
To emulate a Custom Application preview, create multiple Custom Applications in the Merchant Center, each with a different
You must configure the Custom Application to support dynamic values for the
entryPointUriPath and build different versions of it.
Setting up dynamic configurations of Custom Applications (per environment) is further explained in this section.
The same Custom Application can be deployed several times and have its configuration file set to use different
entryPointUriPath values by taking advantage of environment variables for each deployment.
Let's say there are two deployments of the same application:
B. We can assign an environment value for the
entryPointUriPath property in its configuration.
ENTRY_POINT_URI_PATH environment variable can be provided in different ways.
as an inline environment variable when running a script command.
using a dotenv file.
by defining the environment variables in your CI service.
Using this pattern, different
entryPointUriPath values can be defined for different environments:
With this setup, preview versions of the Custom Application can be deployed to the
B environment and tested using the application
my-application-entry-point-test entry point path.
However, besides using different
entryPointUriPath values, the logic of verifying the user permissions in the Custom Application source code must also be adjusted accordingly.
As explained in this section, the permission names of a Custom Application are derived from the
entryPointUriPath value. Therefore, when using different
entryPointUriPath values, the permission names must also be changed.
We recommend using the helper function
entryPointUriPathToPermissionKeys to compute the permission names from the
Find more information on how to apply user permissions in the Permissions documentation.
In this scenario the
entryPointUriPath value cannot be defined statically but it's injected using an environment variable.
Therefore, both server-side and client-side logic must be considered when reading the value from the source code.
The page keeps reloading itself
If the Merchant Center page keeps reloading itself when accessing a Custom Application, most likely, there's a misconfiguration of the
See Page reloading behavior for more information on debugging and solving this issue.
Session token expiration
In the browser, the session token is stored in a secure cookie named
mcAccessToken and is valid for 30 days.
Custom Applications have the following limitations:
Project access is not automatically updated for newly created Projects on AWS
When a new Project is created in the Organization, the Project cannot be accessed despite the Project access setting being configured to Install for all projects of this organization for an installed Custom Application.
To grant access, the Project access must be updated manually for the installed Custom Application.
This limitation applies specifically to Projects in AWS Regions.