Applications

Commerce Layer open-source back-office applications and their sets of permissions

The Commerce Layer admin Dashboard includes a section for back-office applications built on top of our Core API covering some of the platform's main features (such as orders or customers management, importing or exporting data, and more).

Any Commerce Layer account comes with a hosted version of any of those applications that is automatically enabled for Admin users, who can then enable them for other members of the organization with Full or Read-only access. If you need further customization for one or more of your applications, they are all released as open-source projects so that you can fork them to make the changes that suit your needs, add your custom app to the Dashboard, and start using your own self-hosted version.

This is the list of all the currently available Commerce Layer Dashboard open-source applications:

ApplicationAPI credential kindOpen-source repository

customers

View it on GitHub.

exports

View it on GitHub.

imports

View it on GitHub.

inventory

View it on GitHub.

orders

View it on GitHub.

price_lists

View it on GitHub.

promotions

View it on GitHub.

returns

View it on GitHub.

shipments

View it on GitHub.

sku_lists

View it on GitHub.

skus

View it on GitHub.

stock_transfers

View it on GitHub.

tags

View it on GitHub.

webhooks

View it on GitHub.

Permissions

Each application is equipped with a different set of permissions in terms of CRUD actions on the single Core API resources. You can check them here below.

Customers

Full access

ResourceCreateReadUpdateDeleteRestrictions

Payment sources

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Payment sources

Exports

Full access

ResourceCreateReadUpdateDeleteRestrictions

{"status"=>["pending", "interrupted", "completed"]}

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Imports

Full access

ResourceCreateReadUpdateDeleteRestrictions

{"status"=>["pending", "interrupted", "completed"]}

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Inventory

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Orders

Full access

ResourceCreateReadUpdateDeleteRestrictions

Payment sources

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Payment sources

Price lists

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Promotions

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Returns

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Shipments

Full access

ResourceCreateReadUpdateDeleteRestrictions

Payment sources

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Payment sources

SKU lists

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

SKUs

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Stock transfers

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Tags

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Webhooks

Full access

ResourceCreateReadUpdateDeleteRestrictions

Read-only

ResourceCreateReadUpdateDeleteRestrictions

Custom apps

All applications showcased on the Dashboard provide extensive customization options. You can enhance their functionality by adding new features, extending existing ones, and integrating with 3rd-party APIs, among other possibilities.

After you made your changes and thoroughly tested your custom app, you can seamlessly integrate it into the Dashboard, making it accessible to your entire team.

When you fork the related repository, your custom app inherits the original app set of permissions. If you need any additional information on how to fork an app from the Dashboard UI, please read this guide.

To replicate the Dashboard look and feel when customizing your apps or building any other app on top of Commerce Layer's APIs you can easily leverage App Elements, the React component library used to build our Dashboard applications.

Last updated