Skip to main content
Clover logo
  • Category: commerce
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 209
  • Triggers: 0
  • Slug: CLOVER
  • Version: 20261101_00

Tools

Slug: CLOVER_APPLY_MODIFICATION_TO_LINE_ITEMApplies a modifier to an order line item and snapshots the modifier’s current name and price as a modification record.

Input Parameters

object
required
Modification snapshot; set at least one documented field such as modifier, name, amount, or quantitySold.
string
required
Order Id
string
required
Line Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CHECKOUT_ATOMIC_ORDERCalculates and previews an order cart, including totals, taxes, discounts, and service charges, without persisting an order.

Input Parameters

object
required
Checkout atomic order body; set at least one documented field such as orderCart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ADDRESS_FOR_CUSTOMERAdds a postal address to an existing customer record; it does not create the customer.

Input Parameters

object
required
Customer address; set at least one of address1, city, state, zip, or country.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_APP_BILLING_METERED_EVENTRecords metered app usage and bills the merchant at the configured price; count defaults to 1. This is irreversible, so verify an uncertain result before retrying to avoid billing twice.

Input Parameters

integer
Number of metered events to bill. Clover defaults to 1 when omitted.
string
required
App Id
string
required
Metered Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ATOMIC_ORDERCreates an order with line items, modifiers, discounts, and service charges while Clover calculates inventory-based totals and taxes. Maximum 3,000 line items.

Input Parameters

object
required
Create atomic order body; set at least one documented field such as orderCart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ATTRIBUTECreates an inventory variant attribute within an item group, optionally with its initial options.

Input Parameters

object
required
Create attribute body: name, itemGroup are required; optional fields include id, options.
string
Expand options in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_AUTHORIZATION_ON_PAYMENTCreate an authorization for a payment. This has financial consequences and is not safely retryable without first checking whether Clover created the authorization.

Input Parameters

object
required
Authorization to create. Required fields: payment.id, positive amount, and type (TAB or AUTH).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_CUSTOMERCreates a customer record for the connected merchant with the supplied identity and contact details.

Input Parameters

object
required
New customer fields such as firstName, lastName, emailAddresses, or phoneNumbers; include at least one.
array
Related fields to expand in the response. Select one or more of addresses, emailAddresses, phoneNumbers, cards, and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_CUSTOMER_CARDCreates a vaulted credit or debit card record for a customer. first6 and last4 are required.

Input Parameters

object
required
Customer card record; first6 and last4 are required, with optional token and cardholder fields.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_DISCOUNTCreates a merchant inventory discount with a fixed amount or percentage for later application.

Input Parameters

object
required
Create discount body: name is required; optional fields include id, discount, approver, amount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_DISCOUNT_ON_LINE_ITEMApplies a named fixed-amount or percentage discount to one order line item.

Input Parameters

object
required
Create discount on line item body: name is required; optional fields include id, discount, approver, amount.
string
required
Order Id
string
required
Line Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_DISCOUNT_ON_ORDERApplies a named fixed-amount or percentage discount to an order subtotal, not a specific line item.

Input Parameters

object
required
Create discount on order body: name is required; optional fields include id, discount, approver, amount.
string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_EMAIL_ADDRESS_FOR_CUSTOMERAdds an email address to an existing customer record; it does not create the customer.

Input Parameters

object
required
Customer email record; emailAddress is required.
string
required
Customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_EMPLOYEECreates a merchant employee profile with a required name and optional login, contact, and role details.

Input Parameters

object
required
Employee fields to send to Clover. The employee name is required when a body is supplied.
array
Related fields to expand in the response. Select one or more of shifts, payments, orders, and roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ITEM_CATEGORYCreates an inventory category used to organize items in Clover Register.

Input Parameters

object
required
Create item category body: name is required; optional fields include id, sortOrder, items, colorCode.
string
Expand items in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ITEM_CATEGORY_ASSOCIATIONSCreates one or more associations between inventory items and categories or subcategories. Every tuple requires both category.id and item.id.

Input Parameters

object
required
Category-item tuples to create; elements is required and every tuple requires both IDs.
string
Expand items in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ITEM_GROUPCreates an item group for related inventory variants and their attributes.

Input Parameters

object
required
Create item group body: name is required; optional fields include id, items, attributes.
array
Related fields to expand in the response. Select items, attributes, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Item-modifier-group association to create; both modifierGroup.id and item.id are required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ITEM_OPTION_ASSOCIATIONSCreates one or more associations between Clover options and inventory items. Every tuple requires both option.id and item.id.

Input Parameters

object
required
Option-item tuples to create; every tuple requires both IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ITEM_STOCKCreates the stock quantity and optional low-stock alert threshold for one inventory item.

Input Parameters

object
required
Initial stock quantity and optional low-stock alert threshold.
string
required
Unique identifier of an item in the inventory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ITEM_TAX_RATE_ASSOCIATIONSCreates one or more associations between inventory items and tax rates. Every tuple requires both item.id and taxRate.id.

Input Parameters

