---
canonical_url: "https://docs.composio.dev/toolkits/clover"
markdown_url: "https://docs.composio.dev/toolkits/clover.md"
product: "platform"
version: null
last_updated: null
---

# Clover

Manage Clover merchant, inventory, customer, employee, order, payment, cash, notification, app, and print data through the regional Platform REST API.

- **Category:** commerce
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 209
- **Triggers:** 0
- **Slug:** `CLOVER`
- **Version:** 00000000_00

## Tools

### Apply Modification To Line Item

**Slug:** `CLOVER_APPLY_MODIFICATION_TO_LINE_ITEM`

Applies a modifier to an order line item and snapshots the modifier's current name and price as a modification record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Modification snapshot; set at least one documented field such as `modifier`, `name`, `amount`, or `quantitySold`. |
| `order_id` | string | Yes | Order Id |
| `line_item_id` | string | Yes | Line Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Apply Order Service Charge

**Slug:** `CLOVER_APPLY_ORDER_SERVICE_CHARGE`

Applies a configured merchant service charge or creates an ad-hoc order-fee line item on an order. Choose `mode` explicitly so Clover receives the matching body and route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The selected `mode` determines which body schema is validated. For `configured`, provide the configured charge `id` and optional overrides. For `order_fee`, provide line-item fields such as `item`, `name`, `price`, or `orderFee`. Fields outside the selected schema are rejected. |
| `mode` | string ("configured" | "order_fee") | Yes | Use `configured` to apply an existing merchant service charge by ID; use `order_fee` to create an ad-hoc order-fee line item. |
| `order_id` | string | Yes | Order identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Checkout Atomic Order

**Slug:** `CLOVER_CHECKOUT_ATOMIC_ORDER`

Calculates and previews an order cart, including totals, taxes, discounts, and service charges, without persisting an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Checkout atomic order body; set at least one documented field such as `orderCart`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Address For Customer

**Slug:** `CLOVER_CREATE_ADDRESS_FOR_CUSTOMER`

Adds a postal address to an existing customer record; it does not create the customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer address; set at least one of `address1`, `city`, `state`, `zip`, or `country`. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create App Billing Metered Event

**Slug:** `CLOVER_CREATE_APP_BILLING_METERED_EVENT`

Records metered app usage and bills the merchant at the configured price; `count` defaults to 1. This is irreversible, so verify an uncertain result before retrying to avoid billing twice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of metered events to bill. Clover defaults to 1 when omitted. |
| `app_id` | string | Yes | App Id |
| `metered_id` | string | Yes | Metered Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Atomic Order

**Slug:** `CLOVER_CREATE_ATOMIC_ORDER`

Creates an order with line items, modifiers, discounts, and service charges while Clover calculates inventory-based totals and taxes. Maximum 3,000 line items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create atomic order body; set at least one documented field such as `orderCart`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Attribute

**Slug:** `CLOVER_CREATE_ATTRIBUTE`

Creates an inventory variant attribute within an item group, optionally with its initial options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create attribute body: `name`, `itemGroup` are required; optional fields include `id`, `options`. |
| `expand` | string | No | Expand options in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Authorization On Payment

**Slug:** `CLOVER_CREATE_AUTHORIZATION_ON_PAYMENT`

Create an authorization for a payment. This has financial consequences and is not safely retryable without first checking whether Clover created the authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Authorization to create. Required fields: `payment.id`, positive `amount`, and `type` (`TAB` or `AUTH`). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `CLOVER_CREATE_CUSTOMER`

Creates a customer record for the connected merchant with the supplied identity and contact details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | New customer fields such as `firstName`, `lastName`, `emailAddresses`, or `phoneNumbers`; include at least one. |
| `expand` | array | No | Related fields to expand in the response. Select one or more of addresses, emailAddresses, phoneNumbers, cards, and metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Card

**Slug:** `CLOVER_CREATE_CUSTOMER_CARD`

Creates a vaulted credit or debit card record for a customer. `first6` and `last4` are required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer card record; `first6` and `last4` are required, with optional token and cardholder fields. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount

**Slug:** `CLOVER_CREATE_DISCOUNT`

Creates a merchant inventory discount with a fixed amount or percentage for later application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create discount body: `name` is required; optional fields include `id`, `discount`, `approver`, `amount`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount On Line Item

**Slug:** `CLOVER_CREATE_DISCOUNT_ON_LINE_ITEM`

Applies a named fixed-amount or percentage discount to one order line item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create discount on line item body: `name` is required; optional fields include `id`, `discount`, `approver`, `amount`. |
| `order_id` | string | Yes | Order Id |
| `line_item_id` | string | Yes | Line Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount On Order

**Slug:** `CLOVER_CREATE_DISCOUNT_ON_ORDER`

Applies a named fixed-amount or percentage discount to an order subtotal, not a specific line item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create discount on order body: `name` is required; optional fields include `id`, `discount`, `approver`, `amount`. |
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Address For Customer

**Slug:** `CLOVER_CREATE_EMAIL_ADDRESS_FOR_CUSTOMER`

Adds an email address to an existing customer record; it does not create the customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer email record; `emailAddress` is required. |
| `customer_id` | string | Yes | Customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee

**Slug:** `CLOVER_CREATE_EMPLOYEE`

Creates a merchant employee profile with a required name and optional login, contact, and role details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Employee fields to send to Clover. The employee name is required when a body is supplied. |
| `expand` | array | No | Related fields to expand in the response. Select one or more of shifts, payments, orders, and roles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Inventory Item

**Slug:** `CLOVER_CREATE_INVENTORY_ITEM`

Creates an inventory item. Clover ignores `available=false` during creation and creates the item as available; call Update Inventory Item afterward to make it unavailable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create inventory item body: `name`, `price` are required; optional fields include `id`, `hidden`, `available`, `autoManage`. |
| `expand` | array | No | Related fields to expand in the response. Select one or more of tags, categories, taxRates, modifierGroups, itemStock, options, and ageRestricted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Category

**Slug:** `CLOVER_CREATE_ITEM_CATEGORY`

Creates an inventory category used to organize items in Clover Register.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create item category body: `name` is required; optional fields include `id`, `sortOrder`, `items`, `colorCode`. |
| `expand` | string | No | Expand items in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Category Associations

**Slug:** `CLOVER_CREATE_ITEM_CATEGORY_ASSOCIATIONS`

Creates one or more associations between inventory items and categories or subcategories. Every tuple requires both `category.id` and `item.id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Category-item tuples to create; `elements` is required and every tuple requires both IDs. |
| `expand` | string | No | Expand items in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Group

**Slug:** `CLOVER_CREATE_ITEM_GROUP`

Creates an item group for related inventory variants and their attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create item group body: `name` is required; optional fields include `id`, `items`, `attributes`. |
| `expand` | array | No | Related fields to expand in the response. Select items, attributes, or both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Modifier Group Associations

**Slug:** `CLOVER_CREATE_ITEM_MODIFIER_GROUP_ASSOCIATIONS`

Creates an association between an inventory item and a modifier group so the group's modifiers can be applied to that item. Provide both `modifierGroup.id` and `item.id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Item-modifier-group association to create; both `modifierGroup.id` and `item.id` are required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Option Associations

**Slug:** `CLOVER_CREATE_ITEM_OPTION_ASSOCIATIONS`

Creates one or more associations between Clover options and inventory items. Every tuple requires both `option.id` and `item.id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Option-item tuples to create; every tuple requires both IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Stock

**Slug:** `CLOVER_CREATE_ITEM_STOCK`

Creates the stock quantity and optional low-stock alert threshold for one inventory item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Initial stock quantity and optional low-stock alert threshold. |
| `item_id` | string | Yes | Unique identifier of an item in the inventory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Tax Rate Associations

**Slug:** `CLOVER_CREATE_ITEM_TAX_RATE_ASSOCIATIONS`

Creates one or more associations between inventory items and tax rates. Every tuple requires both `item.id` and `taxRate.id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Item-tax-rate tuples to create; `elements` is required and every tuple requires both IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Merchant Opening Hours

