> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Clover

The Clover connector lets your AI agent act in each user's Clover account. Each user connects their own Clover access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 120 tools.

**Authentication:** Bearer Token
**Categories:** Accounting & Finance, CRM & Sales
**Tools:** 120: 61 read, 40 write, 19 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CLOVER)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Clover connection

   In **AgentKit > Connections**, create a Clover connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'clover'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Clover:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'clover_attribute_list',
     toolInput: { merchant_id: 'https://example.com/merchant-id' },
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "clover"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Clover:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={"merchant_id":"https://example.com/merchant-id"},
       tool_name="clover_attribute_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Clover credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'clover_attribute_list',
  toolInput: {
    merchant_id: '<merchant_id>',
  },
  connector: 'clover',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="clover_attribute_list",
    tool_input={
        "merchant_id": "<merchant_id>",
    },
    connection_name="clover",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `clover_attribute_list`

List Attributes · Read-only

List item attributes (such as size or color) defined by a merchant.
Returns an elements array of attributes, each with id, name, itemGroup, options.
Use clover_attribute_list to see variant attributes. Use clover_option_list for the values of each attribute.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, name, id, deletedTime, itemGroup.id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_cash_event_list`

List Cash Events · Read-only

List cash drawer events such as cash in, cash out and drawer opens for a merchant.
Returns an elements array of cash events, each with type, amountChange, timestamp, note, employee, device, merchant.
Use clover_cash_event_list to audit cash movements.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, device.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, note, amountChange, employee.name, type, device.id, timestamp.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_category_get`

Get Category · Read-only

Get one category by ID.
Returns the category with id, name, sortOrder, items, colorCode, deleted, modifiedTime, canonical.
Use clover_category_get when the ID is known.
Get the ID from clover_category_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`string`, required): Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.

Example input: `{"category_id":"<category_id>","merchant_id":"<merchant_id>"}`

### `clover_category_item_list`

List Category Items · Read-only

List the inventory items in one category.
Returns an elements array of items, each with id, hidden, available, autoManage, itemGroup, options, name, alternateName.
Use clover_category_item_list for a category's items. Use clover_item_category_list for an item's categories.
Get the category ID from clover_category_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`string`, required): Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: categories, itemStock, modifierRates, options, tags, taxRates.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, sortOrder, name, colorCode, id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"category_id":"<category_id>","merchant_id":"<merchant_id>"}`

### `clover_category_list`

List Categories · Read-only

List the item categories defined by a merchant.
Returns an elements array of categories, each with id, name, sortOrder, items, colorCode, deleted, modifiedTime, canonical.
Use clover_category_list to browse categories. Use clover_category_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, sortOrder, name, colorCode, id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_credit_refund_get`

Get Credit Refund · Read-only

Get a single credit refund by ID.
Returns the credit refund with id, orderRef, device, createdTime, clientCreatedTime, credit, employee, germanInfo.
Use clover_credit_refund_get when the credit refund ID is known.
Get the ID from clover_credit_refund_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `credit_refund_id` (`string`, required): Clover ID of the credit refund (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: credit, germanInfo, appTracking, transactionInfo.

Example input: `{"credit_refund_id":"<credit_refund_id>","merchant_id":"<merchant_id>"}`

### `clover_credit_refund_list`

List Credit Refunds · Read-only

List credit refunds (refunds issued without an original payment) for a merchant.
Returns an elements array of credit refunds, each with id, orderRef, device, tender, employee, customers, amount, taxAmount.
Use clover_credit_refund_list for credits. Use clover_refund_list for refunds against payments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: credit, germanInfo, appTracking, transactionInfo.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_customer_get`

Get Customer · Read-only

Get one customer by ID, optionally expanding contact details and metadata.
Returns the customer with id, merchant, firstName, lastName, marketingAllowed, customerSince, orders, addresses.
Use clover_customer_get when the ID is known. Use clover_customer_list to search.
Get the ID from clover_customer_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, deletedTime.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_list`

List Customers · Read-only

List customers, optionally filtered by name, email or phone and expanded with addresses and contact details.
Returns an elements array of customers, each with id, merchant, firstName, lastName, marketingAllowed, customerSince, orders, addresses.
Use clover_customer_list to search customers. Use clover_customer_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, deletedTime.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_default_service_charge_get`

Get Default Service Charge · Read-only

Get the default service charge configured for a merchant.
Returns the default service charge with id, name, enabled, percentage, percentageDecimal, isAutoApplied.
Use clover_default_service_charge_get before applying a charge with clover_order_service_charge_apply.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_device_get`

Get Device · Read-only

Get one provisioned device by ID.
Returns the device with id, name, model, merchant, orderPrefix, terminalId, terminalPrefix, serial.
Use clover_device_get when the ID is known.
Get the ID from clover_device_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `device_id` (`string`, required): Clover ID of the device (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"device_id":"<device_id>","merchant_id":"<merchant_id>"}`

### `clover_device_list`

List Devices · Read-only

List the Clover devices provisioned to a merchant.
Returns an elements array of devices, each with id, name, model, merchant, orderPrefix, terminalId, terminalPrefix, serial.
Use clover_device_list to see the merchant's hardware. Use clover_device_get for one device.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: serial, name, merchant.id, merchant.name, deviceTypeName, model, id, deleted_time, orderPrefix.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_discount_get`

Get Discount · Read-only

Get one saved discount by ID.
Returns the discount with id, discount, approver, name, amount, percentage.
Use clover_discount_get when the discount ID is known.
Get the ID from clover_discount_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"discount_id":"<discount_id>","merchant_id":"<merchant_id>"}`

### `clover_discount_list`

List Discounts · Read-only

List the discounts saved in a merchant's catalog.
Returns an elements array of discounts, each with id, discount, approver, name, amount, percentage.
Use clover_discount_list for the saved discount catalog. Use clover_order_discount_list for discounts applied to an order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: amount, modifiedtime, percentage, id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_employee_get`

Get Employee · Read-only

Get one employee by ID.
Returns the employee with id, name, nickname, customId, email, inviteSent, claimedTime, deletedTime.
Use clover_employee_get when the ID is known.
Get the ID from clover_employee_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `employee_id` (`string`, required): Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: roles, shifts.

Example input: `{"employee_id":"<employee_id>","merchant_id":"<merchant_id>"}`

### `clover_employee_list`

List Employees · Read-only

List the employees of a merchant.
Returns an elements array of employees, each with id, name, nickname, customId, email, inviteSent, claimedTime, deletedTime.
Use clover_employee_list to find employee IDs. Use clover_employee_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: roles, shifts.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, role, role.id, customId, name, nickname, id, deletedTime, deleted_time, email.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_employee_order_list`

List Employee Orders · Read-only

List orders handled by one employee.
Returns an elements array of orders, each with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState.
Use clover_employee_order_list for one employee's orders. Use clover_order_list for all orders.
Get the employee ID from clover_employee_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `employee_id` (`string`, required): Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"employee_id":"<employee_id>","merchant_id":"<merchant_id>"}`

### `clover_employee_payment_list`

List Employee Payments · Read-only

List payments taken by one employee.
Returns an elements array of payments, each with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount.
Use clover_employee_payment_list for one employee. Use clover_payment_list for all payments.
Get the employee ID from clover_employee_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `employee_id` (`string`, required): Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, employee, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"employee_id":"<employee_id>","merchant_id":"<merchant_id>"}`

### `clover_employee_shift_list`

List Employee Shifts · Read-only

List the shifts worked by one employee.
Returns an elements array of shifts, each with id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime.
Use clover_employee_shift_list for one employee. Use clover_shift_list for all.
Get the employee ID from clover_employee_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `employee_id` (`string`, required): Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, overrideInEmployee, overrideOutEmployee.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, out_time, in_time, employee.name, in_and_override_time, out_and_override_time, id, has_in_time, override_in_time, deletedTime, server_banking.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"employee_id":"<employee_id>","merchant_id":"<merchant_id>"}`