object
required
Item-tax-rate tuples to create; elements is required and every tuple requires both IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_MODIFIERCreates a named modifier with a price adjustment inside a specific modifier group.

Input Parameters

object
required
Create modifier body; set at least one documented field such as id, name, alternateName, available, price.
string
Expand modifierGroup in the response.
string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_MODIFIER_GROUPCreates a new modifier group. After you create a modifier group, you can associate modifiers with the group.

Input Parameters

object
required
Create modifier group body: name is required; optional fields include id, alternateName, minRequired, maxAllowed.
array
Related fields to expand in the response. Select modifiers, items, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_MULTIPLE_INVENTORY_ITEMSCreates multiple inventory items in one request; use Update Inventory Items to patch existing items instead.

Input Parameters

object
required
Create multiple inventory items body: items is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_NOTIFICATION_FOR_APPSend a message to devices that have the connected Clover app installed and are listening for notifications. Delivery is irreversible and cannot be recalled; verify an uncertain result before retrying to avoid duplicate delivery.

Input Parameters

object
required
App notification fields; set event, data (up to 4000 characters), or timeToLive.
string
required
App Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_NOTIFICATION_FOR_DEVICEPush a message to a device that has the connected Clover app installed and is listening for notifications. Delivery is irreversible and cannot be recalled; verify an uncertain result before retrying to avoid duplicate delivery.

Input Parameters

object
required
Device notification fields; set event, data (up to 4000 characters), or timeToLive.
string
required
App Id
string
required
Device Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_OPTIONCreates a named option within an inventory attribute, such as Small for a Size attribute.

Input Parameters

object
required
Create option body: name is required; optional fields include id, attribute, items.
string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ORDER_LINE_ITEMCreates one line item for a standard or Multiple Service Charges order; provide price or item.id. Orders allow 2,500 line items with Multiple Service Charges and 3,000 otherwise.

Input Parameters

string
required
Line-item fields; include either price or item.id for an inventory item.
string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ORDER_LINE_ITEMS_BULKCreates up to 100 priced line items for either a standard or Multiple Service Charges order. The order limit is 2,500 line items with Multiple Service Charges and 3,000 otherwise.

Input Parameters

string
required
One to 100 line items; every item must include price.
string
required
Order identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ORDER_TYPE_CATEGORY_ASSOCIATIONSCreates associations between order types and merchant categories, requiring both resource IDs in each tuple. The associations limit an order type to those categories when category filtering is enabled.

Input Parameters

object
required
Associations to create. Every element requires orderType.id and category.id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ORDER_TYPE_FOR_MERCHANTCreates a custom order type for the merchant, such as dine-in, delivery, or takeout.

Input Parameters

object
required
Create order type for merchant body; set at least one documented field such as id, labelKey, label, taxable, isDefault.
array
Related fields to expand in the response. Select one or more of hours, attributes, and categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_PAYMENT_RECORD_ON_ORDERRecords an externally processed payment on an order for bookkeeping; it does not process a Clover credit or debit payment. Requires a positive amount and merchant tender ID.

Input Parameters

object
required
External payment record with a positive amount and valid tender.id.
string
required
Order identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_PHONE_NUMBER_FOR_CUSTOMERAdds a phone number to an existing customer record; it does not create the customer.

Input Parameters

object
required
Customer phone record; phoneNumber is required.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_ROLECreates a merchant employee role based on a Clover system role.

Input Parameters

object
required
Create role body: name, systemRole are required; optional fields include id, employeesRef, merchant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_SHIFT_FOR_EMPLOYEECreates a time-clock shift for one employee, including clock-in/out times, cash tips, or override details.

Input Parameters

object
required
New shift fields such as inTime, outTime, cash tips, and override references.
string
required
Employee ID for whom to create the shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_SUBCATEGORYCreates a subcategory within a parent inventory category; it inherits the parent’s color when one is set.

Input Parameters

object
required
Create subcategory body: name is required; optional fields include colorCode.
string
required
Unique identifier of the parent category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_TAGCreates an inventory tag for reporting, with optional item and printer associations.

Input Parameters

object
required
Create tag body: name is required; optional fields include id, showInReporting, items, printers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_TAG_ITEM_ASSOCIATIONSCreates one or more associations between Clover tags and inventory items. Every tuple requires both tag.id and item.id.

Input Parameters

object
required
Tag-item tuples to create; every tuple requires both IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_TAX_RATECreates a merchant tax rate as a percentage or flat amount, optionally making it the default or associating items.

Input Parameters

object
required
Create tax rate body: name is required; optional fields include id, taxType, rate, isDefault.
string
Expand items in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_CREATE_TENDERCreates a merchant-level custom tender. The response may include its identifier.

Input Parameters

object
required
Create tender body: label is required; optional fields include id, editable, labelKey, opensCashDrawer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ALL_LINE_ITEMS_IN_ORDERDeletes every line item from an order. This is destructive; verify the order before calling.

Input Parameters

string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_APP_BILLING_METERED_EVENTDeletes an unbilled app metered event. Billed events cannot be deleted; verify the event before calling.

Input Parameters