**Slug:** `CLOVER_CREATE_MERCHANT_OPENING_HOURS`

Creates merchant opening hours. Supply all seven weekday arrays and use an empty array for every closed day; for example, `{'sunday': [], 'monday': [{'start': 900, 'end': 1700}], 'tuesday': [], 'wednesday': [], 'thursday': [], 'friday': [], 'saturday': []}`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Opening-hours body. All seven weekday arrays are required; use an empty array for each closed day. Example: `{'sunday': [], 'monday': [{'start': 900, 'end': 1700}], 'tuesday': [], 'wednesday': [], 'thursday': [], 'friday': [], 'saturday': []}`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Modifier

**Slug:** `CLOVER_CREATE_MODIFIER`

Creates a named modifier with a price adjustment inside a specific modifier group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create modifier body; set at least one documented field such as `id`, `name`, `alternateName`, `available`, `price`. |
| `expand` | string | No | Expand modifierGroup in the response. |
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Modifier Group

**Slug:** `CLOVER_CREATE_MODIFIER_GROUP`

Creates a new modifier group. After you create a modifier group, you can associate modifiers with the group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create modifier group body: `name` is required; optional fields include `id`, `alternateName`, `minRequired`, `maxAllowed`. |
| `expand` | array | No | Related fields to expand in the response. Select modifiers, items, or both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Multiple Inventory Items

**Slug:** `CLOVER_CREATE_MULTIPLE_INVENTORY_ITEMS`

Creates multiple inventory items in one request; use Update Inventory Items to patch existing items instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create multiple inventory items body: `items` is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notification For App

**Slug:** `CLOVER_CREATE_NOTIFICATION_FOR_APP`

Send a message to devices that have the connected Clover app installed and are listening for notifications. Delivery is irreversible and cannot be recalled; verify an uncertain result before retrying to avoid duplicate delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | App notification fields; set `event`, `data` (up to 4000 characters), or `timeToLive`. |
| `app_id` | string | Yes | App Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notification For Device

**Slug:** `CLOVER_CREATE_NOTIFICATION_FOR_DEVICE`

Push a message to a device that has the connected Clover app installed and is listening for notifications. Delivery is irreversible and cannot be recalled; verify an uncertain result before retrying to avoid duplicate delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Device notification fields; set `event`, `data` (up to 4000 characters), or `timeToLive`. |
| `app_id` | string | Yes | App Id |
| `device_id` | string | Yes | Device Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Option

**Slug:** `CLOVER_CREATE_OPTION`

Creates a named option within an inventory attribute, such as `Small` for a `Size` attribute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create option body: `name` is required; optional fields include `id`, `attribute`, `items`. |
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Line Item

**Slug:** `CLOVER_CREATE_ORDER_LINE_ITEM`

Creates one line item for a standard or Multiple Service Charges order; provide `price` or `item.id`. Orders allow 2,500 line items with Multiple Service Charges and 3,000 otherwise.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Line-item fields; include either `price` or `item.id` for an inventory item. |
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Line Items Bulk

**Slug:** `CLOVER_CREATE_ORDER_LINE_ITEMS_BULK`

Creates up to 100 priced line items for either a standard or Multiple Service Charges order. The order limit is 2,500 line items with Multiple Service Charges and 3,000 otherwise.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | One to 100 line items; every item must include `price`. |
| `order_id` | string | Yes | Order identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Type Category Associations

**Slug:** `CLOVER_CREATE_ORDER_TYPE_CATEGORY_ASSOCIATIONS`

Creates associations that limit an order type to specific merchant categories. Every tuple requires both resource IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Associations to create. Every element requires `orderType.id` and `category.id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Type For Merchant

**Slug:** `CLOVER_CREATE_ORDER_TYPE_FOR_MERCHANT`

Creates a custom order type for the merchant, such as dine-in, delivery, or takeout.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create order type for merchant body; set at least one documented field such as `id`, `labelKey`, `label`, `taxable`, `isDefault`. |
| `expand` | array | No | Related fields to expand in the response. Select one or more of hours, attributes, and categories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Payment Record On Order

**Slug:** `CLOVER_CREATE_PAYMENT_RECORD_ON_ORDER`

Records an externally processed payment on an order for bookkeeping; it does not process a Clover credit or debit payment. Requires a positive amount and merchant tender ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | External payment record with a positive `amount` and valid `tender.id`. |
| `order_id` | string | Yes | Order identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Phone Number For Customer

**Slug:** `CLOVER_CREATE_PHONE_NUMBER_FOR_CUSTOMER`

Adds a phone number to an existing customer record; it does not create the customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer phone record; `phoneNumber` is required. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Role

**Slug:** `CLOVER_CREATE_ROLE`

Creates a merchant employee role based on a Clover system role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create role body: `name`, `systemRole` are required; optional fields include `id`, `employeesRef`, `merchant`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Shift For Employee

**Slug:** `CLOVER_CREATE_SHIFT_FOR_EMPLOYEE`

Creates a time-clock shift for one employee, including clock-in/out times, cash tips, or override details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | New shift fields such as `inTime`, `outTime`, cash tips, and override references. |
| `employee_id` | string | Yes | Employee ID for whom to create the shift. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subcategory

**Slug:** `CLOVER_CREATE_SUBCATEGORY`

Creates a subcategory within a parent inventory category; it inherits the parent's color when one is set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create subcategory body: `name` is required; optional fields include `colorCode`. |
| `category_id` | string | Yes | Unique identifier of the parent category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `CLOVER_CREATE_TAG`

Creates an inventory tag for reporting, with optional item and printer associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create tag body: `name` is required; optional fields include `id`, `showInReporting`, `items`, `printers`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag Item Associations

**Slug:** `CLOVER_CREATE_TAG_ITEM_ASSOCIATIONS`

Creates one or more associations between Clover tags and inventory items. Every tuple requires both `tag.id` and `item.id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Tag-item tuples to create; every tuple requires both IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tax Rate

**Slug:** `CLOVER_CREATE_TAX_RATE`

Creates a merchant tax rate as a percentage or flat amount, optionally making it the default or associating items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create tax rate body: `name` is required; optional fields include `id`, `taxType`, `rate`, `isDefault`. |
| `expand` | string | No | Expand items in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tender

**Slug:** `CLOVER_CREATE_TENDER`

Creates a merchant-level custom tender and returns its generated identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Create tender body: `label` is required; optional fields include `id`, `editable`, `labelKey`, `opensCashDrawer`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete All Line Items In Order

**Slug:** `CLOVER_DELETE_ALL_LINE_ITEMS_IN_ORDER`

Deletes every line item from an order. This is destructive; verify the order before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete App Billing Metered Event

**Slug:** `CLOVER_DELETE_APP_BILLING_METERED_EVENT`

Deletes an unbilled app metered event. Billed events cannot be deleted; verify the event before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | App Id |
| `event_id` | string | Yes | Clover event id used in the documented path field 'eventId'. |
| `metered_id` | string | Yes | Metered Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Attribute

**Slug:** `CLOVER_DELETE_ATTRIBUTE`

Deletes an inventory variant attribute. This is destructive; verify the attribute identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Authorization

**Slug:** `CLOVER_DELETE_AUTHORIZATION`

Permanently delete a payment authorization. Only target an authorization the caller intends to remove; repeat only after confirming whether the first request succeeded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `authorization_id` | string | Yes | Clover authorization identifier from the documented `authId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Categories

**Slug:** `CLOVER_DELETE_CATEGORIES`

Permanently deletes the categories identified by a comma-separated list of category IDs. Get IDs from List Categories and target only categories you intend to delete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_ids` | string | Yes | Comma-separated category IDs to permanently delete. Get IDs from List Categories and include only categories you intend to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `CLOVER_DELETE_CUSTOMER`