### `clover_item_category_list`

List Item Categories · Read-only

List the categories one inventory item belongs to.
Returns an elements array of categories, each with id, name, sortOrder, items, colorCode, deleted, modifiedTime, canonical.
Use clover_item_category_list for an item's categories. Use clover_category_item_list for a category's items.
Get the item ID from clover_item_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, sortOrder, name, colorCode, id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_item_get`

Get Item · Read-only

Get one inventory item by ID, optionally expanding tags, categories, tax rates and modifier groups.
Returns the item with id, hidden, available, autoManage, itemGroup, options, name, alternateName.
Use clover_item_get when the item ID is known. Use clover_item_list to search.
Get the item ID from clover_item_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_item_group_get`

Get Item Group · Read-only

Get one item group by ID.
Returns the item group with id, name, items, attributes.
Use clover_item_group_get when the group ID is known.
Get the ID from clover_item_group_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_group_id` (`string`, required): Clover ID of the item group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, attributes.

Example input: `{"item_group_id":"<item_group_id>","merchant_id":"<merchant_id>"}`

### `clover_item_group_list`

List Item Groups · Read-only

List item groups (products with variants) for a merchant.
Returns an elements array of item groups, each with id, name, items, attributes.
Use clover_item_group_list to browse groups. Use clover_item_group_get for one group.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, attributes.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, name, id, deletedTime.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_item_list`

List Items · Read-only

List inventory items for a merchant, optionally filtered by name, SKU or price and expanded with categories, tags or modifiers.
Returns an elements array of inventory items, each with elements.
Use clover_item_list to browse or filter the catalog. Use clover_item_get for one item.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: lowStock, modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id, isAgeRestricted, ageRestrictedType.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_item_stock_get`

Get Item Stock · Read-only

Get the stock count for one inventory item.
Returns the item stock with item, stockCount, quantity, stockAlertThreshold, modifiedTime.
Use clover_item_stock_get for one item. Use clover_item_stock_list for all items.
Get the item ID from clover_item_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_item_stock_list`

List Item Stocks · Read-only

List stock counts for all inventory items.
Returns an elements array of item stocks.
Use clover_item_stock_list for all items. Use clover_item_stock_get for one item.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_item_tag_list`

List Item Tags · Read-only

List the tags attached to one inventory item.
Returns an elements array of tags, each with id, name, showInReporting, items, printers.
Use clover_item_tag_list for one item's tags. Use clover_tag_item_list for the items under a tag.
Get the item ID from clover_item_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, printers.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, name, showInReporting, id.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_merchant_address_get`

Get Merchant Address · Read-only

Get a merchant's business address.
Returns the address with address1, address2, address3, city, country, state, zip.
Use clover_merchant_address_get for the address only. Use clover_merchant_get for the full profile.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_merchant_get`

Get Merchant · Read-only

Get a merchant's profile such as name, owner and settings, optionally expanded.
Returns the merchant with id, name, reseller_id, owner, address.
Use clover_merchant_get for the business profile. Use clover_merchant_address_get for the address only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employees, bankProcessing, externalMerchant, merchantBoarding, merchantL3Prerequisite, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication, enterprises.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_merchant_properties_get`

Get Merchant Properties · Read-only

Get a merchant's configuration properties.
Returns the merchant properties with merchantRef, defaultCurrency, tipsEnabled, receiptProperties, summaryHour, signatureThreshold, hasDefaultEmployee, tipRateDefault.
Use clover_merchant_properties_get for settings flags such as tip and receipt options.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_modifier_get`

Get Modifier · Read-only

Get one modifier by ID.
Returns the modifier with id, name, alternateName, available, price, modifierGroup.
Use clover_modifier_get when both IDs are known.
Get IDs from clover_modifier_group_modifier_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `modifier_id` (`string`, required): Clover ID of the modifier (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifierGroup.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>","modifier_id":"<modifier_id>"}`

### `clover_modifier_group_get`

Get Modifier Group · Read-only

Get one modifier group by ID.
Returns the modifier group with id, name, alternateName, minRequired, maxAllowed, showByDefault, modifiers, modifierIds.
Use clover_modifier_group_get when the ID is known.
Get the ID from clover_modifier_group_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifiers, items.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>"}`

### `clover_modifier_group_list`

List Modifier Groups · Read-only

List modifier groups (such as Toppings) defined by a merchant.
Returns an elements array of modifier groups, each with id, name, alternateName, minRequired, maxAllowed, showByDefault, modifiers, modifierIds.
Use clover_modifier_group_list to browse groups. Use clover_modifier_list for the modifiers themselves.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, category.id, negativeSortOrder, item.id, sortOrder, name, id, showByDefault.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_modifier_group_modifier_list`

List Modifiers in Group · Read-only

List the modifiers inside one modifier group.
Returns an elements array of modifiers, each with id, name, alternateName, available, price, modifierGroup.
Use clover_modifier_group_modifier_list for one group. Use clover_modifier_list for all.
Get the group ID from clover_modifier_group_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, price, name, alternateName, id, modifierGroup.id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>"}`

### `clover_modifier_list`

List Modifiers · Read-only

List all modifiers across a merchant's modifier groups.
Returns an elements array of modifiers, each with id, name, alternateName, available, price, modifierGroup.
Use clover_modifier_list for every modifier. Use clover_modifier_group_modifier_list for one group.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, price, name, alternateName, id, modifierGroup.id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_opening_hours_get`

Get Opening Hours · Read-only

Get one set of opening hours by ID.
Returns the opening hours set with id, name, reference, sunday, monday, tuesday, wednesday, thursday.
Use clover_opening_hours_get when the ID is known.
Get the ID from clover_opening_hours_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `opening_hours_id` (`string`, required): Clover ID of the opening hours (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","opening_hours_id":"<opening_hours_id>"}`

### `clover_opening_hours_list`

List Opening Hours · Read-only

List the sets of opening hours defined for a merchant.
Returns an elements array of opening hours sets, each with id, name, reference, sunday, monday, tuesday, wednesday, thursday.
Use clover_opening_hours_list to see all schedules. Use clover_opening_hours_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_option_list`

List Options · Read-only

List attribute options (such as Small or Red) defined by a merchant.
Returns an elements array of options, each with id, name, attribute, items.
Use clover_option_list for attribute values. Use clover_attribute_list for the attributes themselves.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: options.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, item.id, name, attribute.id, id, deletedTime.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_order_discount_list`

List Order Discounts · Read-only

List the discounts applied to an order.
Returns an elements array of order discounts, each with id, discount, approver, name, amount, percentage.
Use clover_order_discount_list for discounts on the whole order. Use clover_discount_list for the merchant's discount catalog.
Get the order ID from clover_order_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_get`

Get Order · Read-only

Get a single order by ID, optionally expanding line items, payments, discounts and customers.
Returns the order with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState.
Use clover_order_get when the order ID is known. Use clover_order_list to search.
Get the order ID from clover_order_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_get`

Get Order Line Item · Read-only

