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
  • Let's get started!
  • Additional developer tools
  • More to read

Welcome to Provisioning API

Why a Provisioning API by Commerce Layer and how to get started with it

NextAPI specification

Last updated 3 months ago

is a transactional commerce API for international brands. It lets you make any digital experience shoppable, anywhere.

In addition to the , developers can leverage our own Provisioning API which exposes all the endpoints you need to exercise greater control over your organizational structure and user roles.

Most of those features are also available the codeless way from the UI of our (built on top of our APIs):

Making direct calls to the Provisioning API allows you to manage provisioning tasks automatically instead of manually (eventually, even build your own custom Dashboard!).

This way, you can streamline user onboarding by creating accounts and permissions with simple API requests. You can also pull API credentials for Commerce Layer web apps, integrations, and sales channels directly from the API, making it possible to programmatically dole out API access for key integrations and/or sales channels whenever required. Thus many of the administrative tasks that go with proper user and application access can be automated, saving time and helping scale your business.

The guide that follows is your reference for all the operations that you can perform on the Provisioning API resources and contains all the information you need to get a comprehensive overview of how you can use it.

Let's get started!

  • A high-level explanation of the resource usage.

  • The resource object and its fields, attributes, and relationships.

  • The allowed CRUD operations you can perform on the related endpoint with basic examples of the request/response format.

Data model

Additional developer tools

More to read

Set out by checking the and learning . Then go through the at your leisure — there, for each single resource, you can find:

Have a look at the related and explore the flowchart that illustrates how most of the Provisioning API resources relate to each other.

To speed up your development process you can leverage the , a TypeScript library wrapper that makes it quick and easy to interact with Commerce Layer Provisioning API, both in browser and Node.js applications.

The TypeScript SDK is built on top of the , that you can use as well to to build mock servers, auto-generate code, SDKs for other languages, implement contract testing, and more.

If you want to use the Provisioning directly from the command line feel free to give the of a try!

If you're new to you can and try our Core commerce API while reading the .

See the Metrics API guide and to learn how to extract almost any kind of data information from your Commerce Layer's organization order history.

Check Commerce Layer's to stay up-to-date with any changes, new features, and general improvements about the Provisioning API itself or any other Commerce Layer's app and open-source project.

For everything else, and feel free to ask any questions to the team or get involved in the conversation with the rest of our developers' community.

API specification
how to authenticate
API reference
ER diagram
Provisioning SDK
Provisioning OpenAPI schema
Provisioning plugin
Commerce Layer CLI
Commerce Layer
sign up for free
documentation
join us on Discord
changelog
Commerce Layer
Dashboard
Core API
Getting started
API reference