Docs

Commerce Layer API Documentation

This is the complete API documentation for connecting to the Commerce Layer API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Commerce Layer: Manage markets, inventory, orders, pricing, and promotions across channels. Keep reading to get started.

Quickstart

Before you run your first Commerce Layer request, you need three things:

  1. A MindCloud account — sign in or create an account at MindCloud.
  2. A MindCloud API Key — create one in API Keys. Keep it on your server.
  3. At least one Commerce Layer connection — create or choose one in Connections. Note its connectionId.

Every Commerce Layer action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/commerceLayer/latest/actions/{actionSlug}

You need a MindCloud API Key and a Commerce Layer connection. Then call an action such as Get Address:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/commerceLayer/latest/actions/get-address" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Commerce Layer account that should run the action. MindCloud stores and refreshes the Commerce Layer credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Create a Commerce Layer integration credential

You need a Commerce Layer account and an organization in the environment you want to connect to MindCloud.

  1. Open the API credentials page

    Sign in to the Commerce Layer dashboard, choose the correct environment, and open Developers > API credentials.

    Developers → API credentials
  2. Create an Integration credential

    Select New, choose Integration, and create the credential for the organization you want MindCloud to access.

  3. Copy the connection values into MindCloud

    Enter the Client ID, Client Secret, and the organization Core API endpoint. The Core API endpoint uses the format https://yourdomain.commercelayer.io.

Commerce Layer actions

All 59 published actions for this Commerce Layer version. Each page documents the endpoint, arguments, and response controls.

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.