Get a single line item on an order.
Returns the line item with id, item, colorCode, name, alternateName, price, priceWithModifiers, priceWithModifiersAndItemAndOrderDiscounts.
Use clover_order_line_item_get for one known line item. Use clover_order_line_item_list for all of them.
Get IDs from clover_order_line_item_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, orderType, discounts, modifications, taxRates, payments.

Example input: `{"line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_list`

List Order Line Items · Read-only

List the line items on an order.
Returns an elements array of line items, each with id, item, colorCode, name, alternateName, price, priceWithModifiers, priceWithModifiersAndItemAndOrderDiscounts.
Use clover_order_line_item_list to see everything on an order. Use clover_order_line_item_get for one line item.
Get the order ID from clover_order_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, orderType, discounts, modifications, taxRates, payments.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_list`

List Orders · Read-only

List orders for a merchant, optionally filtered by time, state or amount and expanded with related records.
Returns an elements array of orders, each with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState.
Use clover_order_list to browse or filter orders. Use clover_order_get for one known order and clover_employee_order_list for one employee's orders.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, payments, refunds, credits, voids, payment.tender, payment.cardTransaction, lineItems, customers, serviceCharge, discounts, orderType, lineItems.discounts, lineItems.modifications.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, note, modifiedTime, orderType, touched, cardTransaction.last4, manualTransaction, employee.name, title, device.id, externalReferenceId, clientCreatedTime, total, payType, testMode, createdTime, id, state, deletedTime.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_order_payment_list`

List Order Payments · Read-only

