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:

Application	API credential kind
Bundles	bundles
Customers	customers
Exports	exports
Gift cards	gift_cards
Imports	imports
Inventory	inventory
Orders	orders
Price lists	price_lists
Promotions	promotions
Returns	returns
Shipments	shipments
SKU lists	sku_lists
SKUs	skus
Stock transfers	stock_transfers
Subscriptions	subscriptions
Tags	tags
Webhooks	webhooks
Generic	generic

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

Resource	Create	Read	Update	Delete	Restrictions
Bundles
Markets
Organizations
SKU list items
SKU lists
SKUs
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Bundles
Markets
Organizations
SKU list items
SKU lists
SKUs
Tags

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

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Customer addresses
Customer groups
Customer payment sources
Customer subscriptions
Customers
Markets
Orders
Organizations
Payment methods
Payment sources
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Customer addresses
Customer groups
Customer payment sources
Customer subscriptions
Customers
Markets
Orders
Organizations
Payment methods
Payment sources
Tags

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

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Bundles
Coupons
Customer subscriptions
Customers
Exports
Exports					{"status"=>["pending", "interrupted", "completed"]}
Gift cards
Line items
Markets
Order subscriptions
Orders
Organizations
Payment methods
Price lists
Prices
Shipments
Shipping categories
Shipping methods
SKU list items
SKU lists
SKU options
SKUs
Stock items
Stock locations
Tax categories
Transactions

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Exports
Organizations

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

Resource	Create	Read	Update	Delete	Restrictions
Customers
Gift card recipients
Gift cards
Markets
Organizations
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Gift card recipients
Gift cards
Markets
Organizations
Tags

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

Resource	Create	Read	Update	Delete	Restrictions
Coupon codes promotion rules
Imports
Imports					{"status"=>["pending", "interrupted", "completed"]}
Markets
Organizations
Price lists
Promotions
SKU lists
Stock locations
Tax calculators

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Imports
Organizations
SKU lists

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

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Reserved stocks
SKUs
Stock items
Stock locations

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Reserved stocks
SKUs
Stock items
Stock locations

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

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Adjustments
Attachments
Bundles
Customers
Inventory models
Inventory return locations
Line item options
Line items
Markets
Orders
Organizations
Payment methods
Payment sources
Price lists
Return line items
Returns
Shipments
Shipping methods
SKU list items
SKU lists
SKUs
Stock line items
Stock locations
Stock transfers
Tags
Transactions

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Adjustments
Attachments
Bundles
Customers
Inventory models
Inventory return locations
Line item options
Line items
Markets
Orders
Organizations
Payment methods
Payment sources
Price lists
Returns
Shipments
Shipping methods
SKU list items
SKU lists
SKUs
Stock line items
Stock locations
Stock transfers
Tags
Transactions

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

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Price frequency tiers
Price lists
Price volume tiers
Prices
SKUs
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Price frequency tiers
Price lists
Price volume tiers
Prices
SKUs
Tags

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

Resource	Create	Read	Update	Delete	Restrictions
Buy X pay Y promotions
Coupon codes promotion rules
Coupons
Custom promotion rules
Custom promotion rules
External promotions
Fixed amount promotions
Fixed price promotions
Flex promotions
Free gift promotions
Free shipping promotions
Markets
Order amount promotion rules
Orders
Organizations
Percentage discount promotions
Price lists
Promotion rules
Promotions
SKU list promotion rules
SKU lists
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Buy X pay Y promotions
Coupon codes promotion rules
Coupons
Custom promotion rules
Custom promotion rules
External promotions
Fixed amount promotions
Fixed price promotions
Flex promotions
Free gift promotions
Free shipping promotions
Markets
Order amount promotion rules
Orders
Organizations
Percentage discount promotions
Price lists
Promotion rules
Promotions
SKU list promotion rules
SKU lists
Tags

Returns

The Commerce Layer application for managing returns. You can initiate returns, manage their acceptance or rejection, and restock them when appropriate.

Full access

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Customers
Line items
Markets
Orders
Organizations
Return line items
Returns
Stock locations
Tags
Transactions

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Customers
Line items
Markets
Orders
Organizations
Return line items
Returns
Stock locations
Tags
Transactions

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

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Carrier accounts
Customers
Line items
Orders
Organizations
Packages
Parcel line items
Parcels
Payment methods
Payment sources
Shipments
Shipping methods
SKUs
Stock items
Stock line items
Stock locations
Stock transfers
Tags
Transactions

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Carrier accounts
Customers
Line items
Orders
Organizations
Packages
Parcel line items
Parcels
Payment methods
Payment sources
Shipments
Shipping methods
SKUs
Stock items
Stock line items
Stock locations
Stock transfers
Tags
Transactions

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

Resource	Create	Read	Update	Delete	Restrictions
Bundles
Links
Markets
Organizations
SKU
SKU list items
SKU lists

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Bundles
Organizations
SKU
SKU list items
SKU lists

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

Resource	Create	Read	Update	Delete	Restrictions
Links
Markets
Organizations
Shipping categories
SKUs
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Shipping categories
SKUs
Tags

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

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Line items
Orders
Organizations
Shipments
Stock locations
Stock transfers
Transactions

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Attachments
Line items
Orders
Organizations
Shipments
Stock locations
Stock transfers
Transactions

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

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Bundles
Customer payment sources
Markets
Order subscription items
Order subscriptions
Orders
Organizations
Payment sources
SKUs
Subscription models

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Addresses
Bundles
Customer payment sources
Markets
Order subscription items
Order subscriptions
Orders
Organizations
Payment sources
SKUs
Subscription models

Tags

The Commerce Layer application for managing tags. You can create new tags, and edit or delete existing ones.

Full access

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Tags

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Organizations
Tags

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

Resource	Create	Read	Update	Delete	Restrictions
Event callbacks
Organizations
Webhooks

Read-only

Resource	Create	Read	Update	Delete	Restrictions
Event callbacks
Organizations
Webhooks

Generic

Generic apps are a special kind of custom apps that can have Full access (read and write) or Read-only permissions on all the Commerce Layer Core resources, thus enabling you to create the most flexible custom Dashboard applications tailored to your needs (e.g. mixing features of multiple original Commerce Layer Dashboard apps in one single app, specifiyng a dedicated slug, icon, etc. — check this basic example as a starter).

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.