Deletes a customer from the connected merchant. This is destructive; verify the customer identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Address

**Slug:** `CLOVER_DELETE_CUSTOMER_ADDRESS`

Deletes one address from a customer. This is destructive; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | Clover address identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Card

**Slug:** `CLOVER_DELETE_CUSTOMER_CARD`

Deletes one vaulted card record from a customer. This is destructive; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | string | Yes | Clover card identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Email Address

**Slug:** `CLOVER_DELETE_CUSTOMER_EMAIL_ADDRESS`

Deletes one email address from a customer. This is destructive; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Clover email identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Phone Number

**Slug:** `CLOVER_DELETE_CUSTOMER_PHONE_NUMBER`

Deletes one phone number from a customer. This is destructive; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone_id` | string | Yes | Clover phone identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Employee

**Slug:** `CLOVER_DELETE_EMPLOYEE`

Deletes an employee from the connected merchant. This is destructive; verify the employee identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_id` | string | Yes | Employee ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Discount

**Slug:** `CLOVER_DELETE_INVENTORY_DISCOUNT`

Deletes a merchant inventory discount. This is destructive; verify the discount identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discount_id` | string | Yes | Discount Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Item

**Slug:** `CLOVER_DELETE_INVENTORY_ITEM`

Deletes an inventory item. This is destructive; verify the item identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item Category

**Slug:** `CLOVER_DELETE_ITEM_CATEGORY`

Deletes an inventory category. This is destructive; verify the category identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | Category Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item Group

**Slug:** `CLOVER_DELETE_ITEM_GROUP`

Deletes an inventory item group. This is destructive; verify the group identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_group_id` | string | Yes | Item Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item Stock

**Slug:** `CLOVER_DELETE_ITEM_STOCK`

Deletes the stock record for an inventory item. This is destructive; verify the item identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Line Item Discount

**Slug:** `CLOVER_DELETE_LINE_ITEM_DISCOUNT`

Removes a discount from an order line item. This changes order pricing; verify all identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order Id |
| `discount_id` | string | Yes | Discount Id |
| `line_item_id` | string | Yes | Line Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Merchant Opening Hours

**Slug:** `CLOVER_DELETE_MERCHANT_OPENING_HOURS`

Deletes one merchant opening-hours interval. This is destructive; verify the interval identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opening_hours_id` | string | Yes | Clover opening hours id used in the documented path field 'hId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Modifier

**Slug:** `CLOVER_DELETE_MODIFIER`

Deletes one modifier from a modifier group. This is destructive; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modifier_id` | string | Yes | Clover modifier id used in the documented path field 'modId'. |
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Modifier Group

**Slug:** `CLOVER_DELETE_MODIFIER_GROUP`

Deletes a modifier group and every modifier in it. This is destructive; verify the group identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Modifier Groups

**Slug:** `CLOVER_DELETE_MODIFIER_GROUPS`

Permanently deletes the modifier groups identified by a comma-separated list of IDs, including every modifier in those groups. Get IDs from List Modifier Groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modifier_group_ids` | string | Yes | Comma-separated modifier-group IDs to permanently delete. Get IDs from List Modifier Groups; deleting a group also deletes all modifiers in it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Multiple Inventory Items

**Slug:** `CLOVER_DELETE_MULTIPLE_INVENTORY_ITEMS`

Permanently deletes the inventory items identified by a comma-separated list of item IDs. Get IDs from List Inventory Items and target only intended items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_ids` | string | Yes | Comma-separated inventory-item IDs to permanently delete. Get IDs from List Inventory Items and include only owned or explicitly selected items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Option

**Slug:** `CLOVER_DELETE_OPTION`

Deletes an option from an inventory attribute. This is destructive; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `option_id` | string | Yes | Option Id |
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order

**Slug:** `CLOVER_DELETE_ORDER`

Deletes an order. This is destructive; verify the order identifier and current state before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Discount

**Slug:** `CLOVER_DELETE_ORDER_DISCOUNT`

Removes a discount from an order. This changes order pricing; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order Id |
| `discount_id` | string | Yes | Discount Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Line Item

**Slug:** `CLOVER_DELETE_ORDER_LINE_ITEM`

Deletes a line item from an order. This is destructive and changes the order; verify both identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order identifier. |
| `line_item_id` | string | Yes | Line Item identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Type

**Slug:** `CLOVER_DELETE_ORDER_TYPE`

Deletes a merchant order type. This is destructive; verify the order-type identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_type_id` | string | Yes | Order Type Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Role

**Slug:** `CLOVER_DELETE_ROLE`

Deletes a merchant employee role. This is destructive; verify the role identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Clover role id used in the documented path field 'roleId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Shift

**Slug:** `CLOVER_DELETE_SHIFT`

Deletes one employee shift. Clover requires `account_id` to identify an employee permitted to edit shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shift_id` | string | Yes | Employee shift ID to delete. |
| `account_id` | string | Yes | Employee ID of an account with permission to edit shifts, required by Clover for shift deletion. |
| `employee_id` | string | Yes | Employee ID that owns the shift. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subcategory

**Slug:** `CLOVER_DELETE_SUBCATEGORY`

Deletes a subcategory and reassigns its items to the parent category. This is destructive; verify the subcategory identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subcategory_id` | string | Yes | Unique identifier of the subcategory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tag

**Slug:** `CLOVER_DELETE_TAG`

Deletes an inventory tag. This is destructive; verify the tag identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Tag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tags

**Slug:** `CLOVER_DELETE_TAGS`

Permanently deletes the tags identified by a comma-separated list of tag IDs. Get IDs from List Tags and target only intended tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | string | Yes | Comma-separated tag IDs to permanently delete. Get IDs from List Tags and include only tags you intend to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tax Rate

**Slug:** `CLOVER_DELETE_TAX_RATE`

Deletes a merchant tax rate. This is destructive; verify the tax-rate identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_rate_id` | string | Yes | Tax Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tender

**Slug:** `CLOVER_DELETE_TENDER`

Deletes a merchant tender. This is destructive; verify the tender identifier before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tender_id` | string | Yes | Tender Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Exchange Order Line Item

**Slug:** `CLOVER_EXCHANGE_ORDER_LINE_ITEM`

Creates a replacement line item under the client-supplied `line_item_id` and exchanges `old_line_item_id` for it. Provide `price` or `item.id`; Clover's required matching body ID is supplied automatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Replacement line-item snapshot; include either `price` or `item.id`. Clover creates this replacement using `line_item_id` and exchanges the old line item for it. |
| `order_id` | string | Yes | Order Id |
| `line_item_id` | string | Yes | Line Item Id |
| `old_line_item_id` | string | Yes | Old Line Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Customers Csv

**Slug:** `CLOVER_EXPORT_CUSTOMERS_CSV`

Exports customers as CSV. Use `filter` to export only matching customers and `expand` to include selected related address, contact, card, or metadata fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Related customer fields to include in the export. Select one or more of addresses, emailAddresses, phoneNumbers, cards, and metadata. |
| `filter` | string | No | Filter by customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, or deletedTime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Shifts CSV

**Slug:** `CLOVER_EXPORT_SHIFTS_CSV`

Exports merchant shifts as CSV for a required effective clock-in time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | integer | Yes | Inclusive end of the required effective clock-in window, as Unix epoch milliseconds. |
| `start_time` | integer | Yes | Inclusive start of the required effective clock-in window, as Unix epoch milliseconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App Billing Metered Event

**Slug:** `CLOVER_GET_APP_BILLING_METERED_EVENT`

Returns one metered billing event recorded for a merchant's app subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | App Id |
| `event_id` | string | Yes | Clover event id used in the documented path field 'eventId'. |
| `metered_id` | string | Yes | Metered Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attribute

**Slug:** `CLOVER_GET_ATTRIBUTE`

Returns one inventory variant attribute with the item-group and option references present in Clover's response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Authorization

**Slug:** `CLOVER_GET_AUTHORIZATION`

Retrieve one Clover payment authorization by identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Comma-separated documented expansions, including payment, tender, cardTransaction, refunds, order, and employee. |
| `authorization_id` | string | Yes | Clover authorization identifier from the documented `authId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category