List the payments recorded on one order.
Returns an elements array of payments, each with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount.
Use clover_order_payment_list for one order. Use clover_payment_list for all payments.
Get the order ID from clover_order_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, employee, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_type_get`

Get Order Type · Read-only

Get one order type by ID.
Returns the order type with id, labelKey, label, taxable, isDefault, filterCategories, isHidden, fee.
Use clover_order_type_get when the ID is known.
Get the ID from clover_order_type_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_type_id` (`string`, required): Clover ID of the order type (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: hours, attributes, categories.

Example input: `{"merchant_id":"<merchant_id>","order_type_id":"<order_type_id>"}`

### `clover_order_type_list`

List Order Types · Read-only

List a merchant's order types such as dine in or take out.
Returns an elements array of order types, each with id, labelKey, label, taxable, isDefault, filterCategories, isHidden, fee.
Use clover_order_type_list to find order type IDs for clover_order_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: hours, attributes, categories.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: id, deletedTime.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_payment_get`

Get Payment · Read-only

Get a single payment by ID.
Returns the payment with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount.
Use clover_payment_get when the payment ID is known. Use clover_payment_list to search.
Get the payment ID from clover_payment_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `payment_id` (`string`, required): Clover ID of the payment (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, employee, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.

Example input: `{"merchant_id":"<merchant_id>","payment_id":"<payment_id>"}`

### `clover_payment_list`

List Payments · Read-only

List payments for a merchant, optionally filtered by time, amount or result.
Returns an elements array of payments, each with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount.
Use clover_payment_list for merchant-wide payments. Use clover_order_payment_list for one order and clover_payment_get for one payment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_refund_get`

Get Refund · Read-only

Get a single refund by ID.
Returns the refund with id, orderRef, device, amount, taxAmount, tipAmount, createdTime, clientCreatedTime.
Use clover_refund_get when the refund ID is known.
Get the refund ID from clover_refund_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `refund_id` (`string`, required): Clover ID of the refund (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems, transactionInfo, oceanGatewayInfo.

Example input: `{"merchant_id":"<merchant_id>","refund_id":"<refund_id>"}`

### `clover_refund_list`

List Refunds · Read-only

List refunds issued by a merchant.
Returns an elements array of refunds, each with id, orderRef, device, amount, taxAmount, tipAmount, createdTime, clientCreatedTime.
Use clover_refund_list for refunds against payments. Use clover_credit_refund_list for credits issued without a payment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems, transactionInfo, oceanGatewayInfo.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: API filtering documentation.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_shift_get`

Get Shift · Read-only

Get one shift by ID.
Returns the shift with id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime.
Use clover_shift_get when the ID is known.
Get the ID from clover_shift_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `shift_id` (`string`, required): Clover ID of the shift (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, overrideInEmployee, overrideOutEmployee.

Example input: `{"merchant_id":"<merchant_id>","shift_id":"<shift_id>"}`

### `clover_shift_list`

List Shifts · Read-only

List employee shifts across a merchant.
Returns an elements array of shifts, each with id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime.
Use clover_shift_list for every employee. Use clover_employee_shift_list for one employee.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, overrideInEmployee, overrideOutEmployee.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, out_time, in_time, employee.name, in_and_override_time, out_and_override_time, id, has_in_time, override_in_time, deletedTime, server_banking.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_tag_get`

Get Tag · Read-only

Get one tag by ID.
Returns the tag with id, name, showInReporting, items, printers.
Use clover_tag_get when the ID is known.
Get the ID from clover_tag_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tag_id` (`string`, required): Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, printers.

Example input: `{"merchant_id":"<merchant_id>","tag_id":"<tag_id>"}`

### `clover_tag_item_list`

List Tag Items · Read-only

List the inventory items carrying one tag.
Returns an elements array of items, each with id, hidden, available, autoManage, itemGroup, options, name, alternateName.
Use clover_tag_item_list for the items under a tag. Use clover_item_tag_list for the tags on an item.
Get the tag ID from clover_tag_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tag_id` (`string`, required): Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, printers.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, hidden, itemCode, available, option.id, alternateName, isRevenue, modifierGroup.id, autoManage, deleted, item.id, price, name, itemStock.quantity, id, sku, defaultTaxRates, itemGroup.id.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>","tag_id":"<tag_id>"}`

### `clover_tag_list`

List Tags · Read-only

List the tags defined by a merchant.
Returns an elements array of tags, each with id, name, showInReporting, items, printers.
Use clover_tag_list to browse tags. Use clover_tag_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, printers.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, name, showInReporting, id.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_tax_rate_get`

Get Tax Rate · Read-only

Get one tax rate by ID.
Returns the tax rate with id, name, taxType, rate, isDefault, items, taxAmount, deletedTime.
Use clover_tax_rate_get when the ID is known.
Get the ID from clover_tax_rate_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tax_rate_id` (`string`, required): Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.

Example input: `{"merchant_id":"<merchant_id>","tax_rate_id":"<tax_rate_id>"}`

### `clover_tax_rate_item_list`

List Items by Tax Rate · Read-only

List the inventory items that use one tax rate.
Returns an elements array of items, each with id, hidden, available, autoManage, itemGroup, options, name, alternateName.
Use clover_tax_rate_item_list to see items under a tax rate. Use clover_tax_rate_item_associate to change the links.
Get the tax rate ID from clover_tax_rate_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tax_rate_id` (`string`, required): Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id.
- `limit` (`integer`, optional): Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
- `offset` (`integer`, optional): Number of records to skip, for paging through large result sets together with limit.

Example input: `{"merchant_id":"<merchant_id>","tax_rate_id":"<tax_rate_id>"}`

### `clover_tax_rate_list`

List Tax Rates · Read-only

List the tax rates configured for a merchant.
Returns an elements array of tax rates, each with id, name, taxType, rate, isDefault, items, taxAmount, deletedTime.
Use clover_tax_rate_list to browse tax rates. Use clover_tax_rate_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: isDefault, rate, items.id, name, id, taxAmount, taxType.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_tender_get`

Get Tender · Read-only

Get one tender by ID.
Returns the tender with id, editable, labelKey, label, opensCashDrawer, supportsTipping, enabled, visible.
Use clover_tender_get when the ID is known.
Get the ID from clover_tender_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tender_id` (`string`, required): Clover ID of the tender (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","tender_id":"<tender_id>"}`

### `clover_tender_list`

List Tenders · Read-only

List the tenders (payment methods such as cash or card) a merchant accepts.
Returns an elements array of tenders, each with id, editable, labelKey, label, opensCashDrawer, supportsTipping, enabled, visible.
Use clover_tender_list to find tender IDs for clover_order_payment_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, visible, merchantId, instruction, systemTenderId, label, id, labelKey, opensCashDrawer, deletedTime, enabled.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_tip_suggestion_list`

List Tip Suggestions · Read-only

List the tip suggestions configured for a merchant.
Returns an elements array of tip suggestions, each with id, name, percentage, amount, isEnabled, flatTip.
Use clover_tip_suggestion_list to see the tip presets shown at checkout.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `filter` (`string`, optional): Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: flatTip, percentage, name, id, enabled.
- `limit` (`integer`, optional): Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
- `offset` (`integer`, optional): Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_atomic_order_checkout`

Get Atomic Order Checkout · Write

Calculate the totals and taxes for an order cart without creating the order.
Returns the calculated order totals with orderCart, total, subtotal, totalTaxAmount, taxSummaries, isVat.
Use clover_atomic_order_checkout to preview totals before creating an order. Use clover_atomic_order_create to actually create the order.
Get inventory item IDs from clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_cart` (`object`, optional): Order cart to put items, discounts, modifications and order-related information. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_atomic_order_create`

Create Atomic Order · Write

Create an order with line items from Clover inventory in a single call, with totals and taxes calculated by Clover.
Returns the order with calculated totals with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState.
Use clover_atomic_order_create for inventory-based orders. Use clover_order_create for custom orders without line items.
Get inventory item IDs from clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_cart` (`object`, optional): Order cart to put items, discounts, modifications and order-related information. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_category_create`

Create Category · Write

Create an item category with a name and optional sort order or color.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_category_create to add a category.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): The name of the category which will appear in Clover Register App.
- `color_code` (`string`, optional): Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `items` (`array`, optional): Ordered list of items associated with this category. Provide a JSON array of objects.
- `sort_order` (`integer`, optional): Integer used to determine how this category is sorted against other categories.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_category_item_associate`

Associate Items with Categories · Write

Create or delete links between inventory items and categories in one call.
Returns the association results with item, category.
Use clover_category_item_associate to move items in or out of categories.
Get IDs from clover_category_list and clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `elements` (`array`, required): Array of category-item associations. Example: [{"category": {"id": "{categoryId}"}, "item": {"id": "{item1Id}"}}, {"category": {"id": "{categoryId}"}, "item": {"id": "{item2Id}"}}].
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `delete` (`boolean`, optional): Use to view, create, or remove an association between items and categories in the request body. Values: True - Set to true to remove the association. False - Set to false to create an association.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.

Example input: `{"elements":[{"category":{"id":"{categoryId}"},"item":{"id":"{item1Id}"}},{"category":{"id":"{categoryId}"},"item":{"id":"{item2Id}"}}],"merchant_id":"<merchant_id>"}`

### `clover_category_update`

Update Category · Write

Update the name, sort order or color of a category.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_category_update to change a category.
Get the ID from clover_category_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`string`, required): Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): The name of the category which will appear in Clover Register App.
- `color_code` (`string`, optional): Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `items` (`array`, optional): Ordered list of items associated with this category. Provide a JSON array of objects.
- `sort_order` (`integer`, optional): Integer used to determine how this category is sorted against other categories.

Example input: `{"category_id":"<category_id>","merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_customer_address_create`

Create Customer Address · Write

Add a postal address to a customer.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_address_create to add an address.
Get the customer ID from clover_customer_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `address1` (`string`, optional): Customer's address, line one.
- `address2` (`string`, optional): Customer's address, line two.
- `address3` (`string`, optional): Customer's address, line three.
- `city` (`string`, optional): Customer's city.
- `country` (`string`, optional): Customer's country.
- `state` (`string`, optional): Customer's state.
- `zip` (`string`, optional): Postal code of the customer's address.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_create`

Create Customer · Write

Create a customer record with a name and optional contact details.
Returns the new customer with id, firstName, lastName, marketingAllowed, customerSince, metadata.
Use clover_customer_create to add a customer. Use the phone, email and address tools to add details later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `addresses` (`array`, optional): Customer's mailing and shipping address. This information is displayed on invoices emailed to the customer. Note: Address must contain a value Length: Maximum 127 characters. Provide a JSON array of objects.
- `customer_since` (`integer`, optional): Date since when the customer is associated with the merchant.
- `email_addresses` (`array`, optional): Customer's email address. Provide a JSON array of objects.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
- `first_name` (`string`, optional): First name of the customer. Length: Maximum 64 characters.
- `last_name` (`string`, optional): Last name of the customer. Length: Maximum 64 characters.
- `marketing_allowed` (`boolean`, optional): Indicates whether the customer allows marketing communication from Clover. Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.
- `phone_numbers` (`array`, optional): Customer phone numbers. Provide a JSON array of objects.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_customer_email_address_create`

Create Customer Email Address · Write

Add an email address to a customer.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_email_address_create to add an email.
Get the customer ID from clover_customer_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `email_address` (`string`, required): Email address of the customer. Note: A valid email address is required. Email address domains are validated using the Apache Domain Validator. Customer email addresses are validated using the Apache Email Validator.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `primary_email` (`boolean`, optional): Customer's primary email address.

Example input: `{"customer_id":"<customer_id>","email_address":"<email_address>","merchant_id":"<merchant_id>"}`

### `clover_customer_metadata_save`

Save Customer Metadata · Write

Create or update a customer's business name, note and birthday.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_metadata_save for notes and birthday. Use clover_customer_update for name and marketing preference.
Get the customer ID from clover_customer_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `business_name` (`string`, optional): Name of customer's business. Note: Length of the business name cannot be more than 127 characters.
- `dob_day` (`integer`, optional): Day of the customer’s date of birth.
- `dob_month` (`integer`, optional): Month of the customer’s date of birth.
- `dob_year` (`integer`, optional): Optional. Year of the customer’s date of birth.
- `note` (`string`, optional): Additional information about the customer. Note: Length of the note cannot be more than 2000 characters.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_phone_number_create`

Create Customer Phone Number · Write

Add a phone number to a customer.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_phone_number_create to add a number.
Get the customer ID from clover_customer_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `phone_number` (`string`, required): Customer's phone number.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>","phone_number":"<phone_number>"}`

### `clover_customer_update`

Update Customer · Write

Update a customer's name or marketing preference.
Returns the updated customer with id, firstName, lastName, marketingAllowed, customerSince, metadata.
Use clover_customer_update to change core customer fields. Use clover_customer_metadata_save for notes and birthday.
Get the ID from clover_customer_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `addresses` (`array`, optional): Customer's mailing and shipping address. This information is displayed on invoices emailed to the customer. Note: Address must contain a value. Length: Maximum 127 characters. Provide a JSON array of objects.
- `customer_since` (`integer`, optional): Date since when the customer is associated with the merchant.
- `email_addresses` (`array`, optional): Customer's email address. Provide a JSON array of objects.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
- `first_name` (`string`, optional): First name of the customer. Length: Maximum 64 characters.
- `last_name` (`string`, optional): Last name of the customer. Length: Maximum 64 characters.
- `marketing_allowed` (`boolean`, optional): Indicates whether the customer allows marketing communication from Clover. Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.
- `phone_numbers` (`array`, optional): Customer phone numbers. Provide a JSON array of objects.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>"}`

### `clover_discount_create`

Create Discount · Write

Create a saved discount with a name and either a fixed amount or a percentage.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_discount_create to add to the discount catalog.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the discount.
- `amount` (`integer`, optional): Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
- `approver` (`object`, optional): The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `percentage` (`integer`, optional): Discount amount in percent.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_discount_update`

Update Discount · Write

Update the name, amount or percentage of a saved discount.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_discount_update to change a catalog discount.
Get the ID from clover_discount_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the discount.
- `amount` (`integer`, optional): Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
- `approver` (`object`, optional): The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `percentage` (`integer`, optional): Discount amount in percent.

Example input: `{"discount_id":"<discount_id>","merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_item_bulk_create`

Bulk Create Items · Write

Create several inventory items in one call.
Returns the created items with items.
Use clover_item_bulk_create for many items. Use clover_item_create for one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `items` (`array`, required): Array of inventory items. Provide a JSON array of objects.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"items":[],"merchant_id":"<merchant_id>"}`

### `clover_item_create`

Create Item · Write

Create an inventory item with a name, price and optional SKU, code or tax settings.
Returns the new item with id, name, price, priceType, hidden, available, modifiedTime, isAgeRestricted.
Use clover_item_create for one item. Use clover_item_bulk_create for many.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Item name.
- `price` (`integer`, required): Price of the item based on the merchant's local currency and price type, such as fixed, variable, or per unit price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents.
- `alternate_name` (`string`, optional): Alternate name of the item.
- `auto_manage` (`boolean`, optional): Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False - Item availability is manually managed.
- `available` (`boolean`, optional): Indicates whether the inventory item is available for sale across all channels, including point of sale (POS) devices, customer-facing kiosks, and online ordering websites.
- `code` (`string`, optional): Item product code, such as Universal Product Code (UPC) or European Article Number (EAN).
- `color_code` (`string`, optional): Hex code of the color assigned to the category and its items. Format: #fff, #ffffff, or #ffffffff.
- `cost` (`integer`, optional): Cost of the item to a merchant as compared to the price payable by the customer, for example: wholesale versus retail price.
- `default_tax_rates` (`boolean`, optional): Indicates whether or not to use the default tax rate.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted.
- `hidden` (`boolean`, optional): Indicates whether the inventory item is hidden on the Register app.
- `is_age_restricted` (`boolean`, optional): Set to true to create an age-restricted item. If true, ageRestrictedObj must also be provided.
- `is_revenue` (`boolean`, optional): Indicates whether this item is counted as revenue, for example: gift cards and donations are not counted as revenue.
- `price_type` (`string`, optional): Price type, such as fixed, variable, or per unit price. One of: `FIXED`, `VARIABLE`, `PER_UNIT`.
- `price_without_vat` (`integer`, optional): Item price without value-added tax (VAT). For non-VAT merchants, this field is not used. For VAT merchants, this field is the base price of an item.
- `sku` (`string`, optional): Stock keeping unit (SKU).
- `stock_count` (`integer`, optional): Deprecated. Use itemStock.
- `unit_name` (`string`, optional): Unit of measurement for the item, such as pound or meter.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>","price":1}`

### `clover_item_group_create`

Create Item Group · Write

Create an item group used to organize variants of one product.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_item_group_create to start a variant group.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the option.
- `attributes` (`array`, optional): Attributes that belong to this group. Provide a JSON array of objects.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, attributes.
- `items` (`array`, optional): Items that are members of this group. Provide a JSON array of objects.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_item_group_update`

Update Item Group · Write

Update the name of an item group.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_item_group_update to rename a group.
Get the ID from clover_item_group_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_group_id` (`string`, required): Clover ID of the item group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the option.
- `attributes` (`array`, optional): Attributes that belong to this group. Provide a JSON array of objects.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, attributes.
- `items` (`array`, optional): Items that are members of this group. Provide a JSON array of objects.

Example input: `{"item_group_id":"<item_group_id>","merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_item_modifier_group_associate`

Associate Items with Modifier Groups · Write

Create or delete links between inventory items and modifier groups in one call.
Returns the association results with item, modifierGroups.
Use clover_item_modifier_group_associate to attach or detach modifier groups on items.
Get IDs from clover_modifier_group_list and clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `item` (`object`, required): The item value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group` (`object`, required): The modifier group value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `delete` (`boolean`, optional): Use to view, create, or delete an association between inventory items and modifier groups in the request body. Values: True - Set to true to delete the association. False - Set to false to create an association.

Example input: `{"item":{},"merchant_id":"<merchant_id>","modifier_group":{}}`

### `clover_item_stock_create`

Create Item Stock · Write

Start tracking stock for an inventory item with an initial quantity and alert threshold.
Returns the item stock with item, stockCount, quantity, stockAlertThreshold, modifiedTime.
Use clover_item_stock_create to begin tracking. Use clover_item_stock_update to change an existing count.
Get the item ID from clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `quantity` (`number`, required): Initial count of this item in stock.
- `stock_alert_threshold` (`number`, optional): The quantity threshold at which a low stock alert is triggered.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>","quantity":1}`

### `clover_item_stock_update`

Update Item Stock · Write

Set the stock quantity and alert threshold for an item that already has stock tracking.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_item_stock_update if stock already exists. Use clover_item_stock_create to start tracking stock.
Get the item ID from clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `quantity` (`number`, optional): Current count of this item in stock.
- `stock_alert_threshold` (`number`, optional): The quantity threshold at which a low stock alert is triggered. Only appears if the Low Stock Alert feature is enabled.
- `stock_count` (`integer`, optional): Deprecated, use quantity instead.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_item_update`

Update Item · Write

Update fields on an inventory item such as name, price, SKU or availability.
Returns the updated item with id, hidden, available, autoManage, itemGroup, options, name, alternateName.
Use clover_item_update to change an item. Use clover_item_stock_update to change stock counts.
Get the item ID from clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `alternate_name` (`string`, optional): Alternate name of the item.
- `auto_manage` (`boolean`, optional): Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False - Item availability is manually managed.
- `available` (`boolean`, optional): Indicates whether the inventory item is available for sale across all channels.
- `code` (`string`, optional): Item product code, such as Universal Product Code (UPC) or European Article Number (EAN).
- `color_code` (`string`, optional): Hex code of the color assigned to the category and its items. Format: #fff, #ffffff, or #ffffffff.
- `cost` (`integer`, optional): Cost of the item to a merchant as compared to the price payable by the customer, for example: wholesale versus retail price.
- `default_tax_rates` (`boolean`, optional): Indicates whether or not to use the default tax rate.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted.
- `hidden` (`boolean`, optional): Indicates whether the inventory item is hidden on the Register app.
- `is_age_restricted` (`boolean`, optional): Set to true to make the item age-restricted, or false to remove the restriction. If setting to true, ageRestrictedObj must also be provided.
- `is_revenue` (`boolean`, optional): Indicates whether this item is counted as revenue, for example: gift cards and donations are not counted as revenue.
- `name` (`string`, optional): Item name.
- `price` (`integer`, optional): Price of the item. Use price type and merchant currency to determine the actual item price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents.
- `price_type` (`string`, optional): Price type, such as fixed, variable, or per unit price. One of: `FIXED`, `VARIABLE`, `PER_UNIT`.
- `price_without_vat` (`integer`, optional): Item price without value-added tax (VAT). For non-VAT merchants, this field is not used. For VAT merchants, this field is the base price of an item.
- `sku` (`string`, optional): Stock keeping unit (SKU).
- `unit_name` (`string`, optional): Unit of measurement for the item, such as pound or meter.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_modifier_create`

Create Modifier · Write

Create a modifier inside a modifier group with a name and price.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_modifier_create to add an option to a group.
Get the group ID from clover_modifier_group_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `alternate_name` (`string`, optional): Alternate name of the modifier.
- `available` (`boolean`, optional): Indicates whether the modifier is available for sale across all channels, including point of sale (POS) devices, customer-facing kiosks, and online ordering websites.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
- `name` (`string`, optional): Name of the modifier.
- `price` (`integer`, optional): Additional cost when used.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>"}`

### `clover_modifier_group_create`

Create Modifier Group · Write

Create a modifier group with a name and minimum and maximum selections.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_modifier_group_create to add a group, then add modifiers with clover_modifier_create.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the modifier group.
- `alternate_name` (`string`, optional): Alternate name of the modifier group.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
- `max_allowed` (`integer`, optional): Maximum number modifiers from this group that can be applied to associated lineItems when using the Register merchant plan.
- `min_required` (`integer`, optional): Minimum number of modifiers from this group that must be applied to associated lineItems when using the Register merchant plan.
- `modifiers` (`array`, optional): The modifiers value. Provide a JSON array of objects.
- `show_by_default` (`boolean`, optional): Indicates whether employees receive an automatic message to add modifiers from this group when using the Register merchant plan.
- `sort_order` (`integer`, optional): Sorted list (ascending or descending) that indicates the ranking of the modifier group as compared to other modifier groups.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_modifier_group_update`

Update Modifier Group · Write

Update the name or selection limits of a modifier group.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_modifier_group_update to change a group.
Get the ID from clover_modifier_group_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `alternate_name` (`string`, optional): The alternate name value.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
- `max_allowed` (`integer`, optional): The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register.
- `min_required` (`integer`, optional): The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register.
- `modifiers` (`array`, optional): The modifiers value. Provide a JSON array of objects.
- `name` (`string`, optional): Name of the modifier group.
- `show_by_default` (`boolean`, optional): Whether employees will be automatically prompted to add modifiers from this category when using Register.
- `sort_order` (`integer`, optional): The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>"}`

### `clover_modifier_update`

Update Modifier · Write

Update the name, price or availability of a modifier.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_modifier_update to change a modifier.
Get IDs from clover_modifier_group_modifier_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `modifier_id` (`string`, required): Clover ID of the modifier (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `alternate_name` (`string`, optional): Alternate name of the modifier.
- `available` (`boolean`, optional): True if this modifier is available across all channels.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
- `name` (`string`, optional): Name of the modifier.
- `price` (`integer`, optional): Additional cost when used.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>","modifier_id":"<modifier_id>"}`

### `clover_order_create`

Create Order · Write

Create an empty custom order (no line items) for a merchant.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_create for orders built from non-Clover inventory, then add items with clover_order_line_item_create. Use clover_atomic_order_create to create an order with Clover inventory items in one call.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `client_created_time` (`integer`, optional): Time when the client created the order.
- `customers` (`array`, optional): List of customers associated with this order. Provide a JSON array of objects.
- `employee` (`object`, optional): Employee who took this order. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `external_reference_id` (`string`, optional): External reference identifier, if associated with the order.
- `group_line_items` (`boolean`, optional): Indicates whether similar line items are grouped together on the order receipt based on matching values for properties, such as price, modifiers, and discounts.
- `manual_transaction` (`boolean`, optional): Indicates a manual transaction for the order. In a manual transaction: An arbitrary amount is defined and not associated with any inventory items. For example, the Clover Sale app and Clover Manual Transaction app create manual transactions. A single line item is associated to hold the sale amount, but the generated receipt displays this differently to indicate the order is not a typical order with inventory items.
- `note` (`string`, optional): Information about the order that may be printed on the order receipt and displayed in apps.
- `order_type` (`object`, optional): The order type value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `pay_type` (`string`, optional): During the payment flow: If the user chooses to split the payment for the order, this field is set to one of the Split values to indicate how to split the full amount. If the user chooses to pay for the order in full with one payment, then this field value is Full. One of: `SPLIT_GUEST`, `SPLIT_ITEM`, `SPLIT_CUSTOM`, `FULL`.
- `state` (`string`, optional): Order state, for example open or locked. When creating an order through the REST API, Clover recommends setting it to open.
- `tax_removed` (`boolean`, optional): Indicates whether tax is removed and is not applicable to the order.
- `test_mode` (`boolean`, optional): Indicates whether this order was created in test mode. Payments made against test orders are not processed. You can delete test mode orders from the Orders App on the merchant's device or web dashboard. Test mode orders are also deleted when the device sends a POST to the /v2/merchant/{mId}/orders/delete_all_tests endpoint.
- `title` (`string`, optional): Title of the order, shown on receipts and in apps.

Example input: `{"merchant_id":"<merchant_id>"}`

### `clover_order_discount_create`

Create Order Discount · Write

Apply a discount to an entire order, either by amount or percentage or from a saved discount.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_discount_create for order-level discounts. Use clover_order_line_item_discount_create for a single line item.
Get the order ID from clover_order_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the discount.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `amount` (`integer`, optional): Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
- `approver` (`object`, optional): The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `discount` (`object`, optional): If this item is based on a standard discount, this will point to the appropriate inventory.Discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `percentage` (`integer`, optional): Discount amount in percent.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>","order_id":"<order_id>"}`

### `clover_order_line_item_create`

Create Order Line Item · Write

Add a line item to an order, either from a Clover inventory item or as a custom named item with a price.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_create to add one item. Use clover_order_line_items_bulk_create to add many at once.
Get the order ID from clover_order_list and any item ID from clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `alternate_name` (`string`, optional): Alternate name of the line item.
- `bin_name` (`string`, optional): The bin name value.
- `is_revenue` (`boolean`, optional): True if this item should be counted as revenue, for example gift cards and donations would not.
- `item` (`object`, optional): A reference to the inventory item that was used to create this line item. Note that since this a reference the item can be changed and deleted any time such that it no longer matches this line item. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `modifications` (`array`, optional): List of references to modifications applied to this line item. Provide a JSON array of objects.
- `name` (`string`, optional): Line item name.
- `note` (`string`, optional): The note value.
- `price` (`integer`, optional): Price of the item, typically in cents of merchant currency. When unit quantity is not null then this is the price for a single unit and is not the complete price.
- `printed` (`boolean`, optional): True if this line item has been printed out on an order printer at least once already.
- `tax_rates` (`array`, optional): Tax rates that apply to this line item. Provide a JSON array of objects.
- `unit_name` (`string`, optional): Unit name (e.g. oz, lb, etc) if priced by unit, otherwise null.
- `unit_qty` (`integer`, optional): This is applicable only if the item is priced by quantity of a unit. The item must have a priceType of PER_UNIT. The value is a fixed-point integer with scaling factor of 1000 (e.g. if charging per ounce, the value should be set to 2500 for 2.5 ounces). To compute the complete price perform the following calculation: PRICE * (UNIT QTY / 1000). If the item doesn’t have a priceType of PER_UNIT, then unitQty is ignored.
- `user_data` (`string`, optional): The user data value.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_discount_create`

Create Line Item Discount · Write

Apply a discount to one line item on an order.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_discount_create for item-level discounts. Use clover_order_discount_create for the whole order.
Get IDs from clover_order_line_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Name of the discount.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `amount` (`integer`, optional): Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
- `approver` (`object`, optional): The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `discount` (`object`, optional): If this item is based on a standard discount, this will point to the appropriate inventory.Discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `percentage` (`integer`, optional): Discount amount in percent.

Example input: `{"line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","name":"<name>","order_id":"<order_id>"}`

### `clover_order_line_item_modification_create`

Apply Line Item Modification · Write

Apply a modifier (for example extra cheese) to a line item.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_modification_create to attach a modifier to a line item.
Get modifier IDs from clover_modifier_list and line item IDs from clover_order_line_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `alternate_name` (`string`, optional): The alternate name value.
- `amount` (`integer`, optional): the additional cost of the modifier when it was applied.
- `modifier` (`object`, optional): The modifier object. Values from the Modifier are copied to the Modification at the time that the order is placed. Modifier values may change after the modification is created. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `name` (`string`, optional): the name of the modifier when it was applied.
- `quantity_sold` (`integer`, optional): This is only used in reports. The count of how many of these modifiers that were sold.

Example input: `{"line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_update`

Update Order Line Item · Write

Update the note, printed flag, bin name or user data on an order line item.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_update to annotate a line item. Use clover_order_line_item_delete to void it.
Get IDs from clover_order_line_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `bin_name` (`string`, optional): Bank identification number.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: employee, orderType, discounts, modifications, taxRates, payments.
- `note` (`string`, optional): Information related to the line item.
- `printed` (`boolean`, optional): Indicates whether the line item has been printed at least once on the order printer.
- `user_data` (`string`, optional): User information.

Example input: `{"line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_items_bulk_create`

Bulk Create Order Line Items · Write

Add several line items to an order in one call.
Returns the created line items with items.
Use clover_order_line_items_bulk_create to add many items. Use clover_order_line_item_create for a single one.
Get the order ID from clover_order_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `items` (`array`, required): Array of line items. Provide a JSON array of objects.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"items":[],"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_payment_create`

Create Order Payment · Write

Record a payment (for example cash or an external tender) against an order.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_payment_create to record a payment on an order. It does not charge a card.
Get the order ID from clover_order_list and the tender ID from clover_tender_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `amount` (`integer`, optional): Total amount paid.
- `cash_tendered` (`integer`, optional): Payment amount given by the customer.
- `cashback_amount` (`integer`, optional): Cash amount given by the customer to the merchant.
- `client_created_time` (`integer`, optional): Time when payment was recorded on the client server.
- `device` (`object`, optional): Device that processed the transaction for this payment, a 128-bit Universal unique identifier. Note: its not the 13-digits Clover identifier.
- `employee` (`object`, optional): Employee who processed the payment. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `external_payment_id` (`string`, optional): External payment identifier.
- `external_reference_id` (`string`, optional): External reference identifier (ID) if associated with the payment.
- `offline` (`boolean`, optional): Indicates if the tender option is offline.
- `tax_amount` (`integer`, optional): Tax amount paid.
- `tender` (`object`, optional): Tender type associated with this payment. For example: credit card, cash, and so on. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `tip_amount` (`integer`, optional): Tip amount paid.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_service_charge_apply`

Apply Order Service Charge · Write

Apply a service charge to an order.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_service_charge_apply to add a service charge. Use clover_order_service_charge_remove to take it off.
Get the order ID from clover_order_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `enabled` (`boolean`, optional): Indicates if this service charge is enabled.
- `is_auto_applied` (`boolean`, optional): Indicates service charge was auto applied or not.
- `name` (`string`, optional): Service charge name.
- `percentage` (`integer`, optional): Deprecated use percentage decimal instead.
- `percentage_decimal` (`integer`, optional): Percent to charge times 10000, for example, 12.5% will be 125000.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_update`

Update Order · Write

Update fields on an existing order such as title, note, state or order type.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_update to change an order's own fields. Use clover_order_line_item_update to change a line item.
Get the order ID from clover_order_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `client_created_time` (`integer`, optional): Time at which the client created this order.
- `currency` (`string`, optional): Three-letter ISO 4217 currency code. Format: Lower case Length: Maximum 3.
- `customers` (`array`, optional): List of customers associated with this order. Provide a JSON array of objects.
- `employee` (`object`, optional): The employee who took this order. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
- `external_reference_id` (`string`, optional): External reference id if present in the order.
- `group_line_items` (`boolean`, optional): Whether similar line items should be grouped together on the receipt that this order generates. Item "similarity" is based on items having matching values for a set of properties including price, modifiers, and discounts.
- `manual_transaction` (`boolean`, optional): Whether this order represents a manual transaction. A manual transaction is a transaction that has an arbitrary amount defined and is not associated with any inventory items. For example, the Clover Sale App and Clover Manual Transaction App create manual transactions. A manual transactions will have a single associated line item to hold the sale amount, but the generated receipt will display this differently to.
- `note` (`string`, optional): An arbitrary string with information about this order, may be printed on the order receipt and displayed in apps.
- `order_type` (`object`, optional): The order type value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
- `pay_type` (`string`, optional): Possible values: SPLIT_GUEST, SPLIT_ITEM, SPLIT_CUSTOM, FULL. During the payment flow, if the user chooses to split the payment for this order, this field will be set to one of the SPLIT_* values to indicate how the full amount should be split. If the user chooses to pay for the order in full with one payment, then this field will be FULL. One of: `SPLIT_GUEST`, `SPLIT_ITEM`, `SPLIT_CUSTOM`, `FULL`.
- `state` (`string`, optional): Order state, for example open or locked. When creating an order through the REST API, Clover recommends setting it to open.
- `tax_removed` (`boolean`, optional): If true then this order should not have taxes applied to it.
- `test_mode` (`boolean`, optional): Whether this order was created in test mode. Payments made against test orders are not processed. Test mode orders can be deleted from the Orders App on the merchant's device or web dashboard (https://www.clover.com/orders/m/{mId}/orders). They will also be deleted when the device sends a POST to the /v2/merchant/{mId}/orders/delete_all_tests endpoint.
- `title` (`string`, optional): Title of the order, shown on receipts and in apps.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_tag_create`

Create Tag · Write

Create a tag used to label inventory items.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_tag_create to add a tag.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Tag name.
- `items` (`array`, optional): Items associated with this tag. Provide a JSON array of objects.
- `show_in_reporting` (`boolean`, optional): True if tag is a summary label in the reporting app.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_tag_update`

Update Tag · Write

Update the name or reporting flag of a tag.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_tag_update to change a tag.
Get the ID from clover_tag_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): Tag name.
- `tag_id` (`string`, required): Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items, printers.
- `items` (`array`, optional): Items associated with this tag. Provide a JSON array of objects.
- `show_in_reporting` (`boolean`, optional): True if tag is a summary label in the reporting app.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>","tag_id":"<tag_id>"}`

### `clover_tax_rate_create`

Create Tax Rate · Write

Create a tax rate with a name and a rate.
Returns the new tax rate with id, name, taxType, rate, isDefault, items, taxAmount, deletedTime.
Use clover_tax_rate_create to add a tax rate.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): The name value.
- `expand` (`string`, optional): Comma-separated list of related records to include in the response. Allowed values: items.
- `is_default` (`boolean`, optional): The is default value.
- `items` (`array`, optional): Items associated with this tax rate. Provide a JSON array of objects.
- `rate` (`integer`, optional): For percentage based discounts like sales tax.
- `tax_type` (`string`, optional): Tax type used in Argentina. One of: `VAT_TAXABLE`, `VAT_NON_TAXABLE`, `VAT_EXEMPT`, `INTERNAL_TAX`, `PARTNER_TAX`.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>"}`

### `clover_tax_rate_item_associate`

Associate Tax Rates with Items · Write

Create or delete links between tax rates and inventory items in one call.
Returns the association results with taxRate, item.
Use clover_tax_rate_item_associate to attach or detach tax rates on items.
Get IDs from clover_tax_rate_list and clover_item_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `elements` (`array`, required): An array of item and tax rate associations. Provide a JSON array of objects.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `delete` (`boolean`, optional): Use to view, create, or remove an association between items and tax rates in the request body. Values: True - Set to true to remove the association. False - Set to false to create an association.

Example input: `{"elements":[{"category":{"id":"{categoryId}"},"item":{"id":"{item1Id}"}},{"category":{"id":"{categoryId}"},"item":{"id":"{item2Id}"}}],"merchant_id":"<merchant_id>"}`

### `clover_tax_rate_update`

Update Tax Rate · Write

Update the name, rate or default flag of a tax rate.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_tax_rate_update to change a tax rate.
Get the ID from clover_tax_rate_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `name` (`string`, required): The name value.
- `tax_rate_id` (`string`, required): Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `is_default` (`boolean`, optional): The is default value.
- `items` (`array`, optional): Items associated with this tax rate. Provide a JSON array of objects.
- `rate` (`integer`, optional): For percentage based discounts like sales tax.
- `tax_type` (`string`, optional): Tax type used in Argentina. One of: `VAT_TAXABLE`, `VAT_NON_TAXABLE`, `VAT_EXEMPT`, `INTERNAL_TAX`, `PARTNER_TAX`.

Example input: `{"merchant_id":"<merchant_id>","name":"<name>","tax_rate_id":"<tax_rate_id>"}`

### `clover_category_delete`

Delete Category · Destructive

Delete an item category.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_category_delete to remove a category.
Get the ID from clover_category_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`string`, required): Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"category_id":"<category_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_address_delete`

Delete Customer Address · Destructive

Remove a postal address from a customer.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_address_delete to remove an address.
Get IDs from clover_customer_get with expand addresses.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `address_id` (`string`, required): Clover ID of the address (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"address_id":"<address_id>","customer_id":"<customer_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_delete`

Delete Customer · Destructive

Delete a customer record.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_delete to remove a customer.
Get the ID from clover_customer_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_email_address_delete`

Delete Customer Email Address · Destructive

Remove an email address from a customer.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_email_address_delete to remove an email.
Get IDs from clover_customer_get with expand emailAddresses.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `email_id` (`string`, required): Clover ID of the email (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"customer_id":"<customer_id>","email_id":"<email_id>","merchant_id":"<merchant_id>"}`

### `clover_customer_phone_number_delete`

Delete Customer Phone Number · Destructive

Remove a phone number from a customer.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_customer_phone_number_delete to remove a number.
Get IDs from clover_customer_get with expand phoneNumbers.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `phone_id` (`string`, required): Clover ID of the phone (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"customer_id":"<customer_id>","merchant_id":"<merchant_id>","phone_id":"<phone_id>"}`

### `clover_discount_delete`

Delete Discount · Destructive

Delete a saved discount.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_discount_delete to remove a catalog discount.
Get the ID from clover_discount_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"discount_id":"<discount_id>","merchant_id":"<merchant_id>"}`

### `clover_item_delete`

Delete Item · Destructive

Delete an inventory item.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_item_delete to remove an item. Use clover_item_update with hidden set to true to hide it instead.
Get the item ID from clover_item_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_item_group_delete`

Delete Item Group · Destructive

Delete an item group.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_item_group_delete to remove a group.
Get the ID from clover_item_group_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `item_group_id` (`string`, required): Clover ID of the item group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"item_group_id":"<item_group_id>","merchant_id":"<merchant_id>"}`

### `clover_item_stock_delete`

Delete Item Stock · Destructive

Stop tracking stock for an inventory item.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_item_stock_delete to remove stock tracking.
Get the item ID from clover_item_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.

Example input: `{"item_id":"<item_id>","merchant_id":"<merchant_id>"}`

### `clover_modifier_delete`

Delete Modifier · Destructive

Delete a modifier from a modifier group.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_modifier_delete to remove a modifier.
Get IDs from clover_modifier_group_modifier_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `modifier_id` (`string`, required): Clover ID of the modifier (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>","modifier_id":"<modifier_id>"}`

### `clover_modifier_group_delete`

Delete Modifier Group · Destructive

Delete a modifier group.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_modifier_group_delete to remove a group.
Get the ID from clover_modifier_group_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modifier_group_id` (`string`, required): Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","modifier_group_id":"<modifier_group_id>"}`

### `clover_order_delete`

Delete Order · Destructive

Delete an order permanently.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_delete only for orders that should be removed. Use clover_order_update to change an order's state instead.
Get the order ID from clover_order_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_discount_delete`

Delete Order Discount · Destructive

Remove a discount from an order.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_discount_delete to undo an order-level discount.
Get the discount ID from clover_order_discount_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"discount_id":"<discount_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_delete`

Void Order Line Item · Destructive

Void (delete) a line item from an order.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_delete to remove one line item. Use clover_order_delete to remove the whole order.
Get IDs from clover_order_line_item_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_discount_delete`

Delete Line Item Discount · Destructive

Remove a discount from a line item.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_discount_delete to undo an item-level discount.
Get IDs from clover_order_get with expand lineItems.discounts.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `discount_id` (`string`, required): Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"discount_id":"<discount_id>","line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_order_line_item_modification_delete`

Remove Line Item Modification · Destructive

Remove a modification from a line item.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_line_item_modification_delete to undo a modifier on a line item.
Get IDs from clover_order_line_item_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `line_item_id` (`string`, required): Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `modification_id` (`string`, required): Clover ID of the modification (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"line_item_id":"<line_item_id>","merchant_id":"<merchant_id>","modification_id":"<modification_id>","order_id":"<order_id>"}`

### `clover_order_service_charge_remove`

Remove Order Service Charge · Destructive

Remove a service charge from an order.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_order_service_charge_remove to undo clover_order_service_charge_apply.
Get the order ID from clover_order_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `charge_id` (`string`, required): Clover ID of the charge (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `order_id` (`string`, required): Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"charge_id":"<charge_id>","merchant_id":"<merchant_id>","order_id":"<order_id>"}`

### `clover_tag_delete`

Delete Tag · Destructive

Delete a tag.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_tag_delete to remove a tag.
Get the ID from clover_tag_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tag_id` (`string`, required): Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","tag_id":"<tag_id>"}`

### `clover_tax_rate_delete`

Delete Tax Rate · Destructive

Delete a tax rate.
Returns a success response; the Clover reference documents no response body for this call.
Use clover_tax_rate_delete to remove a tax rate.
Get the ID from clover_tax_rate_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `merchant_id` (`string`, required): Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
- `tax_rate_id` (`string`, required): Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Example input: `{"merchant_id":"<merchant_id>","tax_rate_id":"<tax_rate_id>"}`

## Related

Other Accounting & Finance connectors ([all 37](/agentkit/connectors/?category=accounting-finance)):

- [QuickBooks](/agentkit/connectors/quickbooks/): Scalekit connector, OAuth, 117 tools
- [Xero](/agentkit/connectors/xero/): Scalekit connector, OAuth, 94 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |