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

# Clover

> How to set up the Clover connector, plus the actions that are available.

![Clover](https://stackone-logos.com/api/clover/filled/svg)

Betav4.0.0[See changelog](https://docs.stackone.com/connectors/clover/changelog.md)

[64 actions](#actions) · 3 auth methods

E-Commerce
Payments

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/clover/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 authentication with expiring tokens required

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/clover/guides/connector-profile/api-key.md)
>
> No app registration required. Uses a merchant-generated API token that is scoped to a single merchant, with Read or Writ...

> [card] [OAuth 2.0 (PKCE) · Connector Profile](https://docs.stackone.com/connectors/clover/guides/connector-profile/oauth-2-0-pkce.md)
>
> Requires registering a Clover web app but no App Secret, as the authorization code is exchanged with PKCE. Access tokens...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/clover/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/clover/guides/link-account/api-key.md)

> [card] [OAuth 2.0 (PKCE) · Link Account](https://docs.stackone.com/connectors/clover/guides/link-account/oauth-2-0-pkce.md)

**4. Use Actions**

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

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

## Actions

Scopes

Select all
|
Clear

CUSTOMERS\_R

CUSTOMERS\_W

EMPLOYEES\_R

EMPLOYEES\_W

INVENTORY\_R

INVENTORY\_W

MERCHANT\_R

MERCHANT\_W

ORDERS\_R

ORDERS\_W

PAYMENTS\_R

No scopes found

64 actions

ActionDescriptionRequired scopes

Get A Single Merchant`clover_get_merchant`

Get a single merchant

`MERCHANT_R`

Get A Merchant's Properties`clover_get_merchant_properties`

Get a merchant's properties

`MERCHANT_R`

Update Merchant Properties`clover_update_merchant_properties`

Update merchant properties

`MERCHANT_W`

Get A Merchant's Address`clover_get_merchant_address`

Get a merchant's address

`MERCHANT_R`

Get All Devices Provisioned To A Merchant`clover_list_devices`

Get all devices provisioned to a merchant

`MERCHANT_R`

Get All Tenders For A Merchant`clover_list_tenders`

Get all tenders for a merchant

`MERCHANT_R`

Get All Cash Events`clover_list_cash_events`

Get all cash events

`PAYMENTS_R`

Get A List Of Customers`clover_list_customers`

Get a list of customers

`CUSTOMERS_R`

Create A Customer`clover_create_customer`

Create a customer

`CUSTOMERS_W`

Get A Single Customer`clover_get_customer`

Get a single customer

`CUSTOMERS_R`

Update A Customer`clover_update_customer`

Update a customer

`CUSTOMERS_W`

Delete A Customer`clover_delete_customer`

Delete a customer

`CUSTOMERS_W`

Create A Phone Number For A Customer`clover_create_customer_phone`

Create a phone number for a customer

`CUSTOMERS_W`

Create An Email Address For A Customer`clover_create_customer_email`

Create an email address for a customer

`CUSTOMERS_W`

Create An Address For A Customer`clover_create_customer_address`

Create an address for a customer

`CUSTOMERS_W`

Update A Phone Number For A Customer`clover_update_customer_phone`

Update a phone number for a customer

`CUSTOMERS_W`

Update An Email Address For A Customer`clover_update_customer_email`

Update an email address for a customer

`CUSTOMERS_W`

Update An Address For A Customer`clover_update_customer_address`

Update an address for a customer

`CUSTOMERS_W`

Gets A List Of Orders`clover_list_orders`

Gets a list of orders

`ORDERS_R`

Create Custom Orders`clover_create_order`

Create custom orders

`ORDERS_W`

Get A Single Order`clover_get_order`

Get a single order

`ORDERS_R`

Update An Order`clover_update_order`

Update an order

`ORDERS_W`

Delete An Order`clover_delete_order`

Delete an order

`ORDERS_W`

Get All Line Items For An Order`clover_list_order_line_items`

Get all line items for an order

`ORDERS_R`

Create A New Line Item`clover_create_line_item`

Create a new line item

`ORDERS_W`

Update A Line Item`clover_update_line_item`

Update a line item

`ORDERS_W`

Void A Line Item`clover_delete_line_item`

Void a line item

`ORDERS_W`

Create A Discount On An Order`clover_create_order_discount`

Create a discount on an order

`ORDERS_W`

Delete An Order Discount`clover_delete_order_discount`

Delete an order discount

`ORDERS_W`

Get All Payments For An Order`clover_list_order_payments`

Get all payments for an order

`PAYMENTS_R`

Get All Order Types For A Merchant`clover_list_order_types`

Get all order types for a merchant

`ORDERS_R`

Get All Inventory Items`clover_list_inventory_items`

Get all inventory items

`INVENTORY_R`

Create An Inventory Item`clover_create_inventory_item`

Create an inventory item

`INVENTORY_W`

Get A Single Inventory Item`clover_get_inventory_item`

Get a single inventory item

`INVENTORY_R`

Update An Existing Inventory Item`clover_update_inventory_item`

Update an existing inventory item

`INVENTORY_W`

Delete An Inventory Item`clover_delete_inventory_item`

Delete an inventory item

`INVENTORY_W`

Update The Stock Of An Inventory Item`clover_update_inventory_item_stock`

Update the stock of an inventory item

`INVENTORY_W`

Get All Tax Rates`clover_list_tax_rates`

Get all tax rates

`INVENTORY_R`

Create A Tax Rate For A Merchant`clover_create_tax_rate`

Create a tax rate for a merchant

`INVENTORY_W`

Get All Discounts`clover_list_discounts`

Get all discounts

`INVENTORY_R`

Create A Discount`clover_create_discount`

Create a discount

`INVENTORY_W`

Get A Single Tax Rate`clover_get_tax_rate`

Get a single tax rate

`INVENTORY_R`

Get A Single Discount`clover_get_discount`

Get a single discount

`INVENTORY_R`

Get All Modifiers`clover_list_modifiers`

Get all modifiers

`INVENTORY_R`

Get All Tags`clover_list_tags`

Get all tags

`INVENTORY_R`

Get All Categories`clover_list_categories`

Get all categories

`INVENTORY_R`

Create An Item Category`clover_create_category`

Create an item category

`INVENTORY_W`

Get A Category`clover_get_category`

Get a category

`INVENTORY_R`

Update A Category`clover_update_category`

Update a category

`INVENTORY_W`

Delete A Single Item Category`clover_delete_category`

Delete a single item category

`INVENTORY_W`

Get All Employees`clover_list_employees`

Get all employees

`EMPLOYEES_R`

Create An Employee`clover_create_employee`

Create an employee

`EMPLOYEES_W`

Get A Single Employee`clover_get_employee`

Get a single employee

`EMPLOYEES_R`

Update An Employee`clover_update_employee`

Update an employee

`EMPLOYEES_W`

Delete An Employee`clover_delete_employee`

Delete an employee

`EMPLOYEES_W`

Get All Shifts For An Employee`clover_list_employee_shifts`

Get all shifts for an employee

`EMPLOYEES_R`

Create Shift For An Employee`clover_create_employee_shift`

Create shift for an employee

`EMPLOYEES_W`

Update A Single Shift`clover_update_employee_shift`

Update a single shift

`EMPLOYEES_W`

Delete A Single Shift`clover_delete_employee_shift`

Delete a single shift

`EMPLOYEES_W`

Get All Roles For A Merchant`clover_list_roles`

Get all roles for a merchant

`EMPLOYEES_R`

Get All Payments`clover_list_payments`

Get all payments

`PAYMENTS_R`

Get A Single Payment`clover_get_payment`

Get a single payment

`PAYMENTS_R`

Get All Refunds For A Merchant`clover_list_refunds`

Get all refunds for a merchant

`PAYMENTS_R`

Get A Single Refund`clover_get_refund`

Get a single refund

`PAYMENTS_R`


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