**Slug:** `CLOVER_GET_CATEGORY`

Returns one inventory category, including its Register sort order and optional item expansion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expand items in the response. |
| `category_id` | string | Yes | Category Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Configured Service Charge

**Slug:** `CLOVER_GET_CONFIGURED_SERVICE_CHARGE`

Returns one service charge configured for the merchant, identified by `service_charge_id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `service_charge_id` | string | Yes | Configured service charge identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Refund

**Slug:** `CLOVER_GET_CREDIT_REFUND`

Retrieve one Clover credit refund, including its credit, order, device, employee, and transaction details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Comma-separated expansions. Clover documents credit, germanInfo, appTracking, and transactionInfo. |
| `credit_refund_id` | string | Yes | Credit refund identifier from the documented `crId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `CLOVER_GET_CUSTOMER`

Returns one customer profile, with addresses, email addresses, phone numbers, cards, or metadata when expanded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expand addresses, emailAddresses, phoneNumbers, cards, or metadata. |
| `filter` | string | No | Filter by customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, or deletedTime. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Default Service Charge

**Slug:** `CLOVER_GET_DEFAULT_SERVICE_CHARGE`

Returns the merchant's default configured service charge.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Device Provisioned To Merchant

**Slug:** `CLOVER_GET_DEVICE_PROVISIONED_TO_MERCHANT`

Returns one Clover device provisioned to the connected merchant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `device_id` | string | Yes | Device Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Discount

**Slug:** `CLOVER_GET_DISCOUNT`

Returns one merchant inventory discount, including its fixed amount or percentage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discount_id` | string | Yes | Discount Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee

**Slug:** `CLOVER_GET_EMPLOYEE`

Returns one merchant employee profile, with assigned roles or related shifts, payments, and orders when expanded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Comma-separated expandable fields: roles and shifts. |
| `employee_id` | string | Yes | Employee ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Item

**Slug:** `CLOVER_GET_INVENTORY_ITEM`

Returns one inventory item with pricing, availability, SKU, and requested related resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options] |
| `item_id` | string | Yes | Inventory item identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item Group

**Slug:** `CLOVER_GET_ITEM_GROUP`

Returns one inventory item group and its related variants or attributes when expanded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [items, attributes] |
| `item_group_id` | string | Yes | Item Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item Stock

**Slug:** `CLOVER_GET_ITEM_STOCK`

Returns the current stock quantity and alert threshold for one inventory item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item Subcategory Associations

**Slug:** `CLOVER_GET_ITEM_SUBCATEGORY_ASSOCIATIONS`

Returns an inventory item and, with `expand=categories.items`, its category and subcategory associations; subcategories have a `parentCategory`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expandable fields to display additional nested information: [categories.items]. |
| `item_id` | string | Yes | Unique identifier of an item in the inventory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Legacy Sync Token

**Slug:** `CLOVER_GET_LEGACY_SYNC_TOKEN`

Retrieves a provider-deprecated table sync token only for a downstream legacy Clover sync consumer that explicitly requires it. Normal list and filter tools do not produce this token. Clover documents the route, but the sandbox route is known to return 404 in some environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table` | string | Yes | Clover table name required by the provider's legacy sync protocol. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant

**Slug:** `CLOVER_GET_MERCHANT`

Returns the connected merchant's business profile and requested related resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields to display additional nested information: [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, equipment, equipmentSummary] |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Address

**Slug:** `CLOVER_GET_MERCHANT_ADDRESS`

Returns the connected merchant's business address.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant App Billing Information

**Slug:** `CLOVER_GET_MERCHANT_APP_BILLING_INFORMATION`

Returns a merchant's app-billing status, including the current subscription tier and trial status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | App Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Opening Hours

**Slug:** `CLOVER_GET_MERCHANT_OPENING_HOURS`

Returns one merchant opening-hours interval by identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opening_hours_id` | string | Yes | Clover opening hours id used in the documented path field 'hId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Payment Gateway Configuration

**Slug:** `CLOVER_GET_MERCHANT_PAYMENT_GATEWAY_CONFIGURATION`

Returns the connected merchant's payment-gateway configuration and supported capabilities.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Merchant Properties

**Slug:** `CLOVER_GET_MERCHANT_PROPERTIES`

Returns the connected merchant's operational properties and feature settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Modifier

**Slug:** `CLOVER_GET_MODIFIER`

Returns one modifier from a specific modifier group, including its name and price adjustment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expandable field: [modifierGroup] |
| `modifier_id` | string | Yes | Clover modifier id used in the documented path field 'modId'. |
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Modifier Group

**Slug:** `CLOVER_GET_MODIFIER_GROUP`

Returns one modifier group and its configuration, with related modifiers or items when expanded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [modifiers, items] |
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Option For Attribute

**Slug:** `CLOVER_GET_OPTION_FOR_ATTRIBUTE`

Returns one option from a specific inventory attribute, including its item references.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter fields: [modifiedTime, item.id, name, attribute.id, id, deletedTime] |
| `option_id` | string | Yes | Option Id |
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `CLOVER_GET_ORDER`

Returns one order with totals, state, and any related resources requested through `expand`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds] |
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Line Item

**Slug:** `CLOVER_GET_ORDER_LINE_ITEM`

Returns one line item from any order, including age-restriction or Multiple Service Charges fields when Clover provides them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments] |
| `order_id` | string | Yes | Order Id |
| `line_item_id` | string | Yes | Line Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order Type

**Slug:** `CLOVER_GET_ORDER_TYPE`

Returns one merchant order type, including taxability and category-filter settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [hours, attributes, categories] |
| `order_type_id` | string | Yes | Order Type Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment

**Slug:** `CLOVER_GET_PAYMENT`

Retrieve one Clover payment, including amount, tax, tip, and result status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Comma-separated expansions including tender, cardTransaction, employee, refunds, taxRates, appTracking, paymentAttributes, and order. |
| `payment_id` | string | Yes | Clover payment identifier from the documented `payId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Print Event

**Slug:** `CLOVER_GET_PRINT_EVENT`

Get a print event for the connected Clover merchant by event ID. Successfully printed events are discarded by Clover and cannot be replayed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | string | Yes | Clover print event identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Refund

**Slug:** `CLOVER_GET_REFUND`

Retrieve one Clover refund, including associated payment, tax, tip, and transaction details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Comma-separated expansions including payment, employee, serviceCharge, lineItems, transactionInfo, and oceanGatewayInfo. |
| `refund_id` | string | Yes | Clover refund identifier from the documented `refundId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Role

**Slug:** `CLOVER_GET_ROLE`

Returns one merchant employee role and its base system role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expandable fields: [employees] |
| `role_id` | string | Yes | Clover role id used in the documented path field 'roleId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Service Charge Applied To Order

**Slug:** `CLOVER_GET_SERVICE_CHARGE_APPLIED_TO_ORDER`

Returns one service-charge line item already applied to an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Additional information provided as an expanded response: [employee, orderType, payments] |
| `order_id` | string | Yes | Order identifier. |
| `order_fee_line_item_id` | string | Yes | Order fee line item identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shift

**Slug:** `CLOVER_GET_SHIFT`

Retrieves one shift by ID. Set `employee_id` to use Clover's dedicated employee shift operation; omit it to use the merchant shift collection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Comma-separated expandable fields: employee, overrideInEmployee, and overrideOutEmployee. |
| `shift_id` | string | Yes | Shift ID to retrieve. |
| `employee_id` | string | No | Employee ID that owns the shift. Omit to retrieve the shift from the merchant collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tag

**Slug:** `CLOVER_GET_TAG`

Returns one inventory tag and its item or printer associations when expanded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [items, printers] |
| `tag_id` | string | Yes | Tag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tax Exemption Rule

**Slug:** `CLOVER_GET_TAX_EXEMPTION_RULE`

Returns one tax exemption rule that links order types and items to excluded tax rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_rule_id` | string | Yes | Clover tax rule id used in the documented path field 'taxRuleId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tax Rate