string
required
App Id
string
required
Clover event id used in the documented path field ‘eventId’.
string
required
Metered Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ATTRIBUTEDeletes an inventory variant attribute. This is destructive; verify the attribute identifier before calling.

Input Parameters

string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_AUTHORIZATIONPermanently delete a payment authorization. Only target an authorization the caller intends to remove; repeat only after confirming whether the first request succeeded.

Input Parameters

string
required
Clover authorization identifier from the documented authId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Comma-separated category IDs to permanently delete. Get IDs from List Categories and include only categories you intend to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_CUSTOMERDeletes a customer from the connected merchant. This is destructive; verify the customer identifier before calling.

Input Parameters

string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_CUSTOMER_ADDRESSDeletes one address from a customer. This is destructive; verify both identifiers before calling.

Input Parameters

string
required
Clover address identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_CUSTOMER_CARDDeletes one vaulted card record from a customer. This is destructive; verify both identifiers before calling.

Input Parameters

string
required
Clover card identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_CUSTOMER_EMAIL_ADDRESSDeletes one email address from a customer. This is destructive; verify both identifiers before calling.

Input Parameters

string
required
Clover email identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_CUSTOMER_PHONE_NUMBERDeletes one phone number from a customer. This is destructive; verify both identifiers before calling.

Input Parameters

string
required
Clover phone identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_EMPLOYEEDeletes an employee from the connected merchant. This is destructive; verify the employee identifier before calling.

Input Parameters

string
required
Employee ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_INVENTORY_DISCOUNTDeletes a merchant inventory discount. This is destructive; verify the discount identifier before calling.

Input Parameters

string
required
Discount Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_INVENTORY_ITEMDeletes an inventory item. This is destructive; verify the item identifier before calling.

Input Parameters

string
required
Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ITEM_CATEGORYDeletes an inventory category. This is destructive; verify the category identifier before calling.

Input Parameters

string
required
Category Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ITEM_GROUPDeletes an inventory item group. This is destructive; verify the group identifier before calling.

Input Parameters

string
required
Item Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ITEM_STOCKDeletes the stock record for an inventory item. This is destructive; verify the item identifier before calling.

Input Parameters

string
required
Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_LINE_ITEM_DISCOUNTRemoves a discount from an order line item. This changes order pricing; verify all identifiers before calling.

Input Parameters

string
required
Order Id
string
required
Discount Id
string
required
Line Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_MERCHANT_OPENING_HOURSDeletes one merchant opening-hours interval. This is destructive; verify the interval identifier before calling.

Input Parameters

string
required
Clover opening hours id used in the documented path field ‘hId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_MODIFIERDeletes one modifier from a modifier group. This is destructive; verify both identifiers before calling.

Input Parameters

string
required
Clover modifier id used in the documented path field ‘modId’.
string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_MODIFIER_GROUPDeletes a modifier group and every modifier in it. This is destructive; verify the group identifier before calling.

Input Parameters

string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Comma-separated modifier-group IDs to permanently delete. Get IDs from List Modifier Groups; deleting a group also deletes all modifiers in it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Comma-separated inventory-item IDs to permanently delete. Get IDs from List Inventory Items and include only owned or explicitly selected items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_OPTIONDeletes an option from an inventory attribute. This is destructive; verify both identifiers before calling.

Input Parameters

string
required
Option Id
string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ORDERDeletes an order. This is destructive; verify the order identifier and current state before calling.

Input Parameters

string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ORDER_DISCOUNTRemoves a discount from an order. This changes order pricing; verify both identifiers before calling.

Input Parameters

string
required
Order Id
string
required
Discount Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ORDER_LINE_ITEMDeletes a line item from an order. This is destructive and changes the order; verify both identifiers before calling.

Input Parameters

string
required
Order identifier.
string
required
Line Item identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ORDER_TYPEDeletes a merchant order type. This is destructive; verify the order-type identifier before calling.

Input Parameters

string
required
Order Type Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_ROLEDeletes a merchant employee role. This is destructive; verify the role identifier before calling.

Input Parameters

string
required
Clover role id used in the documented path field ‘roleId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_SHIFTDeletes one employee shift. Clover requires account_id to identify an employee permitted to edit shifts.

Input Parameters

string
required
Employee shift ID to delete.
string
required
Employee ID of an account with permission to edit shifts, required by Clover for shift deletion.
string
required
Employee ID that owns the shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_SUBCATEGORYDeletes a subcategory and reassigns its items to the parent category. This is destructive; verify the subcategory identifier before calling.

Input Parameters

string
required
Unique identifier of the subcategory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_TAGDeletes an inventory tag. This is destructive; verify the tag identifier before calling.

Input Parameters

string
required
Tag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_TAGSPermanently deletes the tags identified by a comma-separated list of tag IDs. Get IDs from List Tags and target only intended tags.

Input Parameters

string
required
Comma-separated tag IDs to permanently delete. Get IDs from List Tags and include only tags you intend to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_TAX_RATEDeletes a merchant tax rate. This is destructive; verify the tax-rate identifier before calling.

Input Parameters

