> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Clover with API Key – StackOne Hub

> Link a Clover account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using Clover actions.

> [!WARNING]
>
> Clover recommends merchant-generated API tokens for single-merchant integrations only. Use OAuth 2.0 to connect multiple merchants.

Select Actions to adjust the guideSome actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.

Select all
Clear

ActionScope(s)

Loading actions...No actions match your search.

Dynamic Guide URL

Copy URL

Scopes Selected

<pre role="textbox" aria-readonly="true" tabIndex="0" />

Separator

Copy scopes

## Select your region

Your Clover merchant region determines which API endpoints are used.

**1. Identify your region**

Select the region that matches your Clover merchant account.

<ul>
  <li>**North America (US & Canada)** — default region, no additional configuration needed</li>
  <li>**Europe** — select if your merchant account is on the Clover Europe platform</li>
  <li>**Latin America** — select if your merchant account is on the Clover Latin America platform</li>
  <li>If unsure, check the URL when signed in to the Clover Merchant Dashboard — `clover.com` is North America, `eu.clover.com` is Europe, `la.clover.com` is Latin America.</li>
</ul>

## Enter your Merchant ID

The Merchant ID is a 13-character alphanumeric identifier unique to your Clover business.

**1. Find your Merchant ID**

Sign in to the Clover Merchant Dashboard for your region and locate your Merchant ID in the browser URL.

<ul>
  <li>The Merchant ID is the 13-character value after `/m/` in the URL</li>
  <li>Example URL: `https://www.clover.com/dashboard/m/ABC1DEF2GHI3J` (domain varies by region)</li>
  <li>Merchant ID: `ABC1DEF2GHI3J`</li>
  <li>For sandbox: `https://sandbox.dev.clover.com/developer-home/m/ABC1DEF2GHI3J`</li>
  <li>Copy this value and paste it into the **Merchant ID** field.</li>
</ul>

## Create an API token

Generate a merchant-specific API token in the Clover Merchant Dashboard. Sign in with an employee account that has the Admin role.

**1. Open the API tokens page**

In the Clover Merchant Dashboard, go to **Settings** > **View all settings** > **Business Operations** > **API tokens**.

<ul>
  <li>Click **Get Started** if this is your first token, otherwise click **Create new token**.</li>
</ul>

**2. Name the token and set permissions**

Enables actions: Create A Customer, Create A Discount, Create A Discount On An Order, Create A New Line Item, Create A Phone Number For A Customer, Create A Tax Rate For A Merchant, Create An Address For A Customer, Create An Email Address For A Customer, Create An Employee, Create An Inventory Item, Create An Item Category, Create Custom Orders, Create Shift For An Employee, Delete A Customer, Delete A Single Item Category, Delete A Single Shift, Delete An Employee, Delete An Inventory Item, Delete An Order, Delete An Order Discount, Get A Category, Get A List Of Customers, Get A Merchant's Address, Get A Merchant's Properties, Get A Single Customer, Get A Single Discount, Get A Single Employee, Get A Single Inventory Item, Get A Single Merchant, Get A Single Order, Get A Single Payment, Get A Single Refund, Get A Single Tax Rate, Get All Cash Events, Get All Categories, Get All Devices Provisioned To A Merchant, Get All Discounts, Get All Employees, Get All Inventory Items, Get All Line Items For An Order, Get All Modifiers, Get All Order Types For A Merchant, Get All Payments, Get All Payments For An Order, Get All Refunds For A Merchant, Get All Roles For A Merchant, Get All Shifts For An Employee, Get All Tags, Get All Tax Rates, Get All Tenders For A Merchant, Gets A List Of Orders, Update A Category, Update A Customer, Update A Line Item, Update A Phone Number For A Customer, Update A Single Shift, Update An Address For A Customer, Update An Email Address For A Customer, Update An Employee, Update An Existing Inventory Item, Update An Order, Update Merchant Properties, Update The Stock Of An Inventory Item, Void A Line Item

Enter a token name (for example, `StackOne Integrations`) and select the Read or Write permissions for each category the integration needs.

<ul>
  <li>
    MERCHANT\_R
  </li>

  <li>
    MERCHANT\_W
  </li>

  <li>
    ORDERS\_R
  </li>

  <li>
    ORDERS\_W
  </li>

  <li>
    INVENTORY\_R
  </li>

  <li>
    INVENTORY\_W
  </li>

  <li>
    CUSTOMERS\_R
  </li>

  <li>
    CUSTOMERS\_W
  </li>

  <li>
    EMPLOYEES\_R
  </li>

  <li>
    EMPLOYEES\_W
  </li>

  <li>
    PAYMENTS\_R
  </li>

  <li>
    PAYMENTS\_W
  </li>
</ul>

**3. Copy the token**

Click **Create Token**, then copy the generated token and paste it into the **API Token** field.

<ul>
  <li>Note: Permissions can be edited on the token later. Actions fail with 401 Unauthorized when the token is missing the permission they require.</li>
</ul>

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.