**Slug:** `CLOVER_GET_TAX_RATE`

Returns one merchant tax rate, including its rate, type, and default status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expandable fields: [items] |
| `tax_rate_id` | string | Yes | Tax Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tender

**Slug:** `CLOVER_GET_TENDER`

Returns one merchant tender and its payment-handling settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tender_id` | string | Yes | Tender Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tip Suggestion

**Slug:** `CLOVER_GET_TIP_SUGGESTION`

Returns one merchant tip suggestion, including its percentage or flat amount.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tip_suggestion_id` | string | Yes | Clover tip suggestion id used in the documented path field 'tId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Voided Line Item Totals

**Slug:** `CLOVER_GET_VOIDED_LINE_ITEM_TOTALS`

Returns deleted line-item and order totals for a required caller-supplied deletedTime window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | integer | Yes | Inclusive end of the required deletedTime window, as Unix epoch milliseconds. |
| `start_time` | integer | Yes | Inclusive start of the required deletedTime window, as Unix epoch milliseconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List App Billing Metered Events

**Slug:** `CLOVER_LIST_APP_BILLING_METERED_EVENTS`

Lists billing events recorded for one app metered-event type, such as `reservation`. Requires an OAuth-generated token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | App Id |
| `metered_id` | string | Yes | Metered Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Attributes

**Slug:** `CLOVER_LIST_ATTRIBUTES`

Lists inventory variant attributes, such as size or color. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, name, id, deletedTime, itemGroup.id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Authorizations

**Slug:** `CLOVER_LIST_AUTHORIZATIONS`

List payment authorizations for the connected merchant. Authorizations permit a future charge up to the authorized amount.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expandable field. Clover documents `payment`. |
| `filter` | string | No | Filter by a documented authorization field, including paymentId, amount, cardType, createdTime, or id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cash Events

**Slug:** `CLOVER_LIST_CASH_EVENTS`

List cash events for the merchant, one device, or one employee. Select `context` and provide `context_id` for device or employee requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return. |
| `expand` | array | No | Comma-separated related fields to expand. Supported fields are employee and device. |
| `filter` | string | No | Filter by employee.id, note, amountChange, employee.name, type, device.id, or timestamp. |
| `offset` | integer | No | Zero-based result offset. |
| `context` | string ("merchant" | "device" | "employee") | Yes | Resource context to list cash events for. Use `merchant` for all merchant events, `device` for one device, or `employee` for one employee. |
| `context_id` | string | No | Device or employee identifier. Required for `device` and `employee`; omit for `merchant`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Categories

**Slug:** `CLOVER_LIST_CATEGORIES`

Lists inventory categories in Register sort order, optionally with associated items. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | string | No | Additional information provided as an expanded response: [items] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Categories Of Item

**Slug:** `CLOVER_LIST_CATEGORIES_OF_ITEM`

Retrieves all categories of an item. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | string | No | Expandable fields to display additional nested information: [items] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |
| `item_id` | string | Yes | Item identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Category Subcategories

**Slug:** `CLOVER_LIST_CATEGORY_SUBCATEGORIES`

Returns a category with its subcategories expanded by default; use `subCategories.items` only when nested item details are also needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string ("subCategories" | "subCategories.items") | No | Expandable fields to display additional nested information: [subCategories, subCategories.items]. |
| `category_id` | string | Yes | Category identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Configured Service Charges

**Slug:** `CLOVER_LIST_CONFIGURED_SERVICE_CHARGES`

Lists service charges configured for the merchant; use the applied-service-charge tools for charges already attached to an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter fields to display search results: [modifiedTime, amount, serviceChargeUuid, type, percentage, name, createdTime, id, deletedTime] |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Credit Refunds

**Slug:** `CLOVER_LIST_CREDIT_REFUNDS`

List credit refunds for the connected merchant, including associated tax and transaction details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Comma-separated expansions. Clover documents credit, germanInfo, appTracking, and transactionInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `CLOVER_LIST_CUSTOMERS`

Lists customer records for the connected merchant, optionally filtered or expanded with related contact data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expand addresses, emailAddresses, phoneNumbers, cards, or metadata. |
| `filter` | string | No | Filter by customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, or deletedTime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Devices Provisioned To Merchant

**Slug:** `CLOVER_LIST_DEVICES_PROVISIONED_TO_MERCHANT`

Lists Clover devices provisioned to the connected merchant, optionally filtered by documented device fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter fields: [serial, name, merchant.id, merchant.name, deviceTypeName, model, id, deleted_time, orderPrefix] |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discounts

**Slug:** `CLOVER_LIST_DISCOUNTS`

Lists the merchant's inventory discounts. Returns one caller-selected offset page; request successive offsets until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `filter` | string | No | Filter fields to display search results: [amount, modifiedtime, percentage, id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discounts For Order

**Slug:** `CLOVER_LIST_DISCOUNTS_FOR_ORDER`

Lists discounts currently applied at the order level; line-item discounts are returned by the line-item tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Orders

**Slug:** `CLOVER_LIST_EMPLOYEE_ORDERS`

Lists one employee's orders through Clover's exact `/employees/{empId}/orders` route, which requires `Read employees`, while preserving a caller-supplied custom `filter`. Use List Orders instead for the merchant `/orders` route and its `Read orders` permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum orders to return. Clover defaults collection responses to 100 and enforces a hard limit of 1000. |
| `expand` | array | No | Comma-separated fields to expand: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, and refunds. |
| `filter` | string | No | Clover filter expression over lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, or refunds. |
| `offset` | integer | No | Zero-based result offset. Use with limit to request a later page of this employee's orders. |
| `employee_id` | string | Yes | Employee ID whose exact Clover employee order collection to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employees

**Slug:** `CLOVER_LIST_EMPLOYEES`

List employees for the connected Clover merchant, optionally filtered or expanded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Comma-separated expandable fields: roles and shifts. |
| `filter` | string | No | Clover filter expression. Supported fields include modifiedTime, role, role.id, customId, name, nickname, id, deletedTime, deleted_time, and email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Items

**Slug:** `CLOVER_LIST_INVENTORY_ITEMS`

Lists inventory items for the connected merchant. Returns one caller-selected offset page; increase offset by the page size until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum inventory items to return on this page. Defaults to 100; maximum 1000. |
| `expand` | array | No | Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted] |
| `filter` | string | No | Filter fields to display search results: [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, minimumAge] |
| `offset` | integer | No | Zero-based position of the first inventory item returned. Increase by the previous page size to request the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Without Revenue Class

**Slug:** `CLOVER_LIST_INVENTORY_WITHOUT_REVENUE_CLASS`

Lists inventory items that have no revenue-class tag. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options] |
| `filter` | string | No | Filter fields to display search results: [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] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Item Groups

**Slug:** `CLOVER_LIST_ITEM_GROUPS`

Lists item groups used to organize related inventory variants and attributes. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Additional information provided as an expanded response: [items, attributes] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, name, id, deletedTime] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items By Tax Rate

**Slug:** `CLOVER_LIST_ITEMS_BY_TAX_RATE`

Lists inventory items associated with the specified tax rate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Expandable fields: [items] |
| `filter` | string | No | Filter 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] |
| `tax_rate_id` | string | Yes | Tax Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items For Tag

**Slug:** `CLOVER_LIST_ITEMS_FOR_TAG`

Lists inventory items associated with one tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [items, printers] |
| `filter` | string | No | Filter fields: [modifiedTime, hidden, itemCode, available, option.id, alternateName, isRevenue, modifierGroup.id, autoManage, deleted, item.id, price, name, itemStock.quantity, id, sku, defaultTaxRates, itemGroup.id] |
| `tag_id` | string | Yes | Tag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items In Category