string
required
Tax Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_DELETE_TENDERDeletes a merchant tender. This is destructive; verify the tender identifier before calling.

Input Parameters

string
required
Tender Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Replacement line-item snapshot; include either price or item.id. Clover creates this replacement using line_item_id and exchanges the old line item for it.
string
required
Order Id
string
required
Line Item Id
string
required
Old Line Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Related customer fields to include in the export. Select one or more of addresses, emailAddresses, phoneNumbers, cards, and metadata.
string
Filter by customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, or deletedTime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_EXPORT_SHIFTS_CSVExports merchant shifts as CSV for a required effective clock-in time window.

Input Parameters

integer
required
Inclusive end of the required effective clock-in window, as Unix epoch milliseconds.
integer
required
Inclusive start of the required effective clock-in window, as Unix epoch milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_APP_BILLING_METERED_EVENTReturns one metered billing event recorded for a merchant’s app subscription.

Input Parameters

string
required
App Id
string
required
Clover event id used in the documented path field ‘eventId’.
string
required
Metered Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ATTRIBUTEReturns one inventory variant attribute with the item-group and option references present in Clover’s response.

Input Parameters

string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_AUTHORIZATIONRetrieve one Clover payment authorization by identifier.

Input Parameters

string
Comma-separated documented expansions, including payment, tender, cardTransaction, refunds, order, and employee.
string
required
Clover authorization identifier from the documented authId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_CATEGORYReturns one inventory category, including its Register sort order and optional item expansion.

Input Parameters

string
Expand items in the response.
string
required
Category Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_CONFIGURED_SERVICE_CHARGEReturns one service charge configured for the merchant, identified by service_charge_id.

Input Parameters

string
required
Configured service charge identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_CREDIT_REFUNDRetrieve one Clover credit refund, including its credit, order, device, employee, and transaction details.

Input Parameters

array
Comma-separated expansions. Clover documents credit, germanInfo, appTracking, and transactionInfo.
string
required
Credit refund identifier from the documented crId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_CUSTOMERReturns one customer profile, with addresses, email addresses, phone numbers, cards, or metadata when expanded.

Input Parameters

array
Expand addresses, emailAddresses, phoneNumbers, cards, or metadata.
string
Filter by customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, or deletedTime.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_DEFAULT_SERVICE_CHARGEReturns the merchant’s default configured service charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_DEVICE_PROVISIONED_TO_MERCHANTReturns one Clover device provisioned to the connected merchant.

Input Parameters

string
required
Device Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_DISCOUNTReturns one merchant inventory discount, including its fixed amount or percentage.

Input Parameters

string
required
Discount Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_EMPLOYEEReturns one merchant employee profile, optionally expanding assigned roles and related shifts.

Input Parameters

array
Comma-separated expandable fields: roles and shifts.
string
required
Employee ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_INVENTORY_ITEMReturns one inventory item with pricing, availability, SKU, and requested related resources.

Input Parameters

array
Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options]
string
required
Inventory item identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ITEM_GROUPReturns one inventory item group and its related variants or attributes when expanded.

Input Parameters

array
Expandable fields: [items, attributes]
string
required
Item Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ITEM_STOCKReturns the current stock quantity and alert threshold for one inventory item.

Input Parameters

string
required
Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ITEM_SUBCATEGORY_ASSOCIATIONSReturns an inventory item and, with expand=categories.items, its category and subcategory associations; subcategories have a parentCategory.

Input Parameters

string
Expandable fields to display additional nested information: [categories.items].
string
required
Unique identifier of an item in the inventory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Clover table name required by the provider’s legacy sync protocol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MERCHANTReturns the connected merchant’s business profile and requested related resources.

Input Parameters

array
Expandable fields to display additional nested information: [employees, bankProcessing, externalMerchant, merchantBoarding, merchantL3Prerequisite, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication, enterprises, equipment, equipmentSummary]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MERCHANT_ADDRESSReturns the connected merchant’s business address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MERCHANT_APP_BILLING_INFORMATIONReturns a merchant’s app-billing status, including the current subscription tier and trial status.

Input Parameters

string
required
App Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MERCHANT_OPENING_HOURSReturns one merchant opening-hours set by identifier, including its weekday schedules.

Input Parameters

string
required
Clover opening hours id used in the documented path field ‘hId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MERCHANT_PAYMENT_GATEWAY_CONFIGURATIONReturns the connected merchant’s payment-gateway configuration and supported capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MERCHANT_PROPERTIESReturns the connected merchant’s operational properties and feature settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MODIFIERReturns one modifier from a specific modifier group, including its name and price adjustment.

Input Parameters

string
Expandable field: [modifierGroup]
string
required
Clover modifier id used in the documented path field ‘modId’.
string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_MODIFIER_GROUPReturns one modifier group and its configuration, with related modifiers or items when expanded.

Input Parameters

array
Expandable fields: [modifiers, items]
string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_OPTION_FOR_ATTRIBUTEReturns one option from a specific inventory attribute, including its item references.

Input Parameters

