Skip to main content
Clover recommends merchant-generated API tokens for single-merchant integrations only. Use OAuth 2.0 to connect multiple merchants.

​
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.

  • North America (US & Canada) — default region, no additional configuration needed
  • Europe — select if your merchant account is on the Clover Europe platform
  • Latin America — select if your merchant account is on the Clover Latin America platform
  • 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.

​
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.

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

​
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.

  • Click Get Started if this is your first token, otherwise click Create new token.
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.

3

Copy the token

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

  • Note: Permissions can be edited on the token later. Actions fail with 401 Unauthorized when the token is missing the permission they require.
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.