**Slug:** `CLOVER_LIST_ITEMS_IN_CATEGORY`

Retrieves all items in a category. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Expandable fields to display additional nested information: [categories, itemStock, modifierRates, options, tags, taxRates] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |
| `category_id` | string | Yes | Category identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items In Modifier Group

**Slug:** `CLOVER_LIST_ITEMS_IN_MODIFIER_GROUP`

Retrieves a list of all items in a single modifier group. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Expandable fields to display additional nested information: [tags, categories, taxRates, modifierGroups, itemStock, options] |
| `filter` | string | No | Filter fields to display search results: [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] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |
| `modifier_group_id` | string | Yes | Modifier group identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Item Stocks

**Slug:** `CLOVER_LIST_ITEM_STOCKS`

Lists stock quantities and alert thresholds for the merchant's inventory items.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Item Tags

**Slug:** `CLOVER_LIST_ITEM_TAGS`

Lists inventory tags associated with one item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [items, printers] |
| `filter` | string | No | Filter fields: [modifiedTime, deleted, name, showInReporting, id] |
| `item_id` | string | Yes | Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Merchant Opening Hours

**Slug:** `CLOVER_LIST_MERCHANT_OPENING_HOURS`

Lists the connected merchant's opening-hours intervals.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modifier Groups

**Slug:** `CLOVER_LIST_MODIFIER_GROUPS`

Lists modifier groups that organize selectable item modifiers. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Expandable fields to display additional nested information: [modifiers, items] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, category.id, negativeSortOrder, item.id, sortOrder, name, id, showByDefault] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modifiers

**Slug:** `CLOVER_LIST_MODIFIERS`

Retrieves all modifiers from all modifier groups. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | string | No | Expandable fields to display additional nested information: [modifierGroup] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, price, name, alternateName, id, modifierGroup.id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modifiers In Modifier Group

**Slug:** `CLOVER_LIST_MODIFIERS_IN_MODIFIER_GROUP`

Retrieves a list of modifiers in a single modifier group. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Expandable fields to display additional nested information: [modifiers, items] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, price, name, alternateName, id, modifierGroup.id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |
| `modifier_group_id` | string | Yes | Modifier group identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Options

**Slug:** `CLOVER_LIST_OPTIONS`

Lists options across all inventory variant attributes. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | string | No | Expandable fields to display additional nested information: [options] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, item.id, name, attribute.id, id, deletedTime] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Options For Attribute

**Slug:** `CLOVER_LIST_OPTIONS_FOR_ATTRIBUTE`

Retrieves all available variants or options associated with an attribute. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | string | No | Expandable fields to display additional nested information: [options] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, item.id, name, attribute.id, id, deletedTime] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |
| `attribute_id` | string | Yes | Attribute identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Line Items

**Slug:** `CLOVER_LIST_ORDER_LINE_ITEMS`

Lists line items from any order, including age-restriction or Multiple Service Charges fields when Clover provides them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments] |
| `order_id` | string | Yes | Order Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `CLOVER_LIST_ORDERS`

Lists orders through Clover's merchant `/orders` route, which requires `Read orders`, with filtering, expansion, and offset pagination. Set `employee_id` for an employee-filtered merchant-route view; use List Employee Orders for the exact employee route, its `Read employees` permission, and preservation of a custom `filter`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return. |
| `expand` | array | No | Additional information provided as an expanded response: [employee, payments, refunds, credits, voids, payment.tender, payment.cardTransaction, lineItems, customers, serviceCharge, discounts, orderType, lineItems.discounts, lineItems.modifications] |
| `filter` | string | No | Filter fields to display search results: [employee.id, note, modifiedTime, orderType, touched, cardTransaction.last4, manualTransaction, employee.name, title, device.id, externalReferenceId, clientCreatedTime, total, payType, testMode, createdTime, id, state, deletedTime]  `Note`: Search results for the list of orders list is restricted to the last 90 days if the filter fields include: [deletedTime, externalReferenceId, createdTime, total, payType, title, note, state, manualTransaction, cardTransaction.last4, testMode, touched] |
| `offset` | integer | No | Zero-based result offset. |
| `employee_id` | string | No | Employee identifier whose orders to list. Omit to list orders for the merchant. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Types

**Slug:** `CLOVER_LIST_ORDER_TYPES`

Lists merchant-defined order types and their system-type or category settings. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000 |
| `expand` | array | No | Expandable fields to display additional nested information: [hours, attributes, categories] |
| `filter` | string | No | Filter fields to display search results: [id, deletedTime] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `CLOVER_LIST_PAYMENTS`

List payments for the merchant, one order, or one employee. Select `context` and provide `context_id` for order or employee requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return. |
| `expand` | string | No | Comma-separated expansions including tender, cardTransaction, refunds, taxRates, appTracking, paymentAttributes, and order. |
| `filter` | string | No | Filter by documented fields including modifiedTime, result, createdTime, id, employee.id, order.modifiedTime, amount, or clientCreatedTime. |
| `offset` | integer | No | Zero-based result offset. |
| `context` | string ("merchant" | "order" | "employee") | Yes | Resource context to list payments for. Use `merchant`, `order`, or `employee`. |
| `context_id` | string | No | Order or employee identifier. Required for `order` and `employee`; omit for `merchant`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Refunds

**Slug:** `CLOVER_LIST_REFUNDS`

List merchant refunds, including taxes and tips. Clover returns at most 90 days and automatically narrows wider time filters to the most recent 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string | No | Comma-separated expansions including payment, employee, serviceCharge, lineItems, transactionInfo, and oceanGatewayInfo. |
| `filter` | string | No | Clover filter expression for id, voided, createdTime, clientCreatedTime, orderRef.id, payment.id, employee.id, or device.id. Time filters are limited to the most recent 90 days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Roles

**Slug:** `CLOVER_LIST_ROLES`

Retrieves all system and employee roles for a merchant's business. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000 |
| `expand` | string | No | Expandable fields to display additional nested information: [employees] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, systemRole, name, id, deletedTime] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Service Charges Applied To Order

**Slug:** `CLOVER_LIST_SERVICE_CHARGES_APPLIED_TO_ORDER`

Lists service-charge line items already applied to an order; use configured-service-charge tools for merchant templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Additional information provided as an expanded response: [employee, orderType, payments] |
| `order_id` | string | Yes | Order identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shifts

**Slug:** `CLOVER_LIST_SHIFTS`

List shifts for the connected merchant or, when `employee_id` is provided, for one employee. Filters, expansions, and offset pagination apply to either route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return. |
| `expand` | array | No | Comma-separated expandable fields: employee, overrideInEmployee, and overrideOutEmployee. |
| `filter` | string | No | Clover filter expression. Supported fields include employee.id, out_time, in_time, employee.name, in_and_override_time, out_and_override_time, id, has_in_time, override_in_time, deletedTime, and server_banking. |
| `offset` | integer | No | Zero-based result offset. |
| `employee_id` | string | No | Employee identifier whose shifts to list. Omit to list shifts for the merchant. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List System Order Types

**Slug:** `CLOVER_LIST_SYSTEM_ORDER_TYPES`

Lists Clover's system order-type categories used to classify merchant-defined order types, such as takeout.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tag Item Associations

**Slug:** `CLOVER_LIST_TAG_ITEM_ASSOCIATIONS`

Lists every association between the merchant's inventory tags and items.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `CLOVER_LIST_TAGS`

Lists the merchant's inventory tags. Tags label items for reporting and can route tagged items to associated printers. Returns one caller-selected offset page; request successive offsets until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | array | No | Additional information provided as an expanded response: [items, printers] |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, deleted, name, showInReporting, id] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tax Exemption Rules

**Slug:** `CLOVER_LIST_TAX_EXEMPTION_RULES`

Lists tax exemption rules that link order types and items to tax rates excluded from those items.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tax Rates

**Slug:** `CLOVER_LIST_TAX_RATES`