string
Filter fields: [modifiedTime, item.id, name, attribute.id, id, deletedTime]
string
required
Option Id
string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ORDERReturns one order with totals, state, and any related resources requested through expand.

Input Parameters

array
Expandable fields: [lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds]
string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ORDER_LINE_ITEMReturns one line item from any order, including age-restriction or Multiple Service Charges fields when Clover provides them.

Input Parameters

array
Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments]
string
required
Order Id
string
required
Line Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ORDER_TYPEReturns one merchant order type, including taxability and category-filter settings.

Input Parameters

array
Expandable fields: [hours, attributes, categories]
string
required
Order Type Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_PAYMENTRetrieve one Clover payment, including amount, tax, tip, and result status.

Input Parameters

string
Comma-separated expansions including tender, cardTransaction, employee, refunds, taxRates, appTracking, paymentAttributes, and order.
string
required
Clover payment identifier from the documented payId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_PRINT_EVENTGet a print event for the connected Clover merchant by event ID. Successfully printed events are discarded by Clover and cannot be replayed.

Input Parameters

string
required
Clover print event identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_REFUNDRetrieve one Clover refund, including associated payment, tax, tip, and transaction details.

Input Parameters

string
Comma-separated expansions including payment, employee, serviceCharge, lineItems, transactionInfo, and oceanGatewayInfo.
string
required
Clover refund identifier from the documented refundId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_ROLEReturns one merchant employee role and its base system role.

Input Parameters

string
Expandable fields: [employees]
string
required
Clover role id used in the documented path field ‘roleId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_SERVICE_CHARGE_APPLIED_TO_ORDERReturns one service-charge line item already applied to an order.

Input Parameters

array
Additional information provided as an expanded response: [employee, orderType, payments]
string
required
Order identifier.
string
required
Order fee line item identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_SHIFTRetrieves one shift by ID. Set employee_id to use Clover’s dedicated employee shift operation; omit it to use the merchant shift collection.

Input Parameters

array
Comma-separated expandable fields: employee, overrideInEmployee, and overrideOutEmployee.
string
required
Shift ID to retrieve.
string
Employee ID that owns the shift. Omit to retrieve the shift from the merchant collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_TAGReturns one inventory tag and its item or printer associations when expanded.

Input Parameters

array
Expandable fields: [items, printers]
string
required
Tag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_TAX_EXEMPTION_RULEReturns one tax exemption rule that links order types and items to excluded tax rates.

Input Parameters

string
required
Clover tax rule id used in the documented path field ‘taxRuleId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_TAX_RATEReturns one merchant tax rate, including its rate, type, and default status.

Input Parameters

string
Expandable fields: [items]
string
required
Tax Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_TENDERReturns one merchant tender and its payment-handling settings.

Input Parameters

string
required
Tender Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_TIP_SUGGESTIONReturns one merchant tip suggestion, including its percentage or flat amount.

Input Parameters

string
required
Clover tip suggestion id used in the documented path field ‘tId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_GET_VOIDED_LINE_ITEM_TOTALSReturns deleted line-item and order totals for a required caller-supplied deletedTime window.

Input Parameters

integer
required
Inclusive end of the required deletedTime window, as Unix epoch milliseconds.
integer
required
Inclusive start of the required deletedTime window, as Unix epoch milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_APP_BILLING_METERED_EVENTSRetrieves billing event data for one app metered-event type. The response is modeled as a single event rather than an event collection.

Input Parameters

string
required
App Id
string
required
Metered Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_ATTRIBUTESLists inventory variant attributes, such as size or color. Returns one offset page; continue until elements is empty.

Input Parameters

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
string
Filter fields to display search results: [modifiedTime, name, id, deletedTime, itemGroup.id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_AUTHORIZATIONSList payment authorizations for the connected merchant. Authorizations permit a future charge up to the authorized amount.

Input Parameters

string
Expandable field. Clover documents payment.
string
Filter by a documented authorization field, including paymentId, amount, cardType, createdTime, or id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_CATEGORIESLists inventory categories in Register sort order, optionally with associated items. Returns one offset page; continue until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
string
Expandable fields to display additional nested information: [items]
string
Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
string
required
Item identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_CATEGORY_SUBCATEGORIESReturns a category with its subcategories expanded by default; use subCategories.items only when nested item details are also needed.

Input Parameters

string ("subCategories" | "subCategories.items")
Expandable fields to display additional nested information: [subCategories, subCategories.items].
string
required
Category identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter fields to display search results: [modifiedTime, amount, serviceChargeUuid, type, percentage, name, createdTime, id, deletedTime]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_CREDIT_REFUNDSList credit refunds for the connected merchant, including associated tax and transaction details.

Input Parameters

array
Comma-separated expansions. Clover documents credit, germanInfo, appTracking, and transactionInfo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_CUSTOMERSLists customer records for the connected merchant, optionally filtered or expanded with related contact data.

Input Parameters

array
Expand addresses, emailAddresses, phoneNumbers, cards, or metadata.
string
Filter by customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, or deletedTime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_DEVICES_PROVISIONED_TO_MERCHANTLists Clover devices provisioned to the connected merchant, optionally filtered by documented device fields.

Input Parameters

string
Filter fields: [serial, name, merchant.id, merchant.name, deviceTypeName, model, id, deleted_time, orderPrefix]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_DISCOUNTSLists the merchant’s inventory discounts. Returns one caller-selected offset page; request successive offsets until elements is empty.

Input Parameters

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
string
Filter fields to display search results: [amount, modifiedtime, percentage, id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_DISCOUNTS_FOR_ORDERLists discounts currently applied at the order level; line-item discounts are returned by the line-item tools.

Input Parameters

string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_EMPLOYEESList employees for the connected Clover merchant, optionally filtered or expanded.

Input Parameters

array
Comma-separated expandable fields: roles and shifts.
string
Clover filter expression. Supported fields include modifiedTime, role, role.id, customId, name, nickname, id, deletedTime, deleted_time, and email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum inventory items to return on this page. Defaults to 100; maximum 1000.
array
Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted]
string
Filter fields to display search results: [lowStock, modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id, isAgeRestricted, ageRestrictedType, minimumAge]
integer
Zero-based position of the first inventory item returned. Increase by the previous page size to request the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
array
Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options]
string
Filter fields to display search results: [modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_ITEMS_BY_TAX_RATELists inventory items associated with the specified tax rate.

Input Parameters

string
Expandable fields: [items]
string
Filter fields: [modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id]
string
required
Tax Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_ITEMS_FOR_TAGLists inventory items associated with one tag.

Input Parameters

array
Expandable fields: [items, printers]
string
Filter fields: [modifiedTime, hidden, itemCode, available, option.id, alternateName, isRevenue, modifierGroup.id, autoManage, deleted, item.id, price, name, itemStock.quantity, id, sku, defaultTaxRates, itemGroup.id]
string
required
Tag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
array
Expandable fields to display additional nested information: [categories, itemStock, modifierRates, options, tags, taxRates]
string
Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
string
required
Category identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
array
Expandable fields to display additional nested information: [tags, categories, taxRates, modifierGroups, itemStock, options]
string
Filter fields to display search results: [modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
string
required
Modifier group identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_ITEM_STOCKSLists stock quantities and alert thresholds for the merchant’s inventory items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_ITEM_TAGSLists inventory tags associated with one item.

Input Parameters

array
Expandable fields: [items, printers]
string
Filter fields: [modifiedTime, deleted, name, showInReporting, id]
string
required
Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_MERCHANT_OPENING_HOURSLists the connected merchant’s opening-hours sets, each with weekday schedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_MODIFIER_GROUPSLists modifier groups that organize selectable item modifiers. Returns one offset page; continue until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_MODIFIERSRetrieves all modifiers from all modifier groups. Returns one caller-selected offset page; request another offset until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
array
Expandable fields to display additional nested information: [modifiers, items]
string
Filter fields to display search results: [modifiedTime, price, name, alternateName, id, modifierGroup.id]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
string
required
Modifier group identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_OPTIONSLists options across all inventory variant attributes. Returns one offset page; continue until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
string
Expandable fields to display additional nested information: [options]
string
Filter fields to display search results: [modifiedTime, item.id, name, attribute.id, id, deletedTime]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
string
required
Attribute identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_ORDER_LINE_ITEMSLists line items from any order, including age-restriction or Multiple Service Charges fields when Clover provides them.

Input Parameters

array
Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments]
string
required
Order Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_SERVICE_CHARGES_APPLIED_TO_ORDERLists service-charge line items already applied to an order; use configured-service-charge tools for merchant templates.

Input Parameters

array
Additional information provided as an expanded response: [employee, orderType, payments]
string
required
Order identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_SYSTEM_ORDER_TYPESLists Clover’s system order-type categories used to classify merchant-defined order types, such as takeout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_TAG_ITEM_ASSOCIATIONSLists every association between the merchant’s inventory tags and items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_TAGSLists the merchant’s inventory tags. Tags label items for reporting and can route tagged items to associated printers. Returns one caller-selected offset page; request successive offsets until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_TAX_EXEMPTION_RULESLists tax exemption rules that link order types and items to tax rates excluded from those items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_TAX_RATESLists percentage and flat-amount tax rates. Returns one offset page; continue until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_LIST_TENDERSRetrieves all tenders for a merchant. Returns one caller-selected offset page; request another offset until elements is empty.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
string
Filter fields to display search results: [flatTip, percentage, name, id, enabled]
integer
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_RECORD_VOIDED_LINE_ITEMSRecords a voided line item on an order for reporting, with optional quantity and reason details.

Input Parameters

object
required
Voided-line-item record; set at least one of lineItem, reason, removedBy, approvedBy, or deleteType.
string
required
Order identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Associations to remove. Each tuple may contain both IDs, only category.id to remove all items from that category, or only item.id to remove all categories from that item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Association to remove. Provide both IDs for one link, or one side to remove all modifier-group links for that object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Associations to remove. A one-sided tuple removes every association for that option or item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Associations to remove. Each tuple may contain both IDs or one side to remove all associations for that item or tax rate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_REMOVE_MODIFICATION_FROM_LINE_ITEMRemoves an applied modifier snapshot from an order line item. This is destructive; verify all identifiers before calling.

Input Parameters

string
required
Order Id
string
required
Line Item Id
string
required
Clover modification id used in the documented path field ‘modificationId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("configured" | "order_fee")
required
Use configured to remove a charge applied through Clover’s configured service-charge route; use order_fee to permanently remove an order-fee line item.
string
required
Order Id
string
required
Configured service-charge ID or order-fee line-item ID, according to mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Associations to remove. A one-sided tuple removes every association for that tag or item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Print event fields such as orderRef, deviceRef, category, orderSnapshot, or printTime; include at least one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ADDRESS_FOR_CUSTOMERUpdates one postal address on an existing customer record.

Input Parameters

object
required
Address fields to change, such as address1, city, state, zip, or country.
string
required
Clover address identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ATTRIBUTEUpdates an inventory variant attribute, including its name, item group, or option references.

Input Parameters

object
required
Update attribute body: name, itemGroup are required; optional fields include id, options.
string
Expandable fields: [options]
string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_AUTHORIZATIONUpdate a payment authorization. This can alter a future charge permission; verify the current authorization and do not blindly retry an uncertain result.

Input Parameters

object
required
Authorization fields to change, such as payment reference, amount, or authorization type.
string
required
Clover authorization identifier from the documented authId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_CATEGORYUpdates an inventory category’s name, Register sort order, color, or item associations.

Input Parameters

object
required
Update category body: name is required; optional fields include id, sortOrder, items, colorCode.
string
Expandable field: [items]
string
required
Category Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_CATEGORY_SORT_ORDERSUpdates Register menu sort positions for up to 1,000 inventory categories in one request.

Input Parameters

object
required
Update category sort orders body; set at least one documented field such as categorySortOrders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_CUSTOMERUpdates one customer’s identity, contact, marketing, or metadata fields using the supplied values.

Input Parameters

object
required
Customer fields to change, such as firstName, lastName, emailAddresses, or phoneNumbers.
array
Expand addresses, emailAddresses, phoneNumbers, cards, or metadata in the response.
string
required
Unique identifier of the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_CUSTOMER_CARDUpdates a customer’s vaulted credit or debit card record. first6 and last4 are required.

Input Parameters

object
required
Replacement customer card record; first6 and last4 are required, with optional token and cardholder fields.
string
required
Clover card identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_DISCOUNTUpdates a merchant inventory discount’s name, fixed amount, percentage, or approval reference.

Input Parameters

object
required
Update discount body: name is required; optional fields include id, discount, approver, amount.
string
required
Discount Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_EMAIL_ADDRESS_FOR_CUSTOMERUpdates one email address on an existing customer record.

Input Parameters

object
required
Replacement customer email record; emailAddress is required.
string
required
Email identifier.
string
required
Customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_EMPLOYEEUpdates one employee’s name, login, contact, or role details using the supplied fields.

Input Parameters

object
required
Replacement employee fields. Clover requires name when a body is supplied.
array
Comma-separated expandable fields: shifts, payments, orders, and roles.
string
required
Employee ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_INVENTORY_ITEMUpdates one inventory item’s supplied fields. Unlike creation, this action accepts available=false and makes the item unavailable.

Input Parameters

object
required
Update inventory item body; set at least one documented field such as id, hidden, available, autoManage, itemGroup.
array
Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted]
string
required
Unique identifier of an item in the inventory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_INVENTORY_ITEMSUpdates multiple inventory items in one request. Each submitted item requires a name and price.

Input Parameters

object
required
Update inventory items body: items is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ITEM_GROUPUpdates an inventory item group’s name, member items, or variant attributes.

Input Parameters

object
required
Update item group body: name is required; optional fields include id, items, attributes.
array
Expandable fields: [items, attributes]
string
required
Item Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ITEM_STOCKUpdates the stock quantity or low-stock alert threshold for one inventory item.

Input Parameters

object
required
Update item stock body; set at least one documented field such as item, stockCount, quantity, stockAlertThreshold, modifiedTime.
string
required
Item Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_MERCHANTUpdates the connected merchant’s business profile using the supplied fields.

Input Parameters

object
required
Update merchant body: name, owner are required; optional fields include id, address.
array
Expandable fields: [employees, bankProcessing, externalMerchant, merchantBoarding, merchantL3Prerequisite, deviceBoarding, programExpress, hierarchy, shifts, orders, address, logos, owner, items, tags, tenders, payments, gateway, printers, modifierGroups, properties, tipSuggestions, openingHours, partnerApp, selfBoardingApplication, enterprises, equipment, equipmentSummary]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_MERCHANT_OPENING_HOURSUpdates a merchant opening-hours set by identifier, including its weekday schedules and their start and end times.

Input Parameters

object
required
Update merchant opening hours body; set at least one documented field such as id, name, reference, sunday, monday.
string
required
Clover opening hours id used in the documented path field ‘hId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_MERCHANT_PROPERTIESUpdates the connected merchant’s operational properties and feature settings.

