Added identity providers —
Check the API reference
LogoLogo
Other APIsChangelog
  • Welcome to Provisioning API
  • Getting started
    • API specification
    • Authorization
    • Applications
  • API reference
    • API credentials
      • The API credential object
      • Create an API credential
      • List all API credentials
      • Retrieve an API credential
      • Update an API credential
      • Delete an API credential
    • Application memberships
      • The application membership object
      • Create an application membership
      • List all application memberships
      • Retrieve an application membership
      • Update an application membership
      • Delete an application membership
    • Identity providers
      • The identity provider object
      • Create an identity provider
      • List all identity providers
      • Retrieve an identity provider
      • Update an identity provider
      • Delete an identity provider
    • Memberships
      • The membership object
      • Create a membership
      • List all memberships
      • Retrieve a membership
      • Update a membership
      • Delete a membership
    • Membership profiles
      • The membership profile object
      • Create a membership profile
      • List all membership profiles
      • Retrieve a membership profile
      • Update a membership profile
      • Delete a membership profile
    • Organizations
      • The organization object
      • Create an organization
      • List all organizations
      • Retrieve an organization
      • Update an organization
    • Permissions
      • The permission object
      • Create a permission
      • List all permissions
      • Retrieve a permission
      • Update a permission
    • Roles
      • The role object
      • Create a role
      • List all roles
      • Retrieve a role
      • Update a role
    • User
      • The user object
      • Retrieve the user
      • Update the user
    • Versions
      • The version object
      • List all versions
      • Retrieve a version
On this page
  • Permissions
  • Bundles
  • Customers
  • Exports
  • Gift cards
  • Imports
  • Inventory
  • Orders
  • Price lists
  • Promotions
  • Returns
  • Shipments
  • SKU lists
  • SKUs
  • Stock transfers
  • Subscriptions
  • Tags
  • Webhooks
  • Custom apps
  1. Getting started

Applications

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

PreviousAuthorizationNextAPI credentials

Last updated 3 months ago

The Commerce Layer admin includes a set of back-office applications built on top of our 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 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 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

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

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Customers

Full access

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Exports

Full access

Resource
Create
Read
Update
Delete
Restrictions

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

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Gift cards

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Imports

Full access

Resource
Create
Read
Update
Delete
Restrictions

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

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Inventory

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Orders

Full access

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Price lists

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Promotions

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Returns

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Shipments

Full access

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

SKU lists

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

SKUs

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Stock transfers

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Subscriptions

Full access

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Payment sources

Tags

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

Webhooks

Full access

Resource
Create
Read
Update
Delete
Restrictions

Read-only

Resource
Create
Read
Update
Delete
Restrictions

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.

The Commerce Layer application for managing . You can create new bundles or search (filtering by market and tag) and edit existing ones.

The Commerce Layer application for managing . 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.

The Commerce Layer application for managing . You can see your export history with export statuses and errors (if any), and create new exports from the UI.

The Commerce Layer application for managing . 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.

The Commerce Layer application for managing . You can see your import history with import statuses and errors (if any), and create new imports from the UI.

The Commerce Layer application for managing . 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.

The Commerce Layer application for managing . 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.

The Commerce Layer application for managing . You can create new price lists or edit existing ones by adding prices, setting the currency, and determining whether taxes are included or not.

The Commerce Layer application for managing all types of . 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.

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

The Commerce Layer application for managing . 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.

The Commerce Layer application for managing . You can create new SKU lists or edit existing ones by adding or removing SKU list items.

The Commerce Layer application for managing . You can create, delete, edit, search, and filter your SKUs, along with adding their shipping info and options.

The Commerce Layer application for managing . 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.

The Commerce Layer application for managing . 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.

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

The Commerce Layer application for managing . You can see your webhook history with webhook statuses and errors (if any), and create new webhooks from the UI.

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

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 , the React component library used to build our Dashboard applications.

App Elements
read this guide
permissions
SKU
SKU
Bundles
Customers
Exports
Gift cards
Imports
Inventory
Orders
Price lists
Promotions
Returns
Shipments
SKU lists
SKUs
Stock transfers
Subscriptions
Tags
Webhooks
Dashboard
this monorepo
custom app
Core API
bundles
customers
exports
gift cards
imports
stock items
orders
price lists
promotions
returns
shipments
SKU lists
SKUs
stock transfers
order subscriptions
tags
webhooks
Bundles
Markets
Organizations
SKU list items
SKU lists
SKUs
Tags
Bundles
Markets
Organizations
SKU list items
SKU lists
SKUs
Tags
Addresses
Attachments
Customer addresses
Customer groups
Customer payment sources
Customer subscriptions
Customers
Markets
Orders
Organizations
Payment methods
Tags
Addresses
Attachments
Customer addresses
Customer groups
Customer payment sources
Customer subscriptions
Customers
Markets
Orders
Organizations
Payment methods
Tags
Addresses
Bundles
Coupons
Customer subscriptions
Customers
Exports
Exports
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
Exports
Organizations
Customers
Gift card recipients
Gift cards
Markets
Organizations
Tags
Gift card recipients
Gift cards
Markets
Organizations
Tags
Coupon codes promotion rules
Imports
Imports
Markets
Organizations
Price lists
Promotions
SKU lists
Stock locations
Tax calculators
Imports
Organizations
SKU lists
Organizations
Reserved stocks
SKUs
Stock items
Stock locations
Organizations
Reserved stocks
SKUs
Stock items
Stock locations
Addresses
Adjustments
Attachments
Bundles
Customers
Inventory models
Inventory return locations
Line item options
Line items
Markets
Orders
Organizations
Payment methods
Price lists
Return line items
Returns
Shipments
Shipping methods
SKU list items
SKU lists
SKUs
Stock line items
Stock locations
Stock transfers
Tags
Transactions
Addresses
Adjustments
Attachments
Bundles
Customers
Inventory models
Inventory return locations
Line item options
Line items
Markets
Orders
Organizations
Payment methods
Price lists
Returns
Shipments
Shipping methods
SKU list items
SKU lists
SKUs
Stock line items
Stock locations
Stock transfers
Tags
Transactions
Organizations
Price frequency tiers
Price lists
Price volume tiers
Prices
SKUs
Tags
Organizations
Price frequency tiers
Price lists
Price volume tiers
Prices
SKUs
Tags
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
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
Addresses
Attachments
Customers
Line items
Markets
Orders
Organizations
Return line items
Returns
Stock locations
Tags
Transactions
Addresses
Attachments
Customers
Line items
Markets
Orders
Organizations
Return line items
Returns
Stock locations
Tags
Transactions
Addresses
Attachments
Carrier accounts
Customers
Line items
Orders
Organizations
Packages
Parcel line items
Parcels
Payment methods
Shipments
Shipping methods
SKUs
Stock items
Stock line items
Stock locations
Stock transfers
Tags
Transactions
Addresses
Attachments
Carrier accounts
Customers
Line items
Orders
Organizations
Packages
Parcel line items
Parcels
Payment methods
Shipments
Shipping methods
SKUs
Stock items
Stock line items
Stock locations
Stock transfers
Tags
Transactions
Bundles
Links
Markets
Organizations
SKU list items
SKU lists
Bundles
Organizations
SKU list items
SKU lists
Links
Markets
Organizations
Shipping categories
SKUs
Tags
Organizations
Shipping categories
SKUs
Tags
Addresses
Attachments
Line items
Orders
Organizations
Shipments
Stock locations
Stock transfers
Transactions
Addresses
Attachments
Line items
Orders
Organizations
Shipments
Stock locations
Stock transfers
Transactions
Addresses
Bundles
Customer payment sources
Markets
Order subscription items
Order subscriptions
Orders
Organizations
SKUs
Subscription models
Addresses
Bundles
Customer payment sources
Markets
Order subscription items
Order subscriptions
Orders
Organizations
SKUs
Subscription models
Organizations
Tags
Organizations
Tags
Event callbacks
Organizations
Webhooks
Event callbacks
Organizations
Webhooks