Lists percentage and flat-amount tax rates. Returns one offset page; continue until `elements` is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result.  Default: 100   Maximum limit: 1000 |
| `expand` | string | No | Additional information provided as an expanded response: [items] |
| `filter` | string | No | Filter fields to display search results: [isDefault, rate, items.id, name, id, taxAmount, taxType] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tenders

**Slug:** `CLOVER_LIST_TENDERS`

Retrieves all tenders for a merchant. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000 |
| `filter` | string | No | Filter fields to display search results: [modifiedTime, visible, merchantId, instruction, systemTenderId, label, id, labelKey, opensCashDrawer, deletedTime, enabled] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tip Suggestions

**Slug:** `CLOVER_LIST_TIP_SUGGESTIONS`

Retrieves all tip suggestions for a merchant, for example: flat tip or percentage. Returns one caller-selected offset page; request another offset until elements is empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000 |
| `filter` | string | No | Filter fields to display search results: [flatTip, percentage, name, id, enabled] |
| `offset` | integer | No | Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Record Voided Line Items

**Slug:** `CLOVER_RECORD_VOIDED_LINE_ITEMS`

Records voided line items on an order for reporting, including their quantities and reasons.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Voided-line-item record; set at least one of `lineItem`, `reason`, `removedBy`, `approvedBy`, or `deleteType`. |
| `order_id` | string | Yes | Order identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Item Category Associations

**Slug:** `CLOVER_REMOVE_ITEM_CATEGORY_ASSOCIATIONS`

Permanently removes specific item-category associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Associations to remove. Each tuple may contain both IDs, only `category.id` to remove all items from that category, or only `item.id` to remove all categories from that item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Item Modifier Group Associations

**Slug:** `CLOVER_REMOVE_ITEM_MODIFIER_GROUP_ASSOCIATIONS`

Permanently removes a specific item-modifier-group association or all associations on one supplied side. Review one-sided bodies carefully because they can remove many links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Association to remove. Provide both IDs for one link, or one side to remove all modifier-group links for that object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Item Option Associations

**Slug:** `CLOVER_REMOVE_ITEM_OPTION_ASSOCIATIONS`

Permanently removes specific option-item associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Associations to remove. A one-sided tuple removes every association for that option or item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Item Tax Rate Associations

**Slug:** `CLOVER_REMOVE_ITEM_TAX_RATE_ASSOCIATIONS`

Permanently removes specific item-tax-rate associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Associations to remove. Each tuple may contain both IDs or one side to remove all associations for that item or tax rate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Modification From Line Item

**Slug:** `CLOVER_REMOVE_MODIFICATION_FROM_LINE_ITEM`

Removes an applied modifier snapshot from an order line item. This is destructive; verify all identifiers before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Order Id |
| `line_item_id` | string | Yes | Line Item Id |
| `modification_id` | string | Yes | Clover modification id used in the documented path field 'modificationId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Order Service Charge

**Slug:** `CLOVER_REMOVE_ORDER_SERVICE_CHARGE`

Permanently removes a configured service charge or order-fee line item from an order. Verify `mode`, `order_id`, and `service_charge_id` before calling; the removal is destructive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("configured" | "order_fee") | Yes | Use `configured` to remove a charge applied through Clover's configured service-charge route; use `order_fee` to permanently remove an order-fee line item. |
| `order_id` | string | Yes | Order Id |
| `service_charge_id` | string | Yes | Configured service-charge ID or order-fee line-item ID, according to `mode`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tag Item Associations

**Slug:** `CLOVER_REMOVE_TAG_ITEM_ASSOCIATIONS`

Permanently removes specific tag-item associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Associations to remove. A one-sided tuple removes every association for that tag or item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Print Request

**Slug:** `CLOVER_SUBMIT_PRINT_REQUEST`

Queues content for the merchant's default order printer. Printing is an external side effect; verify an uncertain result before retrying.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Print event fields such as `orderRef`, `deviceRef`, `category`, `orderSnapshot`, or `printTime`; include at least one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Address For Customer

**Slug:** `CLOVER_UPDATE_ADDRESS_FOR_CUSTOMER`

Updates one postal address on an existing customer record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Address fields to change, such as `address1`, `city`, `state`, `zip`, or `country`. |
| `address_id` | string | Yes | Clover address identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Attribute

**Slug:** `CLOVER_UPDATE_ATTRIBUTE`

Updates an inventory variant attribute, including its name, item group, or option references.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update attribute body: `name`, `itemGroup` are required; optional fields include `id`, `options`. |
| `expand` | string | No | Expandable fields: [options] |
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Authorization

**Slug:** `CLOVER_UPDATE_AUTHORIZATION`

Update a payment authorization. This can alter a future charge permission; verify the current authorization and do not blindly retry an uncertain result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Authorization fields to change, such as payment reference, amount, or authorization type. |
| `authorization_id` | string | Yes | Clover authorization identifier from the documented `authId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Category

**Slug:** `CLOVER_UPDATE_CATEGORY`

Updates an inventory category's name, Register sort order, color, or item associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update category body: `name` is required; optional fields include `id`, `sortOrder`, `items`, `colorCode`. |
| `expand` | string | No | Expandable field: [items] |
| `category_id` | string | Yes | Category Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Category Sort Orders

**Slug:** `CLOVER_UPDATE_CATEGORY_SORT_ORDERS`

Updates Register menu sort positions for up to 1,000 inventory categories in one request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update category sort orders body; set at least one documented field such as `categorySortOrders`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `CLOVER_UPDATE_CUSTOMER`

Updates one customer's identity, contact, marketing, or metadata fields using the supplied values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer fields to change, such as `firstName`, `lastName`, `emailAddresses`, or `phoneNumbers`. |
| `expand` | array | No | Expand addresses, emailAddresses, phoneNumbers, cards, or metadata in the response. |
| `customer_id` | string | Yes | Unique identifier of the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Card

**Slug:** `CLOVER_UPDATE_CUSTOMER_CARD`

Updates a customer's vaulted credit or debit card record. `first6` and `last4` are required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Replacement customer card record; `first6` and `last4` are required, with optional token and cardholder fields. |
| `card_id` | string | Yes | Clover card identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Discount

**Slug:** `CLOVER_UPDATE_DISCOUNT`

Updates a merchant inventory discount's name, fixed amount, percentage, or approval reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update discount body: `name` is required; optional fields include `id`, `discount`, `approver`, `amount`. |
| `discount_id` | string | Yes | Discount Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Address For Customer

**Slug:** `CLOVER_UPDATE_EMAIL_ADDRESS_FOR_CUSTOMER`

Updates one email address on an existing customer record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Replacement customer email record; `emailAddress` is required. |
| `email_id` | string | Yes | Email identifier. |
| `customer_id` | string | Yes | Customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee

**Slug:** `CLOVER_UPDATE_EMPLOYEE`

Updates one employee's name, login, contact, or role details using the supplied fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Replacement employee fields. Clover requires name when a body is supplied. |
| `expand` | array | No | Comma-separated expandable fields: shifts, payments, orders, and roles. |
| `employee_id` | string | Yes | Employee ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inventory Item

**Slug:** `CLOVER_UPDATE_INVENTORY_ITEM`

Updates one inventory item's supplied fields. Unlike creation, this action accepts `available=false` and makes the item unavailable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update inventory item body; set at least one documented field such as `id`, `hidden`, `available`, `autoManage`, `itemGroup`. |
| `expand` | array | No | Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted] |
| `item_id` | string | Yes | Unique identifier of an item in the inventory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inventory Items

**Slug:** `CLOVER_UPDATE_INVENTORY_ITEMS`

Patches multiple existing inventory items in one request without replacing omitted fields; use Create Multiple Inventory Items for new records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update inventory items body: `items` is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item Group

**Slug:** `CLOVER_UPDATE_ITEM_GROUP`

Updates an inventory item group's name, member items, or variant attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update item group body: `name` is required; optional fields include `id`, `items`, `attributes`. |
| `expand` | array | No | Expandable fields: [items, attributes] |
| `item_group_id` | string | Yes | Item Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item Stock

**Slug:** `CLOVER_UPDATE_ITEM_STOCK`

Updates the stock quantity or low-stock alert threshold for one inventory item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update item stock body; set at least one documented field such as `item`, `stockCount`, `quantity`, `stockAlertThreshold`, `modifiedTime`. |
| `item_id` | string | Yes | Item Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Merchant

**Slug:** `CLOVER_UPDATE_MERCHANT`

Updates the connected merchant's business profile using the supplied fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update merchant body: `name`, `owner` are required; optional fields include `id`, `address`. |
| `expand` | array | No | Expandable fields: [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, equipment, equipmentSummary] |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Merchant Opening Hours

**Slug:** `CLOVER_UPDATE_MERCHANT_OPENING_HOURS`

Updates one merchant opening-hours interval, including its day and start or end time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update merchant opening hours body; set at least one documented field such as `id`, `name`, `reference`, `sunday`, `monday`. |
| `opening_hours_id` | string | Yes | Clover opening hours id used in the documented path field 'hId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Merchant Properties

**Slug:** `CLOVER_UPDATE_MERCHANT_PROPERTIES`

Updates the connected merchant's operational properties and feature settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update merchant properties body; set at least one documented field such as `merchantRef`, `defaultCurrency`, `tipsEnabled`, `receiptProperties`, `summaryHour`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Modifier

**Slug:** `CLOVER_UPDATE_MODIFIER`

Updates a modifier's name, price adjustment, or availability; Clover does not allow moving it to another modifier group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update modifier body; set at least one documented field such as `id`, `name`, `alternateName`, `available`, `price`. |
| `expand` | string | No | Expandable field: [modifierGroup] |
| `modifier_id` | string | Yes | Clover modifier id used in the documented path field 'modId'. |
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Modifier Group

**Slug:** `CLOVER_UPDATE_MODIFIER_GROUP`

Updates a modifier group's name, selection rules, or item references. Use Create Modifier to add a modifier to the group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update modifier group body; set at least one documented field such as `id`, `name`, `alternateName`, `minRequired`, `maxAllowed`. |
| `expand` | array | No | Expandable fields: [modifiers, items] |
| `modifier_group_id` | string | Yes | Modifier Group Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Modifier Group Sort Orders

**Slug:** `CLOVER_UPDATE_MODIFIER_GROUP_SORT_ORDERS`

Update the priorities for a collection of up to 200 modifier groups at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update modifier group sort orders body; set at least one documented field such as `modifierGroups`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Option

**Slug:** `CLOVER_UPDATE_OPTION`

Updates a named option within a specific inventory attribute, including its item associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update option body: `name` is required; optional fields include `id`, `attribute`, `items`. |
| `option_id` | string | Yes | Option Id |
| `attribute_id` | string | Yes | Attribute Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `CLOVER_UPDATE_ORDER`

Updates one order using the supplied order fields; omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update order body; set at least one documented field such as `id`, `currency`, `customers`, `employee`, `total`. |
| `expand` | array | No | Additional information provided as an expanded response: [lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds] |
| `order_id` | string | Yes | Order identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order Line Item

**Slug:** `CLOVER_UPDATE_ORDER_LINE_ITEM`

Updates one line item on either a standard or Multiple Service Charges order using the supplied fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Line-item fields to update for a standard or Multiple Service Charges order; include at least one. |
| `expand` | array | No | Additional information provided as an expanded response: [employee, orderType, discounts, modifications, taxRates, payments] |
| `order_id` | string | Yes | Order identifier. |
| `line_item_id` | string | Yes | Line item identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order Type

**Slug:** `CLOVER_UPDATE_ORDER_TYPE`

Updates a merchant order type's label, taxability, system classification, or category settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update order type body; set at least one documented field such as `id`, `labelKey`, `label`, `taxable`, `isDefault`. |
| `expand` | array | No | Expandable fields: [hours, attributes, categories] |
| `order_type_id` | string | Yes | Order Type Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Payment

**Slug:** `CLOVER_UPDATE_PAYMENT`

Update payment line-item allocations or the employee on an uncaptured preauthorization. Other fields are ignored. Verify the payment after an uncertain result before retrying.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Set `lineItemPayments` allocations or `employee.id` for an uncaptured preauthorization; Clover ignores other fields. |
| `payment_id` | string | Yes | Clover payment identifier from the documented `payId` path field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Phone Number For Customer

**Slug:** `CLOVER_UPDATE_PHONE_NUMBER_FOR_CUSTOMER`

Updates one phone number on an existing customer record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Replacement customer phone record; `phoneNumber` is required. |
| `phone_id` | string | Yes | Clover phone identifier. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Role

**Slug:** `CLOVER_UPDATE_ROLE`

Updates a merchant employee role's name, base system role, or employee references.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update role body: `name`, `systemRole` are required; optional fields include `id`, `employeesRef`, `merchant`. |
| `expand` | string | No | Expandable fields: [employees] |
| `role_id` | string | Yes | Clover role id used in the documented path field 'roleId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Shift

**Slug:** `CLOVER_UPDATE_SHIFT`

Updates one employee shift's clock-in/out times, cash tips, or override details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Shift fields to change, such as `inTime`, `outTime`, cash tips, or override references. |
| `expand` | array | No | Comma-separated expandable fields: employee, overrideInEmployee, and overrideOutEmployee. |
| `shift_id` | string | Yes | Employee shift ID to update. |
| `employee_id` | string | Yes | Employee ID that owns the shift. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subcategory

**Slug:** `CLOVER_UPDATE_SUBCATEGORY`

Updates a subcategory's name or color within its parent inventory category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update subcategory information body; set at least one documented field such as `name`, `colorCode`. |
| `category_id` | string | Yes | Unique identifier of the parent category. |
| `subcategory_id` | string | Yes | Unique identifier of the subcategory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `CLOVER_UPDATE_TAG`

Updates an inventory tag's name, reporting behavior, or item and printer associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update tag body: `name` is required; optional fields include `id`, `showInReporting`, `items`, `printers`. |
| `expand` | array | No | Expandable fields: [items, printers] |
| `tag_id` | string | Yes | Tag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tax Rate

**Slug:** `CLOVER_UPDATE_TAX_RATE`

Updates a merchant tax rate's name, rate, type, or default status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update tax rate body: `name` is required; optional fields include `id`, `taxType`, `rate`, `isDefault`. |
| `tax_rate_id` | string | Yes | Tax Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tender

**Slug:** `CLOVER_UPDATE_TENDER`

Updates a merchant tender's label, availability, cash-drawer, tipping, or processing settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update tender body; set at least one documented field such as `id`, `editable`, `labelKey`, `label`, `opensCashDrawer`. |
| `tender_id` | string | Yes | Tender Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tip Suggestion

**Slug:** `CLOVER_UPDATE_TIP_SUGGESTION`

Updates a merchant tip suggestion's name, percentage, flat amount, or enabled status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Update tip suggestion body; set at least one documented field such as `id`, `name`, `percentage`, `amount`, `isEnabled`. |
| `tip_suggestion_id` | string | Yes | Clover tip suggestion id used in the documented path field 'tId'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Customer Metadata

**Slug:** `CLOVER_UPSERT_CUSTOMER_METADATA`

Creates or updates a customer's note, birthday, and business-name metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Customer metadata; set at least one business name, note, or birthday field. |
| `customer_id` | string | Yes | Clover customer identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Custom Order

**Slug:** `CLOVER_UPSERT_CUSTOM_ORDER`

Creates or updates a custom order for merchants with or without Multiple Service Charges. Add line items separately; use Create Atomic Order instead when Clover should calculate inventory-based totals and taxes immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Custom-order fields such as `taxRemoved`, `note`, `title`, `state`, or `orderType`; include at least one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |