- Category: commerce
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? No
- Tools: 209
- Triggers: 0
- Slug:
CLOVER - Version: 20261101_00
Tools
Apply Modification To Line Item
Apply Modification To Line Item
Apply Order Service Charge
Apply Order Service Charge
CLOVER_APPLY_ORDER_SERVICE_CHARGEApplies a configured merchant service charge or creates an ad-hoc order-fee line item on an order. Choose mode explicitly so Clover receives the matching body and route.Input Parameters
mode determines which body schema is validated. For configured, provide the configured charge id and optional overrides. For order_fee, provide line-item fields such as item, name, price, or orderFee. Fields outside the selected schema are rejected.configured to apply an existing merchant service charge by ID; use order_fee to create an ad-hoc order-fee line item.Output
Checkout Atomic Order
Checkout Atomic Order
Create Address For Customer
Create Address For Customer
Create App Billing Metered Event
Create App Billing Metered Event
Create Atomic Order
Create Atomic Order
Create Attribute
Create Attribute
Create Customer
Create Customer
CLOVER_CREATE_CUSTOMERCreates a customer record for the connected merchant with the supplied identity and contact details.Input Parameters
firstName, lastName, emailAddresses, or phoneNumbers; include at least one.Output
Create Customer Card
Create Customer Card
Create Discount
Create Discount
Create Discount On Line Item
Create Discount On Line Item
Create Discount On Order
Create Discount On Order
Create Email Address For Customer
Create Email Address For Customer
Create Employee
Create Employee
CLOVER_CREATE_EMPLOYEECreates a merchant employee profile with a required name and optional login, contact, and role details.Input Parameters
Output
Create Inventory Item
Create Inventory Item
CLOVER_CREATE_INVENTORY_ITEMCreates an inventory item. Clover ignores available=false during creation and creates the item as available; call Update Inventory Item afterward to make it unavailable.Input Parameters
name, price are required; optional fields include id, hidden, available, autoManage.Output
Create Item Category
Create Item Category
Create Item Category Associations
Create Item Category Associations
Create Item Group
Create Item Group
Create Item Modifier Group Associations
Create Item Modifier Group Associations
CLOVER_CREATE_ITEM_MODIFIER_GROUP_ASSOCIATIONSCreates an association between an inventory item and a modifier group so the group’s modifiers can be applied to that item. Provide both modifierGroup.id and item.id.Input Parameters
modifierGroup.id and item.id are required.Output
Create Item Option Associations
Create Item Option Associations
Create Item Stock
Create Item Stock
Create Item Tax Rate Associations
Create Item Tax Rate Associations
Create Merchant Opening Hours
Create Merchant Opening Hours
CLOVER_CREATE_MERCHANT_OPENING_HOURSCreates merchant opening hours. Supply all seven weekday arrays and use an empty array for every closed day; for example, {'sunday': [], 'monday': [{'start': 900, 'end': 1700}], 'tuesday': [], 'wednesday': [], 'thursday': [], 'friday': [], 'saturday': []}.Input Parameters
{'sunday': [], 'monday': [{'start': 900, 'end': 1700}], 'tuesday': [], 'wednesday': [], 'thursday': [], 'friday': [], 'saturday': []}.Output
Create Modifier
Create Modifier
Create Modifier Group
Create Modifier Group
Create Multiple Inventory Items
Create Multiple Inventory Items
Create Notification For App
Create Notification For App
Create Notification For Device
Create Notification For Device
Create Option
Create Option
Create Order Line Item
Create Order Line Item
Create Order Line Items Bulk
Create Order Line Items Bulk
Create Order Type Category Associations
Create Order Type Category Associations
Create Order Type For Merchant
Create Order Type For Merchant
CLOVER_CREATE_ORDER_TYPE_FOR_MERCHANTCreates a custom order type for the merchant, such as dine-in, delivery, or takeout.Input Parameters
id, labelKey, label, taxable, isDefault.Output
Create Payment Record On Order
Create Payment Record On Order
Create Phone Number For Customer
Create Phone Number For Customer
Create Role
Create Role
Create Shift For Employee
Create Shift For Employee
Create Subcategory
Create Subcategory
Create Tag
Create Tag
Create Tag Item Associations
Create Tag Item Associations
Create Tax Rate
Create Tax Rate
Create Tender
Create Tender
Delete All Line Items In Order
Delete All Line Items In Order
Delete App Billing Metered Event
Delete App Billing Metered Event
Delete Attribute
Delete Attribute
Delete Categories
Delete Categories
CLOVER_DELETE_CATEGORIESPermanently deletes the categories identified by a comma-separated list of category IDs. Get IDs from List Categories and target only categories you intend to delete.Input Parameters
Output
Delete Customer
Delete Customer
Delete Customer Address
Delete Customer Address
Delete Customer Card
Delete Customer Card
Delete Customer Email Address
Delete Customer Email Address
Delete Customer Phone Number
Delete Customer Phone Number
Delete Employee
Delete Employee
Delete Inventory Discount
Delete Inventory Discount
Delete Inventory Item
Delete Inventory Item
Delete Item Category
Delete Item Category
Delete Item Group
Delete Item Group
Delete Item Stock
Delete Item Stock
Delete Line Item Discount
Delete Line Item Discount
Delete Merchant Opening Hours
Delete Merchant Opening Hours
Delete Modifier
Delete Modifier
Delete Modifier Group
Delete Modifier Group
Delete Modifier Groups
Delete Modifier Groups
CLOVER_DELETE_MODIFIER_GROUPSPermanently deletes the modifier groups identified by a comma-separated list of IDs, including every modifier in those groups. Get IDs from List Modifier Groups.Input Parameters
Output
Delete Multiple Inventory Items
Delete Multiple Inventory Items
CLOVER_DELETE_MULTIPLE_INVENTORY_ITEMSPermanently deletes the inventory items identified by a comma-separated list of item IDs. Get IDs from List Inventory Items and target only intended items.Input Parameters
Output
Delete Option
Delete Option
Delete Order
Delete Order
Delete Order Discount
Delete Order Discount
Delete Order Line Item
Delete Order Line Item
Delete Order Type
Delete Order Type
Delete Role
Delete Role
Delete Shift
Delete Shift
Delete Subcategory
Delete Subcategory
Delete Tag
Delete Tag
Delete Tax Rate
Delete Tax Rate
Delete Tender
Delete Tender
Exchange Order Line Item
Exchange Order Line Item
CLOVER_EXCHANGE_ORDER_LINE_ITEMCreates a replacement line item under the client-supplied line_item_id and exchanges old_line_item_id for it. Provide price or item.id; Clover’s required matching body ID is supplied automatically.Input Parameters
price or item.id. Clover creates this replacement using line_item_id and exchanges the old line item for it.Output
Export Customers Csv
Export Customers Csv
CLOVER_EXPORT_CUSTOMERS_CSVRequests a CSV export of customers for the connected merchant. Use filter to select matching customers and expand to include selected related address, contact, card, or metadata fields.Input Parameters
Output
Export Shifts CSV
Export Shifts CSV
Get App Billing Metered Event
Get App Billing Metered Event
Get Attribute
Get Attribute
Get Category
Get Category
Get Configured Service Charge
Get Configured Service Charge
Get Credit Refund
Get Credit Refund
Get Customer
Get Customer
Get Default Service Charge
Get Default Service Charge
Get Device Provisioned To Merchant
Get Device Provisioned To Merchant
Get Discount
Get Discount
Get Employee
Get Employee
Get Inventory Item
Get Inventory Item
Get Item Group
Get Item Group
Get Item Stock
Get Item Stock
Get Item Subcategory Associations
Get Item Subcategory Associations
Get Legacy Sync Token
Get Legacy Sync Token
CLOVER_GET_LEGACY_SYNC_TOKENRetrieves a provider-deprecated table sync token only for a downstream legacy Clover sync consumer that explicitly requires it. Normal list and filter tools do not produce this token. Clover documents the route, but the sandbox route is known to return 404 in some environments.Input Parameters
Output
Get Merchant
Get Merchant
CLOVER_GET_MERCHANTReturns the connected merchant’s business profile and requested related resources.Input Parameters
Output
Get Merchant Address
Get Merchant Address
Get Merchant App Billing Information
Get Merchant App Billing Information
Get Merchant Opening Hours
Get Merchant Opening Hours
Get Merchant Payment Gateway Configuration
Get Merchant Payment Gateway Configuration
Get Merchant Properties
Get Merchant Properties
Get Modifier
Get Modifier
Get Modifier Group
Get Modifier Group
Get Option For Attribute
Get Option For Attribute
Get Order
Get Order
Get Order Line Item
Get Order Line Item
Get Order Type
Get Order Type
Get Payment
Get Payment
Get Print Event
Get Print Event
Get Refund
Get Refund
Get Role
Get Role
Get Service Charge Applied To Order
Get Service Charge Applied To Order
Get Shift
Get Shift
Get Tag
Get Tag
Get Tax Exemption Rule
Get Tax Exemption Rule
Get Tax Rate
Get Tax Rate
Get Tender
Get Tender
Get Tip Suggestion
Get Tip Suggestion
Get Voided Line Item Totals
Get Voided Line Item Totals
List App Billing Metered Events
List App Billing Metered Events
List Attributes
List Attributes
CLOVER_LIST_ATTRIBUTESLists inventory variant attributes, such as size or color. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Cash Events
List Cash Events
CLOVER_LIST_CASH_EVENTSList cash events for the merchant, one device, or one employee. Select context and provide context_id for device or employee requests.Input Parameters
merchant for all merchant events, device for one device, or employee for one employee.Output
List Categories
List Categories
CLOVER_LIST_CATEGORIESLists inventory categories in Register sort order, optionally with associated items. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Categories Of Item
List Categories Of Item
CLOVER_LIST_CATEGORIES_OF_ITEMRetrieves all categories of an item. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Category Subcategories
List Category Subcategories
List Configured Service Charges
List Configured Service Charges
CLOVER_LIST_CONFIGURED_SERVICE_CHARGESLists service charges configured for the merchant; use the applied-service-charge tools for charges already attached to an order.Input Parameters
Output
List Credit Refunds
List Credit Refunds
List Customers
List Customers
List Devices Provisioned To Merchant
List Devices Provisioned To Merchant
List Discounts
List Discounts
CLOVER_LIST_DISCOUNTSLists the merchant’s inventory discounts. Returns one caller-selected offset page; request successive offsets until elements is empty.Input Parameters
Output
List Discounts For Order
List Discounts For Order
List Employee Orders
List Employee Orders
CLOVER_LIST_EMPLOYEE_ORDERSLists one employee’s orders through Clover’s exact /employees/{empId}/orders route, which requires Read employees, while preserving a caller-supplied custom filter. Use List Orders instead for the merchant /orders route and its Read orders permission.Input Parameters
Output
List Employees
List Employees
List Inventory Items
List Inventory Items
CLOVER_LIST_INVENTORY_ITEMSLists inventory items for the connected merchant. Returns one caller-selected offset page; increase offset by the page size until elements is empty.Input Parameters
Output
List Inventory Without Revenue Class
List Inventory Without Revenue Class
CLOVER_LIST_INVENTORY_WITHOUT_REVENUE_CLASSLists inventory items that have no revenue-class tag. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Item Groups
List Item Groups
CLOVER_LIST_ITEM_GROUPSLists item groups used to organize related inventory variants and attributes. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Items By Tax Rate
List Items By Tax Rate
CLOVER_LIST_ITEMS_BY_TAX_RATELists inventory items associated with the specified tax rate.Input Parameters
Output
List Items For Tag
List Items For Tag
CLOVER_LIST_ITEMS_FOR_TAGLists inventory items associated with one tag.Input Parameters
Output
List Items In Category
List Items In Category
CLOVER_LIST_ITEMS_IN_CATEGORYRetrieves all items in a category. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Items In Modifier Group
List Items In Modifier Group
CLOVER_LIST_ITEMS_IN_MODIFIER_GROUPRetrieves a list of all items in a single modifier group. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Item Stocks
List Item Stocks
List Merchant Opening Hours
List Merchant Opening Hours
List Modifier Groups
List Modifier Groups
CLOVER_LIST_MODIFIER_GROUPSLists modifier groups that organize selectable item modifiers. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Modifiers
List Modifiers
CLOVER_LIST_MODIFIERSRetrieves all modifiers from all modifier groups. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Modifiers In Modifier Group
List Modifiers In Modifier Group
CLOVER_LIST_MODIFIERS_IN_MODIFIER_GROUPRetrieves a list of modifiers in a single modifier group. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Options
List Options
CLOVER_LIST_OPTIONSLists options across all inventory variant attributes. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Options For Attribute
List Options For Attribute
CLOVER_LIST_OPTIONS_FOR_ATTRIBUTERetrieves all available variants or options associated with an attribute. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Order Line Items
List Order Line Items
List Orders
List Orders
CLOVER_LIST_ORDERSLists orders through Clover’s merchant /orders route with filtering, expansion, and offset pagination; OAuth requires Read orders. When employee_id is set, its employee filter replaces any custom filter.Input Parameters
Note: Search results for the list of orders list is restricted to the last 90 days if the filter fields include: [deletedTime, externalReferenceId, createdTime, total, payType, title, note, state, manualTransaction, cardTransaction.last4, testMode, touched]Output
List Order Types
List Order Types
CLOVER_LIST_ORDER_TYPESLists merchant-defined order types and their system-type or category settings. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Payments
List Payments
CLOVER_LIST_PAYMENTSList payments for the merchant, one order, or one employee. Select context and provide context_id for order or employee requests.Input Parameters
merchant, order, or employee.Output
List Refunds
List Refunds
CLOVER_LIST_REFUNDSList merchant refunds, including taxes and tips. Clover returns at most 90 days and automatically narrows wider time filters to the most recent 90 days.Input Parameters
Output
List Roles
List Roles
CLOVER_LIST_ROLESRetrieves all system and employee roles for a merchant’s business. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Service Charges Applied To Order
List Service Charges Applied To Order
List Shifts
List Shifts
CLOVER_LIST_SHIFTSList shifts for the connected merchant or, when employee_id is provided, for one employee. Filters, expansions, and offset pagination apply to either route.Input Parameters
Output
List System Order Types
List System Order Types
List Tag Item Associations
List Tag Item Associations
List Tax Exemption Rules
List Tax Exemption Rules
List Tax Rates
List Tax Rates
CLOVER_LIST_TAX_RATESLists percentage and flat-amount tax rates. Returns one offset page; continue until elements is empty.Input Parameters
Output
List Tenders
List Tenders
CLOVER_LIST_TENDERSRetrieves all tenders for a merchant. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
List Tip Suggestions
List Tip Suggestions
CLOVER_LIST_TIP_SUGGESTIONSRetrieves all tip suggestions for a merchant, for example: flat tip or percentage. Returns one caller-selected offset page; request another offset until elements is empty.Input Parameters
Output
Record Voided Line Items
Record Voided Line Items
Remove Item Category Associations
Remove Item Category Associations
CLOVER_REMOVE_ITEM_CATEGORY_ASSOCIATIONSPermanently removes specific item-category associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.Input Parameters
category.id to remove all items from that category, or only item.id to remove all categories from that item.Output
Remove Item Modifier Group Associations
Remove Item Modifier Group Associations
CLOVER_REMOVE_ITEM_MODIFIER_GROUP_ASSOCIATIONSPermanently removes a specific item-modifier-group association or all associations on one supplied side. Review one-sided bodies carefully because they can remove many links.Input Parameters
Output
Remove Item Option Associations
Remove Item Option Associations
CLOVER_REMOVE_ITEM_OPTION_ASSOCIATIONSPermanently removes specific option-item associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.Input Parameters
Output
Remove Item Tax Rate Associations
Remove Item Tax Rate Associations
CLOVER_REMOVE_ITEM_TAX_RATE_ASSOCIATIONSPermanently removes specific item-tax-rate associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.Input Parameters
Output
Remove Modification From Line Item
Remove Modification From Line Item
Remove Order Service Charge
Remove Order Service Charge
CLOVER_REMOVE_ORDER_SERVICE_CHARGEPermanently removes a configured service charge or order-fee line item from an order. Verify mode, order_id, and service_charge_id before calling; the removal is destructive.Input Parameters
configured to remove a charge applied through Clover’s configured service-charge route; use order_fee to permanently remove an order-fee line item.Output
Remove Tag Item Associations
Remove Tag Item Associations
CLOVER_REMOVE_TAG_ITEM_ASSOCIATIONSPermanently removes specific tag-item associations or all associations on one supplied side. Review one-sided tuples carefully because they can remove many links.Input Parameters
Output
Submit Print Request
Submit Print Request
CLOVER_SUBMIT_PRINT_REQUESTQueues content for the merchant’s default order printer. Printing is an external side effect; verify an uncertain result before retrying.Input Parameters
orderRef, deviceRef, category, orderSnapshot, or printTime; include at least one.Output
Update Address For Customer
Update Address For Customer
Update Attribute
Update Attribute
Update Category
Update Category
Update Category Sort Orders
Update Category Sort Orders
Update Customer
Update Customer
Update Customer Card
Update Customer Card
Update Discount
Update Discount
Update Email Address For Customer
Update Email Address For Customer
Update Employee
Update Employee
Update Inventory Item
Update Inventory Item
CLOVER_UPDATE_INVENTORY_ITEMUpdates one inventory item’s supplied fields. Unlike creation, this action accepts available=false and makes the item unavailable.Input Parameters
id, hidden, available, autoManage, itemGroup.Output
Update Inventory Items
Update Inventory Items
Update Item Group
Update Item Group
Update Item Stock
Update Item Stock
Update Merchant
Update Merchant
CLOVER_UPDATE_MERCHANTUpdates the connected merchant’s business profile using the supplied fields.Input Parameters
Output
Update Merchant Opening Hours
Update Merchant Opening Hours
Update Merchant Properties
Update Merchant Properties
Update Modifier
Update Modifier
Update Modifier Group
Update Modifier Group
Update Modifier Group Sort Orders
Update Modifier Group Sort Orders
Update Option
Update Option
Update Order
Update Order
CLOVER_UPDATE_ORDERUpdates one order using the supplied order fields; omitted fields remain unchanged.Input Parameters
id, currency, customers, employee, total.Output
Update Order Line Item
Update Order Line Item
CLOVER_UPDATE_ORDER_LINE_ITEMUpdates one line item on either a standard or Multiple Service Charges order using the supplied fields.Input Parameters
Output
Update Order Type
Update Order Type
Update Payment
Update Payment
CLOVER_UPDATE_PAYMENTUpdate payment line-item allocations or the employee on an uncaptured preauthorization. Other fields are ignored. Verify the payment after an uncertain result before retrying.Input Parameters
lineItemPayments allocations or employee.id for an uncaptured preauthorization; Clover ignores other fields.Output
Update Phone Number For Customer
Update Phone Number For Customer
Update Role
Update Role
Update Shift
Update Shift
Update Subcategory
Update Subcategory
Update Tag
Update Tag
Update Tax Rate
Update Tax Rate
Update Tender
Update Tender
Update Tip Suggestion
Update Tip Suggestion
Upsert Customer Metadata
Upsert Customer Metadata
Upsert Custom Order
Upsert Custom Order
CLOVER_UPSERT_CUSTOM_ORDERCreates or updates a custom order for merchants with or without Multiple Service Charges. Add line items separately; use Create Atomic Order instead when Clover should calculate inventory-based totals and taxes immediately.Input Parameters
taxRemoved, note, title, state, or orderType; include at least one.