Input Parameters

object
required
Update merchant properties body; set at least one documented field such as merchantRef, defaultCurrency, tipsEnabled, receiptProperties, summaryHour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_MODIFIERUpdates a modifier’s name, price adjustment, or availability; Clover does not allow moving it to another modifier group.

Input Parameters

object
required
Update modifier body; set at least one documented field such as id, name, alternateName, available, price.
string
Expandable field: [modifierGroup]
string
required
Clover modifier id used in the documented path field ‘modId’.
string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_MODIFIER_GROUPUpdates a modifier group’s name, selection rules, or item references. Use Create Modifier to add a modifier to the group.

Input Parameters

object
required
Update modifier group body; set at least one documented field such as id, name, alternateName, minRequired, maxAllowed.
array
Expandable fields: [modifiers, items]
string
required
Modifier Group Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_MODIFIER_GROUP_SORT_ORDERSUpdate the priorities for a collection of up to 200 modifier groups at a time.

Input Parameters

object
required
Update modifier group sort orders body; set at least one documented field such as modifierGroups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_OPTIONUpdates a named option within a specific inventory attribute, including its item associations.

Input Parameters

object
required
Update option body: name is required; optional fields include id, attribute, items.
string
required
Option Id
string
required
Attribute Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ORDERUpdates one order using the supplied order fields; omitted fields remain unchanged.

Input Parameters

object
required
Update order body; set at least one documented field such as id, currency, customers, employee, total.
array
Additional information provided as an expanded response: [lineItems, serviceCharge, discounts, credits, payments, customers, orderFulfillmentEvent, refunds]
string
required
Order identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ORDER_LINE_ITEMUpdates one line item on either a standard or Multiple Service Charges order using the supplied fields.

Input Parameters

string
required
Line-item fields to update for a standard or Multiple Service Charges order; include at least one.
array
Additional information provided as an expanded response: [employee, orderType, discounts, modifications, taxRates, payments]
string
required
Order identifier.
string
required
Line item identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ORDER_TYPEUpdates a merchant order type’s label, taxability, system classification, or category settings.

Input Parameters

object
required
Update order type body; set at least one documented field such as id, labelKey, label, taxable, isDefault.
array
Expandable fields: [hours, attributes, categories]
string
required
Order Type Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Set lineItemPayments allocations or employee.id for an uncaptured preauthorization; Clover ignores other fields.
string
required
Clover payment identifier from the documented payId path field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_PHONE_NUMBER_FOR_CUSTOMERUpdates one phone number on an existing customer record.

Input Parameters

object
required
Replacement customer phone record; phoneNumber is required.
string
required
Clover phone identifier.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_ROLEUpdates a merchant employee role’s name, base system role, or employee references. The request requires both the role name and base system role.

Input Parameters

object
required
Update role body: name, systemRole are required; optional fields include id, employeesRef, merchant.
string
Expandable fields: [employees]
string
required
Clover role id used in the documented path field ‘roleId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_SHIFTUpdates one employee shift’s clock-in/out times, cash tips, or override details.

Input Parameters

object
required
Shift fields to change, such as inTime, outTime, cash tips, or override references.
array
Comma-separated expandable fields: employee, overrideInEmployee, and overrideOutEmployee.
string
required
Employee shift ID to update.
string
required
Employee ID that owns the shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_SUBCATEGORYUpdates a subcategory’s name or color within its parent inventory category.

Input Parameters

object
required
Update subcategory information body; set at least one documented field such as name, colorCode.
string
required
Unique identifier of the parent category.
string
required
Unique identifier of the subcategory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_TAGUpdates an inventory tag’s name, reporting behavior, or item and printer associations.

Input Parameters

object
required
Update tag body: name is required; optional fields include id, showInReporting, items, printers.
array
Expandable fields: [items, printers]
string
required
Tag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_TAX_RATEUpdates a merchant tax rate’s name and optionally its rate, type, default status, or other tax details. The name is required.

Input Parameters

object
required
Update tax rate body: name is required; optional fields include id, taxType, rate, isDefault.
string
required
Tax Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_TENDERUpdates a merchant tender’s label, availability, cash-drawer, tipping, or processing settings.

Input Parameters

object
required
Update tender body; set at least one documented field such as id, editable, labelKey, label, opensCashDrawer.
string
required
Tender Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPDATE_TIP_SUGGESTIONUpdates a merchant tip suggestion’s name, percentage, flat amount, or enabled status.

Input Parameters

object
required
Update tip suggestion body; set at least one documented field such as id, name, percentage, amount, isEnabled.
string
required
Clover tip suggestion id used in the documented path field ‘tId’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOVER_UPSERT_CUSTOMER_METADATACreates or updates a customer’s note, birthday, and business-name metadata.

Input Parameters

object
required
Customer metadata; set at least one business name, note, or birthday field.
string
required
Clover customer identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Custom-order fields such as taxRemoved, note, title, state, or orderType; include at least one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not