Connect AI agents to Clover

Scalekit connector

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

Tools: 120
What they doRead · write · destructive: 61 · 40 · 1961 read40 write19 destructive
Users sign in with: Access token

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Clover connection
In AgentKit > Connections, create a Clover connection. The name you give it is the connection_name your code passes. See Configure connections.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'clover'
13
const identifier = 'user_123'
14

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

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'clover_attribute_list',
27
  toolInput: { merchant_id: 'https://example.com/merchant-id' },
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "clover"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Clover:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={"merchant_id":"https://example.com/merchant-id"},
27
    tool_name="clover_attribute_list",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user opens the link once and enters their Clover credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

clover_attribute_listList item attributes (such as size or color) defined by a merchant.Read-only
List Attributes
List item attributes (such as size or color) defined by a merchant. Returns an elements array of attributes, each with id, name, itemGroup, options. Use clover_attribute_list to see variant attributes. Use clover_option_list for the values of each attribute.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, name, id, deletedTime, itemGroup.id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_cash_event_listList cash drawer events such as cash in, cash out and drawer opens for a merchant.Read-only
List Cash Events
List cash drawer events such as cash in, cash out and drawer opens for a merchant. Returns an elements array of cash events, each with type, amountChange, timestamp, note, employee, device, merchant. Use clover_cash_event_list to audit cash movements.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, device.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, note, amountChange, employee.name, type, device.id, timestamp.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_category_getGet one category by ID.Read-only
Get Category
Get one category by ID. Returns the category with id, name, sortOrder, items, colorCode, deleted, modifiedTime, canonical. Use clover_category_get when the ID is known. Get the ID from clover_category_list.
Inputs
category_idstringrequired
Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
clover_category_item_listList the inventory items in one category.Read-only
List Category Items
List the inventory items in one category. Returns an elements array of items, each with id, hidden, available, autoManage, itemGroup, options, name, alternateName. Use clover_category_item_list for a category's items. Use clover_item_category_list for an item's categories. Get the category ID from clover_category_list.
Inputs
category_idstringrequired
Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: categories, itemStock, modifierRates, options, tags, taxRates.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, sortOrder, name, colorCode, id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_category_listList the item categories defined by a merchant.Read-only
List Categories
List the item categories defined by a merchant. Returns an elements array of categories, each with id, name, sortOrder, items, colorCode, deleted, modifiedTime, canonical. Use clover_category_list to browse categories. Use clover_category_get for one.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, sortOrder, name, colorCode, id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_credit_refund_getGet a single credit refund by ID.Read-only
Get Credit Refund
Get a single credit refund by ID. Returns the credit refund with id, orderRef, device, createdTime, clientCreatedTime, credit, employee, germanInfo. Use clover_credit_refund_get when the credit refund ID is known. Get the ID from clover_credit_refund_list.
Inputs
credit_refund_idstringrequired
Clover ID of the credit refund (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: credit, germanInfo, appTracking, transactionInfo.
clover_credit_refund_listList credit refunds (refunds issued without an original payment) for a merchant.Read-only
List Credit Refunds
List credit refunds (refunds issued without an original payment) for a merchant. Returns an elements array of credit refunds, each with id, orderRef, device, tender, employee, customers, amount, taxAmount. Use clover_credit_refund_list for credits. Use clover_refund_list for refunds against payments.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: credit, germanInfo, appTracking, transactionInfo.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_customer_getGet one customer by ID, optionally expanding contact details and metadata.Read-only
Get Customer
Get one customer by ID, optionally expanding contact details and metadata. Returns the customer with id, merchant, firstName, lastName, marketingAllowed, customerSince, orders, addresses. Use clover_customer_get when the ID is known. Use clover_customer_list to search. Get the ID from clover_customer_list.
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, deletedTime.
clover_customer_listList customers, optionally filtered by name, email or phone and expanded with addresses and contact details.Read-only
List Customers
List customers, optionally filtered by name, email or phone and expanded with addresses and contact details. Returns an elements array of customers, each with id, merchant, firstName, lastName, marketingAllowed, customerSince, orders, addresses. Use clover_customer_list to search customers. Use clover_customer_get for one.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, deletedTime.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_default_service_charge_getGet the default service charge configured for a merchant.Read-only
Get Default Service Charge
Get the default service charge configured for a merchant. Returns the default service charge with id, name, enabled, percentage, percentageDecimal, isAutoApplied. Use clover_default_service_charge_get before applying a charge with clover_order_service_charge_apply.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_device_getGet one provisioned device by ID.Read-only
Get Device
Get one provisioned device by ID. Returns the device with id, name, model, merchant, orderPrefix, terminalId, terminalPrefix, serial. Use clover_device_get when the ID is known. Get the ID from clover_device_list.
Inputs
device_idstringrequired
Clover ID of the device (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_device_listList the Clover devices provisioned to a merchant.Read-only
List Devices
List the Clover devices provisioned to a merchant. Returns an elements array of devices, each with id, name, model, merchant, orderPrefix, terminalId, terminalPrefix, serial. Use clover_device_list to see the merchant's hardware. Use clover_device_get for one device.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: serial, name, merchant.id, merchant.name, deviceTypeName, model, id, deleted_time, orderPrefix.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_discount_getGet one saved discount by ID.Read-only
Get Discount
Get one saved discount by ID. Returns the discount with id, discount, approver, name, amount, percentage. Use clover_discount_get when the discount ID is known. Get the ID from clover_discount_list.
Inputs
discount_idstringrequired
Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_discount_listList the discounts saved in a merchant's catalog.Read-only
List Discounts
List the discounts saved in a merchant's catalog. Returns an elements array of discounts, each with id, discount, approver, name, amount, percentage. Use clover_discount_list for the saved discount catalog. Use clover_order_discount_list for discounts applied to an order.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: amount, modifiedtime, percentage, id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_employee_getGet one employee by ID.Read-only
Get Employee
Get one employee by ID. Returns the employee with id, name, nickname, customId, email, inviteSent, claimedTime, deletedTime. Use clover_employee_get when the ID is known. Get the ID from clover_employee_list.
Inputs
employee_idstringrequired
Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: roles, shifts.
clover_employee_listList the employees of a merchant.Read-only
List Employees
List the employees of a merchant. Returns an elements array of employees, each with id, name, nickname, customId, email, inviteSent, claimedTime, deletedTime. Use clover_employee_list to find employee IDs. Use clover_employee_get for one.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: roles, shifts.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, role, role.id, customId, name, nickname, id, deletedTime, deleted_time, email.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_employee_order_listList orders handled by one employee.Read-only
List Employee Orders
List orders handled by one employee. Returns an elements array of orders, each with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState. Use clover_employee_order_list for one employee's orders. Use clover_order_list for all orders. Get the employee ID from clover_employee_list.
Inputs
employee_idstringrequired
Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_employee_payment_listList payments taken by one employee.Read-only
List Employee Payments
List payments taken by one employee. Returns an elements array of payments, each with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount. Use clover_employee_payment_list for one employee. Use clover_payment_list for all payments. Get the employee ID from clover_employee_list.
Inputs
employee_idstringrequired
Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, employee, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_employee_shift_listList the shifts worked by one employee.Read-only
List Employee Shifts
List the shifts worked by one employee. Returns an elements array of shifts, each with id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime. Use clover_employee_shift_list for one employee. Use clover_shift_list for all. Get the employee ID from clover_employee_list.
Inputs
employee_idstringrequired
Clover ID of the employee (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, overrideInEmployee, overrideOutEmployee.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, out_time, in_time, employee.name, in_and_override_time, out_and_override_time, id, has_in_time, override_in_time, deletedTime, server_banking.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_item_category_listList the categories one inventory item belongs to.Read-only
List Item Categories
List the categories one inventory item belongs to. Returns an elements array of categories, each with id, name, sortOrder, items, colorCode, deleted, modifiedTime, canonical. Use clover_item_category_list for an item's categories. Use clover_category_item_list for a category's items. Get the item ID from clover_item_list.
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, sortOrder, name, colorCode, id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_item_getGet one inventory item by ID, optionally expanding tags, categories, tax rates and modifier groups.Read-only
Get Item
Get one inventory item by ID, optionally expanding tags, categories, tax rates and modifier groups. Returns the item with id, hidden, available, autoManage, itemGroup, options, name, alternateName. Use clover_item_get when the item ID is known. Use clover_item_list to search. Get the item ID from clover_item_list.
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options.
clover_item_group_getGet one item group by ID.Read-only
Get Item Group
Get one item group by ID. Returns the item group with id, name, items, attributes. Use clover_item_group_get when the group ID is known. Get the ID from clover_item_group_list.
Inputs
item_group_idstringrequired
Clover ID of the item group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, attributes.
clover_item_group_listList item groups (products with variants) for a merchant.Read-only
List Item Groups
List item groups (products with variants) for a merchant. Returns an elements array of item groups, each with id, name, items, attributes. Use clover_item_group_list to browse groups. Use clover_item_group_get for one group.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, attributes.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, name, id, deletedTime.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_item_listList inventory items for a merchant, optionally filtered by name, SKU or price and expanded with categories, tags or modifiers.Read-only
List Items
List inventory items for a merchant, optionally filtered by name, SKU or price and expanded with categories, tags or modifiers. Returns an elements array of inventory items, each with elements. Use clover_item_list to browse or filter the catalog. Use clover_item_get for one item.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: lowStock, modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id, isAgeRestricted, ageRestrictedType.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_item_stock_getGet the stock count for one inventory item.Read-only
Get Item Stock
Get the stock count for one inventory item. Returns the item stock with item, stockCount, quantity, stockAlertThreshold, modifiedTime. Use clover_item_stock_get for one item. Use clover_item_stock_list for all items. Get the item ID from clover_item_list.
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_item_stock_listList stock counts for all inventory items.Read-only
List Item Stocks
List stock counts for all inventory items. Returns an elements array of item stocks. Use clover_item_stock_list for all items. Use clover_item_stock_get for one item.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_item_tag_listList the tags attached to one inventory item.Read-only
List Item Tags
List the tags attached to one inventory item. Returns an elements array of tags, each with id, name, showInReporting, items, printers. Use clover_item_tag_list for one item's tags. Use clover_tag_item_list for the items under a tag. Get the item ID from clover_item_list.
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, printers.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, name, showInReporting, id.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_merchant_address_getGet a merchant's business address.Read-only
Get Merchant Address
Get a merchant's business address. Returns the address with address1, address2, address3, city, country, state, zip. Use clover_merchant_address_get for the address only. Use clover_merchant_get for the full profile.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_merchant_getGet a merchant's profile such as name, owner and settings, optionally expanded.Read-only
Get Merchant
Get a merchant's profile such as name, owner and settings, optionally expanded. Returns the merchant with id, name, reseller_id, owner, address. Use clover_merchant_get for the business profile. Use clover_merchant_address_get for the address only.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employees, bankProcessing, externalMerchant, merchantBoarding, merchantL3Prerequisite, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication, enterprises.
clover_merchant_properties_getGet a merchant's configuration properties.Read-only
Get Merchant Properties
Get a merchant's configuration properties. Returns the merchant properties with merchantRef, defaultCurrency, tipsEnabled, receiptProperties, summaryHour, signatureThreshold, hasDefaultEmployee, tipRateDefault. Use clover_merchant_properties_get for settings flags such as tip and receipt options.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_modifier_getGet one modifier by ID.Read-only
Get Modifier
Get one modifier by ID. Returns the modifier with id, name, alternateName, available, price, modifierGroup. Use clover_modifier_get when both IDs are known. Get IDs from clover_modifier_group_modifier_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
modifier_idstringrequired
Clover ID of the modifier (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
clover_modifier_group_getGet one modifier group by ID.Read-only
Get Modifier Group
Get one modifier group by ID. Returns the modifier group with id, name, alternateName, minRequired, maxAllowed, showByDefault, modifiers, modifierIds. Use clover_modifier_group_get when the ID is known. Get the ID from clover_modifier_group_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
clover_modifier_group_listList modifier groups (such as Toppings) defined by a merchant.Read-only
List Modifier Groups
List modifier groups (such as Toppings) defined by a merchant. Returns an elements array of modifier groups, each with id, name, alternateName, minRequired, maxAllowed, showByDefault, modifiers, modifierIds. Use clover_modifier_group_list to browse groups. Use clover_modifier_list for the modifiers themselves.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, category.id, negativeSortOrder, item.id, sortOrder, name, id, showByDefault.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_modifier_group_modifier_listList the modifiers inside one modifier group.Read-only
List Modifiers in Group
List the modifiers inside one modifier group. Returns an elements array of modifiers, each with id, name, alternateName, available, price, modifierGroup. Use clover_modifier_group_modifier_list for one group. Use clover_modifier_list for all. Get the group ID from clover_modifier_group_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, price, name, alternateName, id, modifierGroup.id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_modifier_listList all modifiers across a merchant's modifier groups.Read-only
List Modifiers
List all modifiers across a merchant's modifier groups. Returns an elements array of modifiers, each with id, name, alternateName, available, price, modifierGroup. Use clover_modifier_list for every modifier. Use clover_modifier_group_modifier_list for one group.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, price, name, alternateName, id, modifierGroup.id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_opening_hours_getGet one set of opening hours by ID.Read-only
Get Opening Hours
Get one set of opening hours by ID. Returns the opening hours set with id, name, reference, sunday, monday, tuesday, wednesday, thursday. Use clover_opening_hours_get when the ID is known. Get the ID from clover_opening_hours_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
opening_hours_idstringrequired
Clover ID of the opening hours (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_opening_hours_listList the sets of opening hours defined for a merchant.Read-only
List Opening Hours
List the sets of opening hours defined for a merchant. Returns an elements array of opening hours sets, each with id, name, reference, sunday, monday, tuesday, wednesday, thursday. Use clover_opening_hours_list to see all schedules. Use clover_opening_hours_get for one.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_option_listList attribute options (such as Small or Red) defined by a merchant.Read-only
List Options
List attribute options (such as Small or Red) defined by a merchant. Returns an elements array of options, each with id, name, attribute, items. Use clover_option_list for attribute values. Use clover_attribute_list for the attributes themselves.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: options.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, item.id, name, attribute.id, id, deletedTime.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_order_discount_listList the discounts applied to an order.Read-only
List Order Discounts
List the discounts applied to an order. Returns an elements array of order discounts, each with id, discount, approver, name, amount, percentage. Use clover_order_discount_list for discounts on the whole order. Use clover_discount_list for the merchant's discount catalog. Get the order ID from clover_order_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_order_getGet a single order by ID, optionally expanding line items, payments, discounts and customers.Read-only
Get Order
Get a single order by ID, optionally expanding line items, payments, discounts and customers. Returns the order with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState. Use clover_order_get when the order ID is known. Use clover_order_list to search. Get the order ID from clover_order_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
clover_order_line_item_getGet a single line item on an order.Read-only
Get Order Line Item
Get a single line item on an order. Returns the line item with id, item, colorCode, name, alternateName, price, priceWithModifiers, priceWithModifiersAndItemAndOrderDiscounts. Use clover_order_line_item_get for one known line item. Use clover_order_line_item_list for all of them. Get IDs from clover_order_line_item_list.
Inputs
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, orderType, discounts, modifications, taxRates, payments.
clover_order_line_item_listList the line items on an order.Read-only
List Order Line Items
List the line items on an order. Returns an elements array of line items, each with id, item, colorCode, name, alternateName, price, priceWithModifiers, priceWithModifiersAndItemAndOrderDiscounts. Use clover_order_line_item_list to see everything on an order. Use clover_order_line_item_get for one line item. Get the order ID from clover_order_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, orderType, discounts, modifications, taxRates, payments.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_order_listList orders for a merchant, optionally filtered by time, state or amount and expanded with related records.Read-only
List Orders
List orders for a merchant, optionally filtered by time, state or amount and expanded with related records. Returns an elements array of orders, each with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState. Use clover_order_list to browse or filter orders. Use clover_order_get for one known order and clover_employee_order_list for one employee's orders.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, payments, refunds, credits, voids, payment.tender, payment.cardTransaction, lineItems, customers, serviceCharge, discounts, orderType, lineItems.discounts, lineItems.modifications.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, note, modifiedTime, orderType, touched, cardTransaction.last4, manualTransaction, employee.name, title, device.id, externalReferenceId, clientCreatedTime, total, payType, testMode, createdTime, id, state, deletedTime.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_order_payment_listList the payments recorded on one order.Read-only
List Order Payments
List the payments recorded on one order. Returns an elements array of payments, each with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount. Use clover_order_payment_list for one order. Use clover_payment_list for all payments. Get the order ID from clover_order_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, employee, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_order_type_getGet one order type by ID.Read-only
Get Order Type
Get one order type by ID. Returns the order type with id, labelKey, label, taxable, isDefault, filterCategories, isHidden, fee. Use clover_order_type_get when the ID is known. Get the ID from clover_order_type_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_type_idstringrequired
Clover ID of the order type (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: hours, attributes, categories.
clover_order_type_listList a merchant's order types such as dine in or take out.Read-only
List Order Types
List a merchant's order types such as dine in or take out. Returns an elements array of order types, each with id, labelKey, label, taxable, isDefault, filterCategories, isHidden, fee. Use clover_order_type_list to find order type IDs for clover_order_create.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: hours, attributes, categories.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: id, deletedTime.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_payment_getGet a single payment by ID.Read-only
Get Payment
Get a single payment by ID. Returns the payment with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount. Use clover_payment_get when the payment ID is known. Use clover_payment_list to search. Get the payment ID from clover_payment_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
payment_idstringrequired
Clover ID of the payment (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, employee, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
clover_payment_listList payments for a merchant, optionally filtered by time, amount or result.Read-only
List Payments
List payments for a merchant, optionally filtered by time, amount or result. Returns an elements array of payments, each with id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount. Use clover_payment_list for merchant-wide payments. Use clover_order_payment_list for one order and clover_payment_get for one payment.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_refund_getGet a single refund by ID.Read-only
Get Refund
Get a single refund by ID. Returns the refund with id, orderRef, device, amount, taxAmount, tipAmount, createdTime, clientCreatedTime. Use clover_refund_get when the refund ID is known. Get the refund ID from clover_refund_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
refund_idstringrequired
Clover ID of the refund (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems, transactionInfo, oceanGatewayInfo.
clover_refund_listList refunds issued by a merchant.Read-only
List Refunds
List refunds issued by a merchant. Returns an elements array of refunds, each with id, orderRef, device, amount, taxAmount, tipAmount, createdTime, clientCreatedTime. Use clover_refund_list for refunds against payments. Use clover_credit_refund_list for credits issued without a payment.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems, transactionInfo, oceanGatewayInfo.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: API filtering documentation.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_shift_getGet one shift by ID.Read-only
Get Shift
Get one shift by ID. Returns the shift with id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime. Use clover_shift_get when the ID is known. Get the ID from clover_shift_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
shift_idstringrequired
Clover ID of the shift (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, overrideInEmployee, overrideOutEmployee.
clover_shift_listList employee shifts across a merchant.Read-only
List Shifts
List employee shifts across a merchant. Returns an elements array of shifts, each with id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime. Use clover_shift_list for every employee. Use clover_employee_shift_list for one employee.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, overrideInEmployee, overrideOutEmployee.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: employee.id, out_time, in_time, employee.name, in_and_override_time, out_and_override_time, id, has_in_time, override_in_time, deletedTime, server_banking.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_tag_getGet one tag by ID.Read-only
Get Tag
Get one tag by ID. Returns the tag with id, name, showInReporting, items, printers. Use clover_tag_get when the ID is known. Get the ID from clover_tag_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tag_idstringrequired
Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, printers.
clover_tag_item_listList the inventory items carrying one tag.Read-only
List Tag Items
List the inventory items carrying one tag. Returns an elements array of items, each with id, hidden, available, autoManage, itemGroup, options, name, alternateName. Use clover_tag_item_list for the items under a tag. Use clover_item_tag_list for the tags on an item. Get the tag ID from clover_tag_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tag_idstringrequired
Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, printers.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, hidden, itemCode, available, option.id, alternateName, isRevenue, modifierGroup.id, autoManage, deleted, item.id, price, name, itemStock.quantity, id, sku, defaultTaxRates, itemGroup.id.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_tag_listList the tags defined by a merchant.Read-only
List Tags
List the tags defined by a merchant. Returns an elements array of tags, each with id, name, showInReporting, items, printers. Use clover_tag_list to browse tags. Use clover_tag_get for one.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, printers.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, deleted, name, showInReporting, id.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_tax_rate_getGet one tax rate by ID.Read-only
Get Tax Rate
Get one tax rate by ID. Returns the tax rate with id, name, taxType, rate, isDefault, items, taxAmount, deletedTime. Use clover_tax_rate_get when the ID is known. Get the ID from clover_tax_rate_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tax_rate_idstringrequired
Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
clover_tax_rate_item_listList the inventory items that use one tax rate.Read-only
List Items by Tax Rate
List the inventory items that use one tax rate. Returns an elements array of items, each with id, hidden, available, autoManage, itemGroup, options, name, alternateName. Use clover_tax_rate_item_list to see items under a tax rate. Use clover_tax_rate_item_associate to change the links. Get the tax rate ID from clover_tax_rate_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tax_rate_idstringrequired
Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id.
limitinteger
Maximum number of records to return. Defaults to 100 and cannot exceed 1000.
offsetinteger
Number of records to skip, for paging through large result sets together with limit.
clover_tax_rate_listList the tax rates configured for a merchant.Read-only
List Tax Rates
List the tax rates configured for a merchant. Returns an elements array of tax rates, each with id, name, taxType, rate, isDefault, items, taxAmount, deletedTime. Use clover_tax_rate_list to browse tax rates. Use clover_tax_rate_get for one.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: isDefault, rate, items.id, name, id, taxAmount, taxType.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_tender_getGet one tender by ID.Read-only
Get Tender
Get one tender by ID. Returns the tender with id, editable, labelKey, label, opensCashDrawer, supportsTipping, enabled, visible. Use clover_tender_get when the ID is known. Get the ID from clover_tender_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tender_idstringrequired
Clover ID of the tender (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_tender_listList the tenders (payment methods such as cash or card) a merchant accepts.Read-only
List Tenders
List the tenders (payment methods such as cash or card) a merchant accepts. Returns an elements array of tenders, each with id, editable, labelKey, label, opensCashDrawer, supportsTipping, enabled, visible. Use clover_tender_list to find tender IDs for clover_order_payment_create.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: modifiedTime, visible, merchantId, instruction, systemTenderId, label, id, labelKey, opensCashDrawer, deletedTime, enabled.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_tip_suggestion_listList the tip suggestions configured for a merchant.Read-only
List Tip Suggestions
List the tip suggestions configured for a merchant. Returns an elements array of tip suggestions, each with id, name, percentage, amount, isEnabled, flatTip. Use clover_tip_suggestion_list to see the tip presets shown at checkout.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
filterstring
Filter expression such as modifiedTime>1700000000000 or total>1000, using =, >=, <=, >, < or !=. Send one comparison per call. Filterable fields: flatTip, percentage, name, id, enabled.
limitinteger
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000.
offsetinteger
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
clover_atomic_order_checkoutCalculate the totals and taxes for an order cart without creating the order.Write
Get Atomic Order Checkout
Calculate the totals and taxes for an order cart without creating the order. Returns the calculated order totals with orderCart, total, subtotal, totalTaxAmount, taxSummaries, isVat. Use clover_atomic_order_checkout to preview totals before creating an order. Use clover_atomic_order_create to actually create the order. Get inventory item IDs from clover_item_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_cartobject
Order cart to put items, discounts, modifications and order-related information. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
clover_atomic_order_createCreate an order with line items from Clover inventory in a single call, with totals and taxes calculated by Clover.Write
Create Atomic Order
Create an order with line items from Clover inventory in a single call, with totals and taxes calculated by Clover. Returns the order with calculated totals with id, currency, customers, employee, total, externalReferenceId, unpaidBalance, paymentState. Use clover_atomic_order_create for inventory-based orders. Use clover_order_create for custom orders without line items. Get inventory item IDs from clover_item_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_cartobject
Order cart to put items, discounts, modifications and order-related information. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
clover_category_createCreate an item category with a name and optional sort order or color.Write
Create Category
Create an item category with a name and optional sort order or color. Returns a success response; the Clover reference documents no response body for this call. Use clover_category_create to add a category.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
The name of the category which will appear in Clover Register App.
color_codestring
Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
itemsarray
Ordered list of items associated with this category. Provide a JSON array of objects.
sort_orderinteger
Integer used to determine how this category is sorted against other categories.
clover_category_item_associateCreate or delete links between inventory items and categories in one call.Write
Associate Items with Categories
Create or delete links between inventory items and categories in one call. Returns the association results with item, category. Use clover_category_item_associate to move items in or out of categories. Get IDs from clover_category_list and clover_item_list.
Inputs
elementsarrayrequired
Array of category-item associations. Example: [{"category": {"id": "{categoryId}"}, "item": {"id": "{item1Id}"}}, {"category": {"id": "{categoryId}"}, "item": {"id": "{item2Id}"}}].
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
deleteboolean
Use to view, create, or remove an association between items and categories in the request body. Values: True - Set to true to remove the association. False - Set to false to create an association.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
clover_category_updateUpdate the name, sort order or color of a category.Write
Update Category
Update the name, sort order or color of a category. Returns a success response; the Clover reference documents no response body for this call. Use clover_category_update to change a category. Get the ID from clover_category_list.
- Idempotent
Inputs
category_idstringrequired
Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
The name of the category which will appear in Clover Register App.
color_codestring
Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
itemsarray
Ordered list of items associated with this category. Provide a JSON array of objects.
sort_orderinteger
Integer used to determine how this category is sorted against other categories.
clover_customer_address_createAdd a postal address to a customer.Write
Create Customer Address
Add a postal address to a customer. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_address_create to add an address. Get the customer ID from clover_customer_list.
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
address1string
Customer's address, line one.
address2string
Customer's address, line two.
address3string
Customer's address, line three.
citystring
Customer's city.
countrystring
Customer's country.
statestring
Customer's state.
zipstring
Postal code of the customer's address.
clover_customer_createCreate a customer record with a name and optional contact details.Write
Create Customer
Create a customer record with a name and optional contact details. Returns the new customer with id, firstName, lastName, marketingAllowed, customerSince, metadata. Use clover_customer_create to add a customer. Use the phone, email and address tools to add details later.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
addressesarray
Customer's mailing and shipping address. This information is displayed on invoices emailed to the customer. Note: Address must contain a value Length: Maximum 127 characters. Provide a JSON array of objects.
customer_sinceinteger
Date since when the customer is associated with the merchant.
email_addressesarray
Customer's email address. Provide a JSON array of objects.
expandstring
Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
first_namestring
First name of the customer. Length: Maximum 64 characters.
last_namestring
Last name of the customer. Length: Maximum 64 characters.
marketing_allowedboolean
Indicates whether the customer allows marketing communication from Clover. Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.
phone_numbersarray
Customer phone numbers. Provide a JSON array of objects.
clover_customer_email_address_createAdd an email address to a customer.Write
Create Customer Email Address
Add an email address to a customer. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_email_address_create to add an email. Get the customer ID from clover_customer_list.
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
email_addressstringrequired
Email address of the customer. Note: A valid email address is required. Email address domains are validated using the Apache Domain Validator. Customer email addresses are validated using the Apache Email Validator.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
primary_emailboolean
Customer's primary email address.
clover_customer_metadata_saveCreate or update a customer's business name, note and birthday.Write
Save Customer Metadata
Create or update a customer's business name, note and birthday. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_metadata_save for notes and birthday. Use clover_customer_update for name and marketing preference. Get the customer ID from clover_customer_list.
- Idempotent
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
business_namestring
Name of customer's business. Note: Length of the business name cannot be more than 127 characters.
dob_dayinteger
Day of the customer’s date of birth.
dob_monthinteger
Month of the customer’s date of birth.
dob_yearinteger
Optional. Year of the customer’s date of birth.
notestring
Additional information about the customer. Note: Length of the note cannot be more than 2000 characters.
clover_customer_phone_number_createAdd a phone number to a customer.Write
Create Customer Phone Number
Add a phone number to a customer. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_phone_number_create to add a number. Get the customer ID from clover_customer_list.
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
phone_numberstringrequired
Customer's phone number.
clover_customer_updateUpdate a customer's name or marketing preference.Write
Update Customer
Update a customer's name or marketing preference. Returns the updated customer with id, firstName, lastName, marketingAllowed, customerSince, metadata. Use clover_customer_update to change core customer fields. Use clover_customer_metadata_save for notes and birthday. Get the ID from clover_customer_list.
- Idempotent
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
addressesarray
Customer's mailing and shipping address. This information is displayed on invoices emailed to the customer. Note: Address must contain a value. Length: Maximum 127 characters. Provide a JSON array of objects.
customer_sinceinteger
Date since when the customer is associated with the merchant.
email_addressesarray
Customer's email address. Provide a JSON array of objects.
expandstring
Comma-separated list of related records to include in the response. Allowed values: addresses, emailAddresses, phoneNumbers, cards, metadata.
first_namestring
First name of the customer. Length: Maximum 64 characters.
last_namestring
Last name of the customer. Length: Maximum 64 characters.
marketing_allowedboolean
Indicates whether the customer allows marketing communication from Clover. Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.
phone_numbersarray
Customer phone numbers. Provide a JSON array of objects.
clover_discount_createCreate a saved discount with a name and either a fixed amount or a percentage.Write
Create Discount
Create a saved discount with a name and either a fixed amount or a percentage. Returns a success response; the Clover reference documents no response body for this call. Use clover_discount_create to add to the discount catalog.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the discount.
amountinteger
Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
approverobject
The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
percentageinteger
Discount amount in percent.
clover_discount_updateUpdate the name, amount or percentage of a saved discount.Write
Update Discount
Update the name, amount or percentage of a saved discount. Returns a success response; the Clover reference documents no response body for this call. Use clover_discount_update to change a catalog discount. Get the ID from clover_discount_list.
- Idempotent
Inputs
discount_idstringrequired
Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the discount.
amountinteger
Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
approverobject
The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
percentageinteger
Discount amount in percent.
clover_item_bulk_createCreate several inventory items in one call.Write
Bulk Create Items
Create several inventory items in one call. Returns the created items with items. Use clover_item_bulk_create for many items. Use clover_item_create for one.
Inputs
itemsarrayrequired
Array of inventory items. Provide a JSON array of objects.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_item_createCreate an inventory item with a name, price and optional SKU, code or tax settings.Write
Create Item
Create an inventory item with a name, price and optional SKU, code or tax settings. Returns the new item with id, name, price, priceType, hidden, available, modifiedTime, isAgeRestricted. Use clover_item_create for one item. Use clover_item_bulk_create for many.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Item name.
priceintegerrequired
Price of the item based on the merchant's local currency and price type, such as fixed, variable, or per unit price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents.
alternate_namestring
Alternate name of the item.
auto_manageboolean
Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False - Item availability is manually managed.
availableboolean
Indicates whether the inventory item is available for sale across all channels, including point of sale (POS) devices, customer-facing kiosks, and online ordering websites.
codestring
Item product code, such as Universal Product Code (UPC) or European Article Number (EAN).
color_codestring
Hex code of the color assigned to the category and its items. Format: #fff, #ffffff, or #ffffffff.
costinteger
Cost of the item to a merchant as compared to the price payable by the customer, for example: wholesale versus retail price.
default_tax_ratesboolean
Indicates whether or not to use the default tax rate.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted.
hiddenboolean
Indicates whether the inventory item is hidden on the Register app.
is_age_restrictedboolean
Set to true to create an age-restricted item. If true, ageRestrictedObj must also be provided.
is_revenueboolean
Indicates whether this item is counted as revenue, for example: gift cards and donations are not counted as revenue.
price_typestring
Price type, such as fixed, variable, or per unit price.one of FIXEDVARIABLEPER_UNIT
price_without_vatinteger
Item price without value-added tax (VAT). For non-VAT merchants, this field is not used. For VAT merchants, this field is the base price of an item.
skustring
Stock keeping unit (SKU).
stock_countinteger
Deprecated. Use itemStock.
unit_namestring
Unit of measurement for the item, such as pound or meter.
clover_item_group_createCreate an item group used to organize variants of one product.Write
Create Item Group
Create an item group used to organize variants of one product. Returns a success response; the Clover reference documents no response body for this call. Use clover_item_group_create to start a variant group.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the option.
attributesarray
Attributes that belong to this group. Provide a JSON array of objects.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, attributes.
itemsarray
Items that are members of this group. Provide a JSON array of objects.
clover_item_group_updateUpdate the name of an item group.Write
Update Item Group
Update the name of an item group. Returns a success response; the Clover reference documents no response body for this call. Use clover_item_group_update to rename a group. Get the ID from clover_item_group_list.
- Idempotent
Inputs
item_group_idstringrequired
Clover ID of the item group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the option.
attributesarray
Attributes that belong to this group. Provide a JSON array of objects.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, attributes.
itemsarray
Items that are members of this group. Provide a JSON array of objects.
clover_item_modifier_group_associateCreate or delete links between inventory items and modifier groups in one call.Write
Associate Items with Modifier Groups
Create or delete links between inventory items and modifier groups in one call. Returns the association results with item, modifierGroups. Use clover_item_modifier_group_associate to attach or detach modifier groups on items. Get IDs from clover_modifier_group_list and clover_item_list.
Inputs
itemobjectrequired
The item value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_groupobjectrequired
The modifier group value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
deleteboolean
Use to view, create, or delete an association between inventory items and modifier groups in the request body. Values: True - Set to true to delete the association. False - Set to false to create an association.
clover_item_stock_createStart tracking stock for an inventory item with an initial quantity and alert threshold.Write
Create Item Stock
Start tracking stock for an inventory item with an initial quantity and alert threshold. Returns the item stock with item, stockCount, quantity, stockAlertThreshold, modifiedTime. Use clover_item_stock_create to begin tracking. Use clover_item_stock_update to change an existing count. Get the item ID from clover_item_list.
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
quantitynumberrequired
Initial count of this item in stock.
stock_alert_thresholdnumber
The quantity threshold at which a low stock alert is triggered.
clover_item_stock_updateSet the stock quantity and alert threshold for an item that already has stock tracking.Write
Update Item Stock
Set the stock quantity and alert threshold for an item that already has stock tracking. Returns a success response; the Clover reference documents no response body for this call. Use clover_item_stock_update if stock already exists. Use clover_item_stock_create to start tracking stock. Get the item ID from clover_item_list.
- Idempotent
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
quantitynumber
Current count of this item in stock.
stock_alert_thresholdnumber
The quantity threshold at which a low stock alert is triggered. Only appears if the Low Stock Alert feature is enabled.
stock_countinteger
Deprecated, use quantity instead.
clover_item_updateUpdate fields on an inventory item such as name, price, SKU or availability.Write
Update Item
Update fields on an inventory item such as name, price, SKU or availability. Returns the updated item with id, hidden, available, autoManage, itemGroup, options, name, alternateName. Use clover_item_update to change an item. Use clover_item_stock_update to change stock counts. Get the item ID from clover_item_list.
- Idempotent
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
alternate_namestring
Alternate name of the item.
auto_manageboolean
Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False - Item availability is manually managed.
availableboolean
Indicates whether the inventory item is available for sale across all channels.
codestring
Item product code, such as Universal Product Code (UPC) or European Article Number (EAN).
color_codestring
Hex code of the color assigned to the category and its items. Format: #fff, #ffffff, or #ffffffff.
costinteger
Cost of the item to a merchant as compared to the price payable by the customer, for example: wholesale versus retail price.
default_tax_ratesboolean
Indicates whether or not to use the default tax rate.
expandstring
Comma-separated list of related records to include in the response. Allowed values: tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted.
hiddenboolean
Indicates whether the inventory item is hidden on the Register app.
is_age_restrictedboolean
Set to true to make the item age-restricted, or false to remove the restriction. If setting to true, ageRestrictedObj must also be provided.
is_revenueboolean
Indicates whether this item is counted as revenue, for example: gift cards and donations are not counted as revenue.
namestring
Item name.
priceinteger
Price of the item. Use price type and merchant currency to determine the actual item price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents.
price_typestring
Price type, such as fixed, variable, or per unit price.one of FIXEDVARIABLEPER_UNIT
price_without_vatinteger
Item price without value-added tax (VAT). For non-VAT merchants, this field is not used. For VAT merchants, this field is the base price of an item.
skustring
Stock keeping unit (SKU).
unit_namestring
Unit of measurement for the item, such as pound or meter.
clover_modifier_createCreate a modifier inside a modifier group with a name and price.Write
Create Modifier
Create a modifier inside a modifier group with a name and price. Returns a success response; the Clover reference documents no response body for this call. Use clover_modifier_create to add an option to a group. Get the group ID from clover_modifier_group_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
alternate_namestring
Alternate name of the modifier.
availableboolean
Indicates whether the modifier is available for sale across all channels, including point of sale (POS) devices, customer-facing kiosks, and online ordering websites.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
namestring
Name of the modifier.
priceinteger
Additional cost when used.
clover_modifier_group_createCreate a modifier group with a name and minimum and maximum selections.Write
Create Modifier Group
Create a modifier group with a name and minimum and maximum selections. Returns a success response; the Clover reference documents no response body for this call. Use clover_modifier_group_create to add a group, then add modifiers with clover_modifier_create.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the modifier group.
alternate_namestring
Alternate name of the modifier group.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
max_allowedinteger
Maximum number modifiers from this group that can be applied to associated lineItems when using the Register merchant plan.
min_requiredinteger
Minimum number of modifiers from this group that must be applied to associated lineItems when using the Register merchant plan.
modifiersarray
The modifiers value. Provide a JSON array of objects.
show_by_defaultboolean
Indicates whether employees receive an automatic message to add modifiers from this group when using the Register merchant plan.
sort_orderinteger
Sorted list (ascending or descending) that indicates the ranking of the modifier group as compared to other modifier groups.
clover_modifier_group_updateUpdate the name or selection limits of a modifier group.Write
Update Modifier Group
Update the name or selection limits of a modifier group. Returns a success response; the Clover reference documents no response body for this call. Use clover_modifier_group_update to change a group. Get the ID from clover_modifier_group_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
alternate_namestring
The alternate name value.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifiers, items.
max_allowedinteger
The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register.
min_requiredinteger
The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register.
modifiersarray
The modifiers value. Provide a JSON array of objects.
namestring
Name of the modifier group.
show_by_defaultboolean
Whether employees will be automatically prompted to add modifiers from this category when using Register.
sort_orderinteger
The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.
clover_modifier_updateUpdate the name, price or availability of a modifier.Write
Update Modifier
Update the name, price or availability of a modifier. Returns a success response; the Clover reference documents no response body for this call. Use clover_modifier_update to change a modifier. Get IDs from clover_modifier_group_modifier_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
modifier_idstringrequired
Clover ID of the modifier (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
alternate_namestring
Alternate name of the modifier.
availableboolean
True if this modifier is available across all channels.
expandstring
Comma-separated list of related records to include in the response. Allowed values: modifierGroup.
namestring
Name of the modifier.
priceinteger
Additional cost when used.
clover_order_createCreate an empty custom order (no line items) for a merchant.Write
Create Order
Create an empty custom order (no line items) for a merchant. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_create for orders built from non-Clover inventory, then add items with clover_order_line_item_create. Use clover_atomic_order_create to create an order with Clover inventory items in one call.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
client_created_timeinteger
Time when the client created the order.
customersarray
List of customers associated with this order. Provide a JSON array of objects.
employeeobject
Employee who took this order. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
external_reference_idstring
External reference identifier, if associated with the order.
group_line_itemsboolean
Indicates whether similar line items are grouped together on the order receipt based on matching values for properties, such as price, modifiers, and discounts.
manual_transactionboolean
Indicates a manual transaction for the order. In a manual transaction: An arbitrary amount is defined and not associated with any inventory items. For example, the Clover Sale app and Clover Manual Transaction app create manual transactions. A single line item is associated to hold the sale amount, but the generated receipt displays this differently to indicate the order is not a typical order with inventory items.
notestring
Information about the order that may be printed on the order receipt and displayed in apps.
order_typeobject
The order type value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
pay_typestring
During the payment flow: If the user chooses to split the payment for the order, this field is set to one of the Split values to indicate how to split the full amount. If the user chooses to pay for the order in full with one payment, then this field value is Full.one of SPLIT_GUESTSPLIT_ITEMSPLIT_CUSTOMFULL
statestring
Order state, for example open or locked. When creating an order through the REST API, Clover recommends setting it to open.
tax_removedboolean
Indicates whether tax is removed and is not applicable to the order.
test_modeboolean
Indicates whether this order was created in test mode. Payments made against test orders are not processed. You can delete test mode orders from the Orders App on the merchant's device or web dashboard. Test mode orders are also deleted when the device sends a POST to the /v2/merchant/{mId}/orders/delete_all_tests endpoint.
titlestring
Title of the order, shown on receipts and in apps.
clover_order_discount_createApply a discount to an entire order, either by amount or percentage or from a saved discount.Write
Create Order Discount
Apply a discount to an entire order, either by amount or percentage or from a saved discount. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_discount_create for order-level discounts. Use clover_order_line_item_discount_create for a single line item. Get the order ID from clover_order_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the discount.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
amountinteger
Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
approverobject
The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
discountobject
If this item is based on a standard discount, this will point to the appropriate inventory.Discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
percentageinteger
Discount amount in percent.
clover_order_line_item_createAdd a line item to an order, either from a Clover inventory item or as a custom named item with a price.Write
Create Order Line Item
Add a line item to an order, either from a Clover inventory item or as a custom named item with a price. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_create to add one item. Use clover_order_line_items_bulk_create to add many at once. Get the order ID from clover_order_list and any item ID from clover_item_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
alternate_namestring
Alternate name of the line item.
bin_namestring
The bin name value.
is_revenueboolean
True if this item should be counted as revenue, for example gift cards and donations would not.
itemobject
A reference to the inventory item that was used to create this line item. Note that since this a reference the item can be changed and deleted any time such that it no longer matches this line item. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
modificationsarray
List of references to modifications applied to this line item. Provide a JSON array of objects.
namestring
Line item name.
notestring
The note value.
priceinteger
Price of the item, typically in cents of merchant currency. When unit quantity is not null then this is the price for a single unit and is not the complete price.
printedboolean
True if this line item has been printed out on an order printer at least once already.
tax_ratesarray
Tax rates that apply to this line item. Provide a JSON array of objects.
unit_namestring
Unit name (e.g. oz, lb, etc) if priced by unit, otherwise null.
unit_qtyinteger
This is applicable only if the item is priced by quantity of a unit. The item must have a priceType of PER_UNIT. The value is a fixed-point integer with scaling factor of 1000 (e.g. if charging per ounce, the value should be set to 2500 for 2.5 ounces). To compute the complete price perform the following calculation: PRICE * (UNIT QTY / 1000). If the item doesn’t have a priceType of PER_UNIT, then unitQty is ignored.
user_datastring
The user data value.
clover_order_line_item_discount_createApply a discount to one line item on an order.Write
Create Line Item Discount
Apply a discount to one line item on an order. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_discount_create for item-level discounts. Use clover_order_discount_create for the whole order. Get IDs from clover_order_line_item_list.
Inputs
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Name of the discount.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
amountinteger
Discount amount in fraction of currency unit (e.g. cents) based on currency fraction digits supported.
approverobject
The person that authorized a discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
discountobject
If this item is based on a standard discount, this will point to the appropriate inventory.Discount. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
percentageinteger
Discount amount in percent.
clover_order_line_item_modification_createApply a modifier (for example extra cheese) to a line item.Write
Apply Line Item Modification
Apply a modifier (for example extra cheese) to a line item. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_modification_create to attach a modifier to a line item. Get modifier IDs from clover_modifier_list and line item IDs from clover_order_line_item_list.
Inputs
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
alternate_namestring
The alternate name value.
amountinteger
the additional cost of the modifier when it was applied.
modifierobject
The modifier object. Values from the Modifier are copied to the Modification at the time that the order is placed. Modifier values may change after the modification is created. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
namestring
the name of the modifier when it was applied.
quantity_soldinteger
This is only used in reports. The count of how many of these modifiers that were sold.
clover_order_line_item_updateUpdate the note, printed flag, bin name or user data on an order line item.Write
Update Order Line Item
Update the note, printed flag, bin name or user data on an order line item. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_update to annotate a line item. Use clover_order_line_item_delete to void it. Get IDs from clover_order_line_item_list.
- Idempotent
Inputs
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
bin_namestring
Bank identification number.
expandstring
Comma-separated list of related records to include in the response. Allowed values: employee, orderType, discounts, modifications, taxRates, payments.
notestring
Information related to the line item.
printedboolean
Indicates whether the line item has been printed at least once on the order printer.
user_datastring
User information.
clover_order_line_items_bulk_createAdd several line items to an order in one call.Write
Bulk Create Order Line Items
Add several line items to an order in one call. Returns the created line items with items. Use clover_order_line_items_bulk_create to add many items. Use clover_order_line_item_create for a single one. Get the order ID from clover_order_list.
Inputs
itemsarrayrequired
Array of line items. Provide a JSON array of objects.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_payment_createRecord a payment (for example cash or an external tender) against an order.Write
Create Order Payment
Record a payment (for example cash or an external tender) against an order. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_payment_create to record a payment on an order. It does not charge a card. Get the order ID from clover_order_list and the tender ID from clover_tender_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
amountinteger
Total amount paid.
cash_tenderedinteger
Payment amount given by the customer.
cashback_amountinteger
Cash amount given by the customer to the merchant.
client_created_timeinteger
Time when payment was recorded on the client server.
deviceobject
Device that processed the transaction for this payment, a 128-bit Universal unique identifier. Note: its not the 13-digits Clover identifier.
employeeobject
Employee who processed the payment. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
external_payment_idstring
External payment identifier.
external_reference_idstring
External reference identifier (ID) if associated with the payment.
offlineboolean
Indicates if the tender option is offline.
tax_amountinteger
Tax amount paid.
tenderobject
Tender type associated with this payment. For example: credit card, cash, and so on. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
tip_amountinteger
Tip amount paid.
clover_order_service_charge_applyApply a service charge to an order.Write
Apply Order Service Charge
Apply a service charge to an order. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_service_charge_apply to add a service charge. Use clover_order_service_charge_remove to take it off. Get the order ID from clover_order_list.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
enabledboolean
Indicates if this service charge is enabled.
is_auto_appliedboolean
Indicates service charge was auto applied or not.
namestring
Service charge name.
percentageinteger
Deprecated use percentage decimal instead.
percentage_decimalinteger
Percent to charge times 10000, for example, 12.5% will be 125000.
clover_order_updateUpdate fields on an existing order such as title, note, state or order type.Write
Update Order
Update fields on an existing order such as title, note, state or order type. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_update to change an order's own fields. Use clover_order_line_item_update to change a line item. Get the order ID from clover_order_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
client_created_timeinteger
Time at which the client created this order.
currencystring
Three-letter ISO 4217 currency code. Format: Lower case Length: Maximum 3.
customersarray
List of customers associated with this order. Provide a JSON array of objects.
employeeobject
The employee who took this order. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
expandstring
Comma-separated list of related records to include in the response. Allowed values: lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds.
external_reference_idstring
External reference id if present in the order.
group_line_itemsboolean
Whether similar line items should be grouped together on the receipt that this order generates. Item "similarity" is based on items having matching values for a set of properties including price, modifiers, and discounts.
manual_transactionboolean
Whether this order represents a manual transaction. A manual transaction is a transaction that has an arbitrary amount defined and is not associated with any inventory items. For example, the Clover Sale App and Clover Manual Transaction App create manual transactions. A manual transactions will have a single associated line item to hold the sale amount, but the generated receipt will display this differently to.
notestring
An arbitrary string with information about this order, may be printed on the order receipt and displayed in apps.
order_typeobject
The order type value. Provide a JSON object, for example {"id": "ABC123DEF4567"} for a reference to an existing record.
pay_typestring
Possible values: SPLIT_GUEST, SPLIT_ITEM, SPLIT_CUSTOM, FULL. During the payment flow, if the user chooses to split the payment for this order, this field will be set to one of the SPLIT_* values to indicate how the full amount should be split. If the user chooses to pay for the order in full with one payment, then this field will be FULL.one of SPLIT_GUESTSPLIT_ITEMSPLIT_CUSTOMFULL
statestring
Order state, for example open or locked. When creating an order through the REST API, Clover recommends setting it to open.
tax_removedboolean
If true then this order should not have taxes applied to it.
test_modeboolean
Whether this order was created in test mode. Payments made against test orders are not processed. Test mode orders can be deleted from the Orders App on the merchant's device or web dashboard (https://www.clover.com/orders/m/{mId}/orders). They will also be deleted when the device sends a POST to the /v2/merchant/{mId}/orders/delete_all_tests endpoint.
titlestring
Title of the order, shown on receipts and in apps.
clover_tag_createCreate a tag used to label inventory items.Write
Create Tag
Create a tag used to label inventory items. Returns a success response; the Clover reference documents no response body for this call. Use clover_tag_create to add a tag.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Tag name.
itemsarray
Items associated with this tag. Provide a JSON array of objects.
show_in_reportingboolean
True if tag is a summary label in the reporting app.
clover_tag_updateUpdate the name or reporting flag of a tag.Write
Update Tag
Update the name or reporting flag of a tag. Returns a success response; the Clover reference documents no response body for this call. Use clover_tag_update to change a tag. Get the ID from clover_tag_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
Tag name.
tag_idstringrequired
Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items, printers.
itemsarray
Items associated with this tag. Provide a JSON array of objects.
show_in_reportingboolean
True if tag is a summary label in the reporting app.
clover_tax_rate_createCreate a tax rate with a name and a rate.Write
Create Tax Rate
Create a tax rate with a name and a rate. Returns the new tax rate with id, name, taxType, rate, isDefault, items, taxAmount, deletedTime. Use clover_tax_rate_create to add a tax rate.
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
The name value.
expandstring
Comma-separated list of related records to include in the response. Allowed values: items.
is_defaultboolean
The is default value.
itemsarray
Items associated with this tax rate. Provide a JSON array of objects.
rateinteger
For percentage based discounts like sales tax.
tax_typestring
Tax type used in Argentina.one of VAT_TAXABLEVAT_NON_TAXABLEVAT_EXEMPTINTERNAL_TAXPARTNER_TAX
clover_tax_rate_item_associateCreate or delete links between tax rates and inventory items in one call.Write
Associate Tax Rates with Items
Create or delete links between tax rates and inventory items in one call. Returns the association results with taxRate, item. Use clover_tax_rate_item_associate to attach or detach tax rates on items. Get IDs from clover_tax_rate_list and clover_item_list.
Inputs
elementsarrayrequired
An array of item and tax rate associations. Provide a JSON array of objects.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
deleteboolean
Use to view, create, or remove an association between items and tax rates in the request body. Values: True - Set to true to remove the association. False - Set to false to create an association.
clover_tax_rate_updateUpdate the name, rate or default flag of a tax rate.Write
Update Tax Rate
Update the name, rate or default flag of a tax rate. Returns a success response; the Clover reference documents no response body for this call. Use clover_tax_rate_update to change a tax rate. Get the ID from clover_tax_rate_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
namestringrequired
The name value.
tax_rate_idstringrequired
Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
is_defaultboolean
The is default value.
itemsarray
Items associated with this tax rate. Provide a JSON array of objects.
rateinteger
For percentage based discounts like sales tax.
tax_typestring
Tax type used in Argentina.one of VAT_TAXABLEVAT_NON_TAXABLEVAT_EXEMPTINTERNAL_TAXPARTNER_TAX
clover_category_deleteDelete an item category.Destructive
Delete Category
Delete an item category. Returns a success response; the Clover reference documents no response body for this call. Use clover_category_delete to remove a category. Get the ID from clover_category_list.
- Idempotent
Inputs
category_idstringrequired
Clover ID of the category (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_customer_address_deleteRemove a postal address from a customer.Destructive
Delete Customer Address
Remove a postal address from a customer. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_address_delete to remove an address. Get IDs from clover_customer_get with expand addresses.
- Idempotent
Inputs
address_idstringrequired
Clover ID of the address (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_customer_deleteDelete a customer record.Destructive
Delete Customer
Delete a customer record. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_delete to remove a customer. Get the ID from clover_customer_list.
- Idempotent
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_customer_email_address_deleteRemove an email address from a customer.Destructive
Delete Customer Email Address
Remove an email address from a customer. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_email_address_delete to remove an email. Get IDs from clover_customer_get with expand emailAddresses.
- Idempotent
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
email_idstringrequired
Clover ID of the email (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_customer_phone_number_deleteRemove a phone number from a customer.Destructive
Delete Customer Phone Number
Remove a phone number from a customer. Returns a success response; the Clover reference documents no response body for this call. Use clover_customer_phone_number_delete to remove a number. Get IDs from clover_customer_get with expand phoneNumbers.
- Idempotent
Inputs
customer_idstringrequired
Clover ID of the customer (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
phone_idstringrequired
Clover ID of the phone (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_discount_deleteDelete a saved discount.Destructive
Delete Discount
Delete a saved discount. Returns a success response; the Clover reference documents no response body for this call. Use clover_discount_delete to remove a catalog discount. Get the ID from clover_discount_list.
- Idempotent
Inputs
discount_idstringrequired
Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_item_deleteDelete an inventory item.Destructive
Delete Item
Delete an inventory item. Returns a success response; the Clover reference documents no response body for this call. Use clover_item_delete to remove an item. Use clover_item_update with hidden set to true to hide it instead. Get the item ID from clover_item_list.
- Idempotent
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_item_group_deleteDelete an item group.Destructive
Delete Item Group
Delete an item group. Returns a success response; the Clover reference documents no response body for this call. Use clover_item_group_delete to remove a group. Get the ID from clover_item_group_list.
- Idempotent
Inputs
item_group_idstringrequired
Clover ID of the item group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_item_stock_deleteStop tracking stock for an inventory item.Destructive
Delete Item Stock
Stop tracking stock for an inventory item. Returns a success response; the Clover reference documents no response body for this call. Use clover_item_stock_delete to remove stock tracking. Get the item ID from clover_item_list.
- Idempotent
Inputs
item_idstringrequired
Clover ID of the item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
clover_modifier_deleteDelete a modifier from a modifier group.Destructive
Delete Modifier
Delete a modifier from a modifier group. Returns a success response; the Clover reference documents no response body for this call. Use clover_modifier_delete to remove a modifier. Get IDs from clover_modifier_group_modifier_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
modifier_idstringrequired
Clover ID of the modifier (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_modifier_group_deleteDelete a modifier group.Destructive
Delete Modifier Group
Delete a modifier group. Returns a success response; the Clover reference documents no response body for this call. Use clover_modifier_group_delete to remove a group. Get the ID from clover_modifier_group_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modifier_group_idstringrequired
Clover ID of the modifier group (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_deleteDelete an order permanently.Destructive
Delete Order
Delete an order permanently. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_delete only for orders that should be removed. Use clover_order_update to change an order's state instead. Get the order ID from clover_order_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_discount_deleteRemove a discount from an order.Destructive
Delete Order Discount
Remove a discount from an order. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_discount_delete to undo an order-level discount. Get the discount ID from clover_order_discount_list.
- Idempotent
Inputs
discount_idstringrequired
Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_line_item_deleteVoid (delete) a line item from an order.Destructive
Void Order Line Item
Void (delete) a line item from an order. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_delete to remove one line item. Use clover_order_delete to remove the whole order. Get IDs from clover_order_line_item_list.
- Idempotent
Inputs
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_line_item_discount_deleteRemove a discount from a line item.Destructive
Delete Line Item Discount
Remove a discount from a line item. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_discount_delete to undo an item-level discount. Get IDs from clover_order_get with expand lineItems.discounts.
- Idempotent
Inputs
discount_idstringrequired
Clover ID of the discount (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_line_item_modification_deleteRemove a modification from a line item.Destructive
Remove Line Item Modification
Remove a modification from a line item. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_line_item_modification_delete to undo a modifier on a line item. Get IDs from clover_order_line_item_list.
- Idempotent
Inputs
line_item_idstringrequired
Clover ID of the line item (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
modification_idstringrequired
Clover ID of the modification (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_order_service_charge_removeRemove a service charge from an order.Destructive
Remove Order Service Charge
Remove a service charge from an order. Returns a success response; the Clover reference documents no response body for this call. Use clover_order_service_charge_remove to undo clover_order_service_charge_apply. Get the order ID from clover_order_list.
- Idempotent
Inputs
charge_idstringrequired
Clover ID of the charge (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
order_idstringrequired
Clover ID of the order (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_tag_deleteDelete a tag.Destructive
Delete Tag
Delete a tag. Returns a success response; the Clover reference documents no response body for this call. Use clover_tag_delete to remove a tag. Get the ID from clover_tag_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tag_idstringrequired
Clover ID of the tag (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.
clover_tax_rate_deleteDelete a tax rate.Destructive
Delete Tax Rate
Delete a tax rate. Returns a success response; the Clover reference documents no response body for this call. Use clover_tax_rate_delete to remove a tax rate. Get the ID from clover_tax_rate_list.
- Idempotent
Inputs
merchant_idstringrequired
Clover merchant ID (mId) the request applies to. Find it in the Clover Merchant Dashboard URL or in Settings > Account & Setup.
tax_rate_idstringrequired
Clover ID of the tax rate (an alphanumeric string such as ABC123DEF4567). Use the matching list tool to find it.

Setup

Install the SDK

Set your credentials

Create the Clover connection

Authorize a user and make your first call

Tools

Call it

Returns

List Attributes

Inputs

List Cash Events

Inputs

Get Category

Inputs

List Category Items

Inputs

List Categories

Inputs

Get Credit Refund

Inputs

List Credit Refunds

Inputs

Get Customer

Inputs

List Customers

Inputs

Get Default Service Charge

Inputs

Get Device

Inputs

List Devices

Inputs

Get Discount

Inputs

List Discounts

Inputs

Get Employee

Inputs

List Employees

Inputs

List Employee Orders

Inputs

List Employee Payments

Inputs

List Employee Shifts

Inputs

List Item Categories

Inputs

Get Item

Inputs

Get Item Group

Inputs

List Item Groups

Inputs

List Items

Inputs

Get Item Stock

Inputs

List Item Stocks

Inputs

List Item Tags

Inputs

Get Merchant Address

Inputs

Get Merchant

Inputs

Get Merchant Properties

Inputs

Get Modifier

Inputs

Get Modifier Group

Inputs

List Modifier Groups

Inputs

List Modifiers in Group

Inputs

List Modifiers

Inputs

Get Opening Hours

Inputs