Add Clover to your AI agent

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Retrieve one Clover payment authorization by identifier.

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

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

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

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

Returns the merchant's default configured service charge.

Returns one Clover device provisioned to the connected merchant.

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

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

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

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

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

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

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

Returns the connected merchant's business address.

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

Returns one merchant opening-hours interval by identifier.

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

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

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

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

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

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

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

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

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

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

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

Returns one merchant employee role and its base system role.

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

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

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

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

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

Returns one merchant tender and its payment-handling settings.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Lists inventory tags associated with one item.

Lists inventory items associated with the specified tax rate.

Lists inventory items associated with one tag.

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

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

Lists the connected merchant's opening-hours intervals.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Updates one postal address on an existing customer record.

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

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

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

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

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

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

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

Updates one email address on an existing customer record.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Updates one phone number on an existing customer record.

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

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

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

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

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

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

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

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

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