Applications
Commerce Layer open-source back-office applications and their sets of permissions
The Commerce Layer admin Dashboard includes a set of 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 under this monorepo so that you can run them all locally effortlessly and choose to customize and release a single application or all of them. You can then 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:
bundles
customers
exports
gift_cards
imports
inventory
orders
price_lists
promotions
returns
shipments
sku_lists
skus
stock_transfers
subscriptions
tags
webhooks
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.
Bundles
The Commerce Layer application for managing bundles. You can create new bundles or search (filtering by market and tag) and edit existing ones.
Full access
Read-only
Customers
The Commerce Layer application for managing customers. You can search, filter, and list them, see their order history, statuses, and relevant customer groups, together with the addresses they’ve saved and the payment information in their wallet.
Full access
Payment sources
Read-only
Payment sources
Exports
The Commerce Layer application for managing exports. You can see your export history with export statuses and errors (if any), and create new exports from the UI.
Full access
{"status"=>["pending", "interrupted", "completed"]}
Read-only
Gift cards
The Commerce Layer application for managing gift cards. You can see all of your gift cards and filter them by market and status, create new gift cards, and edit, activate, and deactivate existing ones.
Full access
Read-only
Imports
The Commerce Layer application for managing imports. You can see your import history with import statuses and errors (if any), and create new imports from the UI.
Full access
{"status"=>["pending", "interrupted", "completed"]}
Read-only
Inventory
The Commerce Layer application for managing stock items. You to set stock levels for all the SKUs in each of your stock locations by adding and removing stock items, or updating their quantity.
Full access
Read-only
Orders
The Commerce Layer application for managing orders. You can see and filter your order history with order statuses, details, and timelines. You can also edit orders, move them through their lifecycle, and more.
Full access
Payment sources
Read-only
Payment sources
Price lists
The Commerce Layer application for managing price lists. You can create new price lists or edit existing ones by adding prices, setting the currency, and determining whether taxes are included or not.
Full access
Read-only
Promotions
The Commerce Layer application for managing all types of promotions. You can view active, upcoming, disabled, or all of your promotions by clicking any of the views, along with creating new promotions by type (external promotions included) or editing existing ones.
Full access
Read-only
Returns
The Commerce Layer application for managing returns. You can initiate returns, manage their acceptance or rejection, and restock them when appropriate.
Full access
Read-only
Shipments
The Commerce Layer application for managing shipments. You can track down shipments through search and filters. You can also see the history, status, and relevant information for a shipment, preparing packages, and purchasing shipping labels.
Full access
Payment sources
Read-only
Payment sources
SKU lists
The Commerce Layer application for managing SKU lists. You can create new SKU lists or edit existing ones by adding or removing SKU list items.
Full access
Read-only
SKUs
The Commerce Layer application for managing SKUs. You can create, delete, edit, search, and filter your SKUs, along with adding their shipping info and options.
Full access
Read-only
Stock transfers
The Commerce Layer application for managing stock transfers. You can search and filter through your stock transfer history checking their status, details, and timeline. You can also see the associated orders, shipments, and addresses.
Full access
Read-only
Subscriptions
The Commerce Layer application for managing order subscriptions. You can search and filter through your order subscription history to check their status and any other details. You can deactivate, re-activate, or cancel subscriptions as well as edit existing ones to change their frequency and/or the scheduled date for the next run.
Full access
Payment sources
Read-only
Payment sources
Tags
The Commerce Layer application for managing tags. You can create new tags, and edit or delete existing ones.
Full access
Read-only
Webhooks
The Commerce Layer application for managing webhooks. You can see your webhook history with webhook statuses and errors (if any), and create new webhooks from the UI.
Full access
Read-only
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