Documentation

This is the early access documentation preview for Custom Views. This documentation might not be in sync with our official documentation.

Help needed?

This page documents known and recurring challenges with Custom Views 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.

Additionally, we also recommend checking for existing GitHub Issues about similar problems you might have or opening a new one.

Browser support

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 11 and below

It is recommended to always keep your browser up-to-date for security reasons.

Granular permissions for local development

This method requires additional configuration and setup and is only recommended for development teams with prior experience in Custom Views development and installation.

By default, developing a Custom View requires you to be a member of the Administrators Team. However, for security reasons, your Organization might not be willing to grant administrator access to developers. In this case, an Organization can grant access using a regular team.

To enable this option, you must complete the following prerequisites in the Merchant Center (which can be done only with administrator rights):

  1. Configure the Custom View in the Merchant Center

For local development the Custom View does not have to be deployed, and Custom View URL is not relevant. Therefore, any acceptable value can be provided in the registration form.

  1. Assign the Custom View ID
  2. Install the Custom View
  3. Create a team (or utilize an existing one)
  4. Obtain the teamId from the Merchant Center URL
  5. Invite users to the team
  6. Assign relevant permissions to the team

After completing these steps, you will have an customViewId and a teamId. You must provide these values for env.production.customViewId and env.development.teamId, respectively, in the Custom View configuration file.

This process allows any member of the configured team to log in and perform local development for the Custom View.

Limitations

Custom Views have the following limitations:

OAuth Scopes cannot be changed in the Ready state

OAuth Scopes cannot be changed when a Custom View is in the Ready state as it can be installed and used while in this state. You can change the list of OAuth Scopes assigned to the Custom View permissions only in the Draft state when configuring the Custom View in the Merchant Center.

To change the OAuth Scopes:

  1. Move the Custom View to the Draft state.
  2. Update the list of OAuth Scopes.
  3. Change the state to Ready.
  4. Install the Custom View again.

When a Custom View state is changed from Ready to Draft, it is uninstalled from all Organizations and Projects. Thus, when installing the Custom View again, Team permissions must be assigned again.