Clover MCP connector

• Get Get single Clover merchant by ID Get a single Clover merchant by id. Returns: id, name, reseller_id, owner, address. Required: id.
• Update Update a Clover merchant by ID Update a Clover merchant by id. Returns the updated merchant including id, name, reseller_id, owner, and address. Required: id, name, owner.
• List List all Clover devices List all devices provisioned to a Clover merchant. Returns device records including id, name, serial, model, deviceTypeName, and orderPrefix. Required: m_id.
• Get Get single Clover device by ID Get a single device provisioned to a Clover merchant by id. Returns the device object including id, name, serial, model, deviceTypeName, and merchant. Required: id, m_id.
• List List all Clover sync Get a sync token for a Clover merchant data table (deprecated). Returns a sync token; the response body shape is undocumented by the API and cannot be enumerated. Required: m_id, table.
• List List all Clover items List inventory items for a Clover merchant, up to 1000 per page. Returns: isAgeRestricted, ageRestrictedType, minimumAge. Required: m_id.
• Create Create a Clover item Create an inventory item for a Clover merchant. Returns the created item including id, name, price, priceType, available, and modifiedTime. Required: m_id, name, price.
• Get Get single Clover item by ID Get a single inventory item for a Clover merchant. Returns: id, hidden, available, autoManage, itemGroup, options, name, alternateName, code, sku, price, priceType, defaultTaxRates, unitName, cost, isRevenue, stockCount, taxRates, modifierGroups, categories, tags, canonical, itemStock, MenuItem, modifiedTime, and 3 more. Required: m_id, id.
• Update Update a Clover item by ID Update an inventory item in Clover. Returns the updated item object including id, name, price, priceType, hidden, and available, plus expandable relations (categories, tags, taxRates, modifierGroups, itemStock). Required: id, m_id. Cannot update stock quantity — use the Update item stock endpoint for that.
• Delete Delete a Clover item by ID Delete an inventory item in Clover by id. Returns an empty 200 response on success. Required: id, m_id.
• Update Clover items bulk update Update existing inventory items in bulk for a Clover merchant, applying only the changes in the payload without replacing existing items. Returns the updated items with their id, name, price, priceType, available, itemStock, and modifiedTime. Required: m_id, items.
• Create Clover items bulk create Create multiple inventory items, each requiring name and price, in a single request for a Clover merchant. Returns the created items with their id, name, price, priceType, available, itemStock, and modifiedTime. Required: m_id, items.
• Delete Clover items bulk delete Delete multiple inventory items in a Clover merchant by id. Returns an empty 204 response on success. Required: m_id.
• Get Get single Clover item stock by ID Get the stock of a single Clover inventory item. Returns: item, stockCount, quantity, stockAlertThreshold, modifiedTime. Required: m_id and id.
• Update Update a Clover item stock by ID Update the stock of a Clover inventory item. Returns the updated stock with item, quantity, stockAlertThreshold, and modifiedTime. Required: m_id and id.
• Delete Delete a Clover item stock by ID Delete the stock of a Clover inventory item. Returns an empty 204 response on success. Required: m_id and id.
• Create Create a Clover item stock Create a stock count for a single Clover inventory item. Returns: item, stockCount, quantity, stockAlertThreshold, modifiedTime. Required: m_id, item_id, and quantity.
• List List all Clover item stocks List the stock of all inventory items for a Clover merchant. Returns item stock records with item, quantity, stockAlertThreshold, and modifiedTime. Required: m_id.
• Create Create a Clover item group Create a Clover item group used to manage large groups of related items sold as variations (items with variants). Returns: id, name, attributes. Required: m_id, name.
• Get Get single Clover item group by ID Get a single Clover item group by id. Returns: id, name, items, attributes. Required: m_id, id.
• Update Update a Clover item group by ID Update a Clover item group by id. Returns: id, name, attributes. Required: m_id, id, name.
• Delete Delete a Clover item group by ID Delete a Clover item group by id. Returns an empty 200 response on success. Required: m_id, id.
• List List all Clover item groups List the item groups of a Clover merchant, which group related items sold as variations (e.g. T-shirts by size and color). Returns: id, name, attributes. Required: m_id. Max 1000 per page.
• List List all Clover tags List all tags (item labels) for a Clover merchant; tags track items in reports or act as printer labels. Returns: id, name, showInReporting, printers. Required: m_id. Max 1000 per page.
• Create Create a Clover tag Create a new tag for a Clover merchant. Returns the created tag object including id, name, showInReporting, and its associated items and printers. Required: m_id, name.
• Get Get single Clover tag by ID Get a single tag by id for a Clover merchant. Returns: id, name, showInReporting, items, printers. Required: m_id, id.
• Update Update a Clover tag by ID Update a single tag by id for a Clover merchant. Returns the updated tag including id, name, showInReporting, items, and printers. Required: m_id, id, name.
• Delete Delete a Clover tag by ID Delete a tag by id from a Clover merchant. Returns an empty 204 response on success. Required: m_id, id.
• Delete Clover tags bulk delete Delete multiple tags for a Clover merchant in a single request, specifying the tags to remove via a comma-separated list of one or more tag ids (e.g. tagId1,tagId2,tagId3). Returns an empty 200 response on success. Required: m_id.
• List List all Clover tag items List the inventory items associated with a tag for a Clover merchant, one item per record. Returns: tag, item. Required: m_id.
• Create Create a Clover tag item Create or delete tag-to-item associations for a Clover merchant by posting an array of item/tag pairs. Returns: tag, item. Required: m_id.
• List List all Clover tax rates List all tax rates for a Clover merchant. Returns: id, name, taxType, rate, isDefault, taxAmount, deletedTime, modifiedTime. Required: m_id. Max 1000 per page.
• Create Create a Clover tax rate Create a tax rate for a Clover merchant. Returns the created tax rate object including id, name, rate, taxType, isDefault, and taxAmount. Required: m_id, name.
• Get Get single Clover tax rate by ID Get a single tax rate for a Clover merchant by id. Returns: id, name, taxType, rate, isDefault, items, taxAmount, deletedTime, modifiedTime. Required: id, m_id.
• Update Update a Clover tax rate by ID Update a single tax rate for a Clover merchant by id. Returns the updated tax rate object including id, name, rate, taxType, and isDefault. Required: id, m_id, name.
• Delete Delete a Clover tax rate by ID Delete a single tax rate from a Clover merchant by id. Returns an empty 204 response on success. Required: id and m_id.
• Create Create a Clover tax rate item Create or delete the association between items and tax rates for a Clover merchant. Returns the association object including the full item (id, name, price) and tax rate (id, name, rate) records. Required: m_id, elements. Set delete to true in the query to remove an association.
• List List all Clover categories List all Clover categories for a merchant, displayed in the Register app in sort order. Returns: id, name, sortOrder, colorCode, deleted, modifiedTime, canonical. Required: m_id.
• Create Create a Clover category Create an item category in Clover for a merchant. Returns the created category object including id, name, sortOrder, colorCode, and items. Required: m_id, name
• Get Get single Clover category by ID Get a single Clover category by id for a merchant. Returns the category object including id, name, sortOrder, colorCode, and items. Required: id, m_id
• Update Update a Clover category by ID Update a Clover item category by id. Returns the updated category object including id, name, sortOrder, colorCode, and items. Required: id, m_id, and name.
• Delete Delete a Clover category by ID Delete a single Clover item category by id. Returns an empty 204 response on success. Required: id and m_id.
• Update Clover categories bulk update sort orders Bulk update the menu display order of up to 1000 categories for a Clover merchant in a single request. Returns an empty 200 response on success. Required: m_id. Body takes a categorySortOrders list of category id and sortOrder pairs.
• Delete Clover categories bulk delete Delete multiple Clover categories in a single request. Returns an empty 200 response on success. Required: m_id.
• Create Create a Clover category item Create or delete a category-item association in Clover. Returns the association: item (id, name, price, sku) and category (id, name, sortOrder). Required: m_id, elements. Moving an item to a subcategory requires two requests: delete=true on the parent, then delete=false on the subcategory.
• List List all Clover modifier groups List all modifier groups for a Clover merchant. Returns: id, name, alternateName, minRequired, maxAllowed, showByDefault, modifiers, modifierIds, sortOrder. Required: m_id. Supports field filtering via filter and expanding modifiers or items via expand.
• Create Create a Clover modifier group Create a modifier group in Clover for a merchant. Returns the created modifier group with id, name, minRequired, maxAllowed, and nested modifiers. Required: m_id, name. Associate modifiers with the group afterwards via the create modifiers endpoint.
• Get Get single Clover modifier group by ID Get a single Clover modifier group by its UUID. Returns: id, name, alternateName, minRequired, maxAllowed, showByDefault, modifiers, modifierIds, items, sortOrder. Required: m_id, id.
• Update Update a Clover modifier group by ID Update a Clover modifier group by id. Returns the updated modifier group with id, name, minRequired, maxAllowed, nested modifiers, and sortOrder. Required: m_id, id. To add modifiers to the group, use the create modifiers endpoint.
• Delete Delete a Clover modifier group by ID Delete a Clover modifier group by id; all modifiers within the group are deleted as well. Returns an empty 204 response on success. Required: m_id, id.
• Delete Clover modifier groups bulk delete Delete multiple modifier groups in a single request in Clover. Returns an empty 204 response on success. Required: m_id.
• Create Create a Clover item modifier group Create or delete the association between an inventory item and a modifier group in Clover. Returns the associated inventory item (id, name, price, priceType) and its modifierGroups (id, name, minRequired, modifiers). Required: m_id.
• List List all Clover modifiers List all modifiers from every modifier group in a Clover merchant. Returns: id, name, alternateName, available, price, modifierGroup. Required: m_id. Max 1000 per page.
• Create Create a Clover modifier Create a modifier in a Clover merchant's modifier group. Returns the created modifier including id, name, alternateName, available, price, and modifierGroup. Required: m_id, mod_group_id.
• Get Get single Clover modifier by ID Get a single modifier by its UUID within a Clover modifier group. Returns: id, name, alternateName, available, price, modifierGroup. Required: id, m_id, mod_group_id.
• Update Update a Clover modifier by ID Update a single Clover modifier by id; a modifier cannot be moved to a different group after creation. Returns: id, name, alternateName, available, price, modifierGroup. Required: id, m_id, mod_group_id.
• Delete Delete a Clover modifier by ID Delete a single modifier by its UUID from a Clover modifier group. Returns an empty 204 response on success. Required: id, m_id, mod_group_id.
• List List all Clover attributes List all inventory attributes for a Clover merchant, such as size and color of a t-shirt. Returns: id, name, itemGroup, options. Required: m_id.
• Create Create a Clover attribute Create an inventory attribute for a Clover merchant. Returns the created attribute including id, name, itemGroup, and its options. Required: m_id, name, itemGroup.
• Get Get single Clover attribute by ID Get a single inventory attribute by id for a Clover merchant. Returns: id, name, itemGroup, options. Required: m_id, id.
• Update Update a Clover attribute by ID Update a single inventory attribute by id for a Clover merchant. Returns the updated attribute including id, name, itemGroup, and its options. Required: m_id, id, name, itemGroup.
• Delete Delete a Clover attribute by ID Delete a single inventory attribute by id for a Clover merchant. Returns an empty 204 response on success. Required: m_id and id.
• List List all Clover options List all item variant options for a Clover merchant. Returns each option's id, name, attribute, and associated items. Required: m_id.
• Update Update a Clover option by ID Update an option by id under an attribute of a Clover merchant. Returns the updated option with id, name, attribute, and items. Required: m_id, attribute_id, id, and name.
• Delete Delete a Clover option by ID Delete an option by id under an attribute of a Clover merchant. Returns an empty response on success. Required: id, m_id, attribute_id.
• Create Create a Clover option Create an option under an attribute of a Clover merchant. Returns the created option with id, name, attribute, and items. Required: m_id, attribute_id, and name.
• Get Get single Clover option by ID Get a single option by id for an attribute of a Clover merchant. Returns: id, name, attribute, items. Required: id, m_id, attribute_id.
• Create Create a Clover option item Create or delete item/option associations for a Clover merchant's inventory. Returns the association reference containing option and item, each with its id. Required: m_id.
• List List all Clover discounts List Clover discounts for a merchant's inventory. Returns: id, name, amount, percentage, discount, approver. Required: m_id. Max 1000 per page.
• Create Create a Clover discount Create a discount in a Clover merchant's inventory. Returns the created discount object including id, name, amount, percentage, discount, and approver. Required: m_id, name.
• Get Get single Clover discount by ID Get a single Clover discount by id. Returns: id, discount, approver, name, amount, percentage. Required: m_id, id.
• Update Update a Clover discount by ID Update a Clover discount by id. Returns the updated discount object including id, name, amount, percentage, discount, and approver. Required: m_id, id, name.
• Delete Delete a Clover discount by ID Delete a Clover discount by id. Returns an empty 204 response on success. Required: m_id, id.
• List List all Clover tax rules List all tax exemption rules for a Clover merchant — rules that link order types to items in an order to exclude certain tax rates from those items. Returns: id, name, merchant. Required: m_id.
• Get Get single Clover tax rule by ID Get an individual tax exemption rule by id for a Clover merchant. Returns: id, name, merchant, orderType, rates, items, createdTime, modifiedTime, deletedTime. Required: id, m_id.
• List List all Clover employees List all employees associated with a Clover merchant. Returns: id, name, nickname, customId, email, inviteSent, claimedTime, deletedTime, pin, unhashedPin, role, roles, isOwner, shifts, payments, orders, employeeCards, merchant. Required: m_id.
• Create Create a Clover employee Create an employee for a Clover merchant. Returns the created employee including id, name, nickname, email, role, and merchant. Required: m_id, name.
• Get Get single Clover employee by ID Get a single Clover employee by id. Returns the full employee record including id, name, nickname, email, role, pin, and merchant. Required: id, m_id.
• Update Update a Clover employee by ID Update a single Clover employee by id. Returns the updated employee including id, name, nickname, email, role, and merchant. Required: id, m_id, name.
• Delete Delete a Clover employee by ID Delete a single Clover employee by id; the merchant's 'owner' employee cannot be deleted. Returns an empty 204 response on success. Required: id, m_id.
• List List all Clover roles List all system and employee roles for a Clover merchant's business. Returns: id, name, systemRole, employeesRef, merchant. Required: m_id. Max 1000 per page.
• Create Create a Clover role Create a role for a Clover merchant. Returns: id, name, systemRole, employeesRef, merchant. Required: m_id, name, systemRole.
• Get Get single Clover role by ID Get a single role for a Clover merchant by id. Returns: id, name, systemRole, employeesRef, merchant. Required: m_id, id.
• Update Update a Clover role by ID Update a single role for a Clover merchant by id. Returns: id, name, systemRole, employeesRef, merchant. Required: m_id, id, name, systemRole.
• Delete Delete a Clover role by ID Delete a role for a Clover merchant by id. Required: id and m_id. Returns an empty 204 response on success.
• Delete Delete a Clover tender by ID Delete an existing tender for a Clover merchant. Returns an empty 204 response on success. Required: m_id, id.
• List List all Clover customers List all customers of a Clover merchant. Returns customer records including id, firstName, lastName, marketingAllowed, customerSince, and contact details (addresses, emailAddresses, phoneNumbers) plus cards and metadata. Required: m_id.
• Create Create a Clover customer Create a customer record for a Clover merchant. Returns the created customer including id, firstName, lastName, customerSince, and metadata. Required: m_id.
• Get Get single Clover customer by ID Get a single customer of a Clover merchant by id. Returns the customer record including id, firstName, lastName, marketingAllowed, customerSince, and contact details (addresses, emailAddresses, phoneNumbers). Required: m_id, id.
• Update Update a Clover customer by ID Update a single customer of a Clover merchant by id, including the card associated with the customer. Returns the updated customer including id, firstName, lastName, customerSince, and metadata. Required: id, m_id.
• Delete Delete a Clover customer by ID Delete a customer from a Clover merchant by id. Returns an empty 204 response on success. Required: m_id and id.
• List List all Clover shifts List all shifts for a Clover merchant. Returns: id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime, overrideOutTime, overrideOutEmployee. Required: m_id. Supports filtering by employee, in/out times, and server_banking, and expanding the employee and override employee records.
• Get Get single Clover shift by ID Get a single shift by id for a Clover merchant. Returns: id, employee, cashTipsCollected, serverBanking, inTime, overrideInTime, overrideInEmployee, outTime, overrideOutTime, overrideOutEmployee. Required: id, m_id. Use expand to inline the employee and override employee records.
• List List all Clover cash events List all cash events recorded for a Clover merchant, such as drawer loads, transactions, opens, adjustments, counts, and unloads. Returns: amountChange, timestamp, note, employee, device, merchant. Required: m_id.
• Get Get single Clover order by ID Get a single Clover order by id. Returns the order object with id, currency, customers, and expandable lineItems, payments, discounts, and refunds. Required: m_id and id.
• Update Update a Clover order by ID Update a single Clover order by id. Returns the updated order object with id, currency, customers, and expandable lineItems, payments, and discounts. Required: m_id and id.
• Create Create a Clover order Create a Clover order for a merchant. Returns the created order object with id, currency, customers, and expandable lineItems and payments. An order can have 25 items. Required: m_id.
• Create Clover orders bulk create Create multiple line items on a Clover order in a single request. Returns the created line items (elements) with id, name, and price. Max 100 line items per request; an order is limited to 2,500 line items. Required: m_id, order_id.
• List List all Clover orders List a merchant's Clover orders, newest first. Returns order objects with id, currency, customers, and expandable lineItems and payments. Required: m_id. Filter by created, customer, ids, or status.
• List List all Clover refunds List Clover refunds for a merchant, including associated taxes and tips, newest first; filter by charge or created time. Returns refund objects with id, amount, taxAmount, tipAmount, createdTime, and status. Required: m_id.
• Get Get single Clover refund by ID Get a single Clover refund by id for a merchant, including associated taxes and tips. Returns the refund with id, amount, taxAmount, tipAmount, createdTime, and status. Required: id, m_id.
• Create Create a Clover app billing Create a Clover app billing metered event, charging the merchant for each action taken on the app based on the app's metered pricing. Returns: id, appMetered, count, createdTime, modifiedTime, charge. Required: app_id, m_id, metered_id. Pass count as a query parameter to bill multiple events; it defaults to 1.
• Get Get single Clover app billing by ID Get all billing events for a Clover app metered event type, such as reservation. Returns: id, appMetered, count, createdTime, modifiedTime, charge. Required: app_id, m_id, id.
• Create Create a Clover ecommerce charge Create a charge in Clover Ecommerce: charges a credit card or other payment source using the supplied charge payload. Returns the created charge object including id, amount, currency, status, and captured. Requires amount, currency, and source. Required: amount, currency, source.
• Get Get single Clover ecommerce charge by ID Get a single Clover Ecommerce charge by id. Returns the charge details, including id, amount, currency, status, paid, and captured. Required: id.
• List List all Clover ecommerce charges List existing ecommerce charges in Clover, newest first, optionally filtered by customer, creation time, or 3-D Secure result. Returns: amount, tax_amount, tip_amount, additional_charges, amount_refunded, partial_auth, billing_details, captured, created, currency, customer, description, id, paid, receipt_url, status, and 30 more. Max 100 per page.
• Create Create a Clover ecommerce refund Create a refund in Clover against an existing charge. Returns: id, amount, additional_charges, created, currency, description, external_reference_id, failure_reason, charge, metadata, object, reason, receipt_number, status. Required: charge. Partial refunds are allowed up to the original charge amount.
• List List all Clover ecommerce refunds List refunds in Clover, newest first, with filters for a specific charge and creation-time ranges. Returns: id, charge, created, source.
• Get Get single Clover ecommerce refund by ID Get a refund by id in Clover. Returns the refund's details, including its id, the associated charge, and creation time. Required: id.
• Create Create a Clover ecommerce order Create an ecommerce order in Clover. Returns the created order object including its id, created timestamp, currency, email, status, items, and shipping details. Required: currency, email. An order can have up to 25 items, and a shipping address is required if any item's SKU is shippable.
• List List all Clover ecommerce orders List a merchant's ecommerce orders in Clover, newest first. Returns: amount, amount_paid, amount_due, tax_amount, tax_amount_paid, tip_amount, partial_auth, additional_charges, threeds, gift_card, created, currency, email, id, items, shipping, status, status_transitions, and 23 more. Filterable by created time, customer, ids, and status.
• Get Get single Clover ecommerce order by ID Get a single Clover Ecommerce order by its UUID. Returns the order object from the vendor's `order` schema; the field shape is defined by Clover's order object — use `expand` to include related objects in the response. Required: id.
• Create Create a Clover ecommerce customer Create a card-on-file (COF) customer in Clover Ecommerce to save payment sources for e-commerce transactions. Returns the created customer record including its id, email, default_source, and sources (saved card or ACH tokens). Required: email, source. Use the Clover Platform API customer endpoint when no card data should be saved.
• Create Create a Clover hosted checkout Create a hosted checkout session in Clover for a customer transaction. Returns the created checkout session object including its id and Clover-defined checkout-session fields (attributes). Required: shoppingCart.
• Get Get single Clover ecommerce plan by ID Get a single Clover recurring payment plan by id. Returns: id, name, merchantId, taxRateUuids, tipAmount, amount, active, interval, intervalCount, productUuid, note, createdTime, modifiedTime, deletedTime, subscriptionCount, subscriptionPaidTotalAmount, lastRunDate, object. Required: id.
• Create Create a Clover ecommerce plan Create a Clover recurring payment plan customers can use to initiate automatic payments. Returns the created plan with id, name, amount, interval, intervalCount, and createdTime. Required: name, amount, interval, intervalCount.
• Delete Delete a Clover ecommerce plan by ID Delete a Clover recurring payment plan by id. Returns the deleted plan object with id, name, amount, active, and deletedTime. Required: id.
• List List all Clover ecommerce plans List Clover merchant recurring payment plans customers can use for automatic payments. Returns plan records with id, name, amount, interval, intervalCount, and active. Filterable by active, name, interval, and intervalCount.
• Update Update a Clover ecommerce plan by ID Update a Clover recurring payment plan by id, including its amount, name, note, tax rates, tip amount, or active status. Returns the updated plan with id, name, amount, active, and modifiedTime. Required: id.
• List List all Clover API keys Retrieve the Clover Ecommerce API key (PAKMS key) associated with the merchant and developer app of your access token. Returns: active, apiAccessKey, createdTime, developerAppUuid, merchantUuid, tokenAssociationGroupUuid, modifiedTime.
• List List all Clover merchant addresses Get a merchant's address in Clover. Returns the address object with address1, address2, address3, city, state, zip, and country. Required: m_id.
• List List all Clover merchant gateways Get a Clover merchant's payment gateway configuration by merchant id. Returns: paymentProcessorName, authorizationFrontEnd, acquiringBackEnd, paymentGatewayApi, accountName, altMid, mid, fns, tid, storeId, supportsTipping, frontendMid, backendMid, mcc, tokenType, groupId, debitKeyCode, sredCode, closingTime, production, and 8 more. Required: m_id.
• List List all Clover merchant properties Get a Clover merchant's properties for a specific merchant by id. Returns the properties object including merchantRef, defaultCurrency, tipsEnabled, locale, timezone, orderTitle, autoPrint, and cashBackEnabled. Required: m_id.
• Update Update a Clover merchant property by ID Update a Clover merchant's properties by merchant id. Returns the updated properties object including merchantRef, defaultCurrency, locale, timezone, and tipsEnabled. Required: m_id.
• List List all Clover merchant service charges Get the default service charge configured for a Clover merchant. Returns: id, name, enabled, percentage, percentageDecimal, isAutoApplied. Required: m_id.
• Get Get single Clover tip suggestion by ID Get a single tip suggestion for a Clover merchant by id. Returns: id, name, percentage, amount, isEnabled, flatTip. Required: id, m_id.
• List List all Clover tip suggestions List all tip suggestions configured for a Clover merchant, such as flat or percentage tips. Returns: id, name, percentage, amount, isEnabled, flatTip. Required: m_id. Max 1000 per page.
• Update Update a Clover tip suggestion by ID Update a single tip suggestion for a Clover merchant by id, setting fields such as name, percentage, amount, isEnabled, or flatTip. Returns: id, name, percentage, amount, isEnabled, flatTip. Required: id, m_id.
• Create Create a Clover order type Create a new order type for a Clover merchant, such as delivery, pickup, or a custom type from the Clover Setup App. Returns the created order type including id, label, taxable, filterCategories, and hours. Required: m_id.
• Delete Delete a Clover order type by ID Delete a Clover merchant's order type by id. Returns an empty response on success. Required: m_id, id.
• Get Get single Clover order type by ID Get a single order type for a Clover merchant by id. Returns: id, labelKey, label, taxable, isDefault, filterCategories, isHidden, fee, minOrderAmount, maxOrderAmount, maxRadius, avgOrderTime, hoursAvailable, customerIdMethod, isDeleted, systemOrderTypeId, hours, categories. Required: m_id, id.
• List List all Clover order types List all order types configured for a Clover merchant, including custom order types created in the Clover Setup App. Returns: id, labelKey, label, taxable, isDefault, filterCategories, isHidden, fee, avgOrderTime, hoursAvailable, customerIdMethod, isDeleted, systemOrderTypeId, hours, categories, and 3 more. Required: m_id. Max 1000 per page.
• Update Update a Clover order type by ID Update an existing order type for a Clover merchant by id. Returns the updated order type including id, label, taxable, isDefault, and categories. Required: m_id, id.
• List List all Clover system order types List the system order types configured for a Clover merchant — the functional categories (e.g. TAKE-OUT-TYPE) that custom order types can be associated with. Returns: id, labelKey, isQsr, isFsr, isRetail. Required: m_id.
• Create Create a Clover opening hour Create a set of opening hours for a Clover merchant. Returns the created hours object with id, name, reference, and the sunday–saturday schedule arrays. Required: m_id. Each day interval requires start and end.
• Delete Delete a Clover opening hour by ID Delete a set of opening hours for a Clover merchant by id. Returns an empty response on success. Required: m_id, id.
• Get Get single Clover opening hour by ID Get a specific set of opening hours for a Clover merchant by id. Returns the hours object with id, name, reference, and the sunday–saturday schedule arrays. Required: m_id, id.
• List List all Clover opening hours List the opening hours sets of a Clover merchant. Returns each hours object with id, name, reference, and the sunday–saturday schedule arrays. Required: m_id.
• Update Update a Clover opening hour by ID Update a set of opening hours for a Clover merchant by id. Returns the updated hours object with id, name, reference, and the sunday–saturday schedule arrays. Required: m_id, id.
• Create Create a Clover customer phone number Create a phone number for a merchant's customer in Clover. Requires m_id, customer_id, and phoneNumber. Returns an empty 204 response on success. Required: m_id, customer_id, phoneNumber.
• Delete Delete a Clover customer phone number by ID Delete a customer's phone number in Clover by id. Requires m_id, customer_id, and id. Returns an empty 204 response on success. Required: id, m_id, customer_id.
• Update Update a Clover customer phone number by ID Update a customer's phone number in Clover by id. Requires m_id, customer_id, id, and phoneNumber. Returns an empty 204 response on success. Required: id, m_id, customer_id, phoneNumber.
• Create Create a Clover customer email address Create an email address for a customer of a Clover merchant. Email address domains and addresses are validated upstream. Required: m_id, customer_id, emailAddress.
• Delete Delete a Clover customer email address by ID Delete a customer's email address in Clover by id. Required: id, m_id, customer_id.
• Update Update a Clover customer email address by ID Update a customer's email address in Clover by id. Required: m_id, customer_id, id, and emailAddress. Email address domains and addresses are validated upstream.
• Create Create a Clover customer address Create an address for a customer in Clover, with address1, address2, address3, city, country, state, and zip fields. Returns an empty 200 response on success. Required: m_id, customer_id.
• Delete Delete a Clover customer address by ID Delete a customer address in Clover. Returns an empty 200 response on success. Required: id, m_id, customer_id.
• Update Update a Clover customer address by ID Update a customer address in Clover with address1, address2, address3, city, country, state, and zip fields. Returns an empty 200 response on success. Required: id, m_id, customer_id.
• Create Create a Clover customer card Create a credit/debit card entry for a Clover customer. Returns an empty 200 response on success. Required: m_id, customer_id, first6, last4.
• Delete Delete a Clover customer card by ID Delete a customer card from a Clover customer by id. Returns an empty 200 response on success. Required: id, m_id, customer_id.
• Update Update a Clover customer card by ID Update a credit/debit card record for a Clover customer by id. Returns an empty 200 response on success. Required: m_id, customer_id, id, first6, last4.
• Create Create a Clover atomic order Create a complete Clover atomic order — line items, modifiers, discounts, and service charges — in a single API call. Returns the created order object including its id. Max 3,000 line items per order; exceeding the limit fails with a 400 error. Required: m_id.
• List List all Clover employee cash events List all cash events for an employee in Clover. Returns each event's type, amountChange, timestamp, note, employee, device, and merchant. Required: m_id, emp_id.
• Create Create a Clover employee shift Create a shift for an employee in Clover, recording clock in/out times, overrides, and cash tips. Returns the created shift including id, employee, inTime, outTime, and cashTipsCollected. Required: m_id, emp_id.
• Get Get single Clover employee shift by ID Get a single shift recorded for an employee in Clover by id. Returns the shift including id, employee, inTime, outTime, and cashTipsCollected. Required: id, m_id, emp_id.
• List List all Clover employee shifts List all shifts recorded for an employee in Clover. Returns shift records including id, employee, inTime, outTime, and cashTipsCollected. Required: m_id, emp_id.
• List List all Clover order line items List all line items for an order in Clover. Returns each line item with id, name, price, unitQty, discounts, modifications, and taxRates. Required: m_id, order_id.
• Create Create a Clover order line item Create a new line item on an order in Clover. Returns the created line item with id, name, price, unitQty, and discounts. The request must include a price or an inventory item id, and an order is limited to 2,500 line items. Required: m_id, order_id.
• Get Get single Clover order line item by ID Get a single line item on an order by id. Returns the full line item object with id, item, name, price, priceWithModifiers, discounts, modifications, and taxRates. Required: id, m_id, order_id.
• Update Update a Clover order line item by ID Update a line item on an order by id. Returns the updated line item with id, name, price, unitQty, discounts, and modifications. Required: id, m_id, order_id.
• Delete Delete a Clover order line item by ID Delete (void) a line item from an order by id. Returns an empty 200 response on success. Required: id, m_id, order_id.
• Delete Clover order line items bulk delete Delete all line items for an order in Clover. Returns an empty 200 response on success. Required: m_id, order_id.
• Create Create a Clover order payment Create a payment record on a Clover order. Requires a positive amount and a valid tender ID; intended for logging external tenders (not Clover credit/debit tenders). Returns the created payment object including id, amount, tipAmount, taxAmount, result, and cardTransaction. Required: m_id, order_id.
• List List all Clover order payments List all payments for a Clover order, including total amount, tip amount, tax amount, and result status. Returns each payment's id, amount, tipAmount, taxAmount, result, and cardTransaction. Required: m_id, order_id.
• Get Get single Clover print event by ID Get a Clover print event by id for a merchant. Returns: id, orderRef, deviceRef, category, state, orderSnapshot, createdTime, modifiedTime, deletedTime, printTime. Required: m_id, id. Full event details return only while state is CREATED, PRINTING, or FAILED; successfully printed jobs are discarded and cannot be replayed.
• Create Create a Clover print event Submit a print request to a Clover merchant's default order printer. Returns the print event including id, orderRef, deviceRef, category, state, and printTime. Required: m_id.
• List List all Clover shift exports Download a CSV export of all shifts for a Clover merchant. Returns a raw CSV file download rather than JSON. Required: m_id.
• List List all Clover voided line item totals Get a summary of voided (deleted) line items and orders for a Clover merchant. Returns: printed, unprinted, price, priceWithQuantity, priceWithQuantityAndModifiers, deletedOrders, deletedItems, chartSummary. Required: m_id.
• List List all Clover attribute options List all options for an attribute in Clover. Required: m_id, attribute_id.
• List List all Clover categorized items List all items in a single Clover category. Returns items with their id, name, price, priceType, sku, code, and associated categories, tags, and tax rates. Required: m_id, cat_id.
• List List all Clover customer exports List every customer of a merchant in Clover as a CSV export, with optional filter and expand on customer fields. Returns each customer's id, firstName, lastName, emailAddresses, phoneNumbers, cards, addresses, and metadata. Required: m_id.
• Create Create a Clover customer metadatum Create or update the metadata (note, birthday, business name) for a Clover customer. Returns the saved metadata including note, businessName, dobYear, dobMonth, dobDay, modifiedTime, and the associated customer. Required: m_id, customer_id. Limits: businessName max 127 characters, note max 2000 characters.
• List List all Clover item categories List all categories of a single item in Clover. Max 1000 per page. Required: m_id, item_id.
• List List all Clover item tags List tags for a single item in Clover. Returns: id, name, showInReporting, printers. Required: m_id, item_id.
• List List all Clover items without revenue class List Clover inventory items that have no tag or revenue class for a merchant. Returns: id, name, alternateName, itemCode, sku, price, hidden, available, autoManage, defaultTaxRates, isRevenue, deleted, modifiedTime, tags, categories, taxRates, modifierGroups, itemStock, options. Required: m_id. Max 1000 per page.
• List List all Clover modifier group modifiers List all modifiers in a single Clover modifier group. Required: m_id, mod_group_id.
• Create Create a Clover sub category Create a new subcategory within a parent category in Clover. Returns: id, name, sortOrder, colorCode, parentCategory, deleted. Required: m_id, category_id, name. The subcategory inherits the parent category's hex color code when no colorCode is defined.
• Update Update a Clover sub category by ID Update an existing Clover subcategory by id — rename it or change its assigned color code. Returns: id, name, sortOrder, parentCategory, colorCode, deleted. Required: id, m_id, category_id.
• List List all Clover tagged items List the inventory items assigned to a tag in Clover. Returns: id, name, price, hidden, available, autoManage, alternateName, code, sku, priceType, defaultTaxRates, unitName, cost, isRevenue, stockCount, itemGroup, options, taxRates, modifierGroups, categories, tags, canonical, itemStock, modifiedTime, and 3 more. Required: m_id, tag_id.
• List List all Clover taxed items List Clover items associated with a specific tax rate. Returns: id, hidden, available, autoManage, itemGroup, options, name, alternateName, code, sku, price, priceType, defaultTaxRates, unitName, cost, isRevenue, stockCount, taxRates, modifierGroups, categories, tags, canonical, itemStock, modifiedTime, and 3 more. Required: m_id, tax_id.
• Create Create a Clover line item discount Create a discount on a line item for an order in Clover. Returns an empty response on success. Required: m_id, order_id, line_item_id, name.
• Delete Delete a Clover line item discount by ID Delete a discount from a line item on an order in Clover. Returns an empty response on success. Required: id, m_id, order_id, line_item_id.
• Create Create a Clover line item modification Apply a modification to a line item on a Clover order, creating a record of a modifier as it exists when applied. Returns: id, name, alternateName, amount, modifier, quantitySold. Required: m_id, order_id, line_item_id.
• Delete Delete a Clover line item modification by ID Remove a modification from a line item on a Clover order, deleting the record of an applied modifier by its UUID. Returns an empty 204 response on success. Required: m_id, order_id, line_item_id, id.
• Create Create a Clover order service charge Apply a service charge to a Clover order, setting its name and percentageDecimal as needed for the order. Returns an empty 200 response on success. Required: m_id, order_id.
• Delete Delete a Clover order service charge by ID Remove a service charge from a Clover order by id. Returns an empty 200 response on success. Required: id, m_id, order_id.
• Create Create a Clover order voided line item Create a list of voided line items for a Clover order, recording why each item was removed. Returns the created voided line item records including lineItem, reason, deleteType, removedBy, and clientEventType. Required: m_id, order_id.
• Create Create a Clover line item exchange Create or exchange a line item on a Clover order, replacing the line item old_line_item_id with the line item identified by exchange_id. Returns the line item record: id, name, price, discounts, modifications, taxRates. Required: m_id, order_id, old_line_item_id, exchange_id.
• List List all Clover merchant order fees List all service charges configured for a Clover merchant. Returns each order fee with id, name, amount, percentage, type, and serviceChargeUuid. Required: m_id.
• Get Get single Clover merchant order fee by ID Get a specific service charge configured for a Clover merchant by id. Returns: id, name, amount, percentage, createdTime, modifiedTime, deletedTime, type, serviceChargeUuid. Required: id, m_id.
• List List all Clover order fee line items List all service charges (order fee line items) applied to an order in Clover. Returns: id, item, colorCode. Required: m_id, order_id.
• Create Create a Clover order fee line item Create a service charge on an order in Clover. Returns the created fee line item record with id, item, and colorCode. Required: m_id, order_id.
• Get Get single Clover order fee line item by ID Get a specific service charge (order fee line item) applied to a Clover order. Returns: id, item, colorCode, name, alternateName, price, priceWithModifiers, priceWithModifiersAndItemAndOrderDiscounts, unitQty, unitName, discounts, modifications, refund, taxRates, payments, percentage, orderFeeType, and 22 more. Required: id, m_id, order_id.
• Delete Delete a Clover order fee line item by ID Remove a service charge (order fee line item) from a Clover order. Returns an empty 200 response on success. Required: id, m_id, order_id.
• Create Create a Clover cashout Request cashout of a Clover gift card's balance, removing the remaining balance from an active gift card account. Returns the cashed-out charge object's id. Required: source.
• Create Create a Clover charge capture Capture an existing uncaptured charge in Clover as step two of the two-part payment flow (the charge must have been created with capture set to false). Returns: amount, tax_amount, tip_amount, captured, id, and 41 more. Required: charge_id. Fails if the charge is already refunded, expired, or captured, or if an invalid capture amount is specified.
• Delete Delete a Clover customer source by ID Revoke a payment source (card or ACH token) from a Clover customer profile by its id. Returns: deleted, id, object. Required: id, customer_id.
• Delete Delete a Clover metered event by ID Delete an app billing metered event in Clover by id. Succeeds only if the event has not already been billed. Returns: id, appMetered, count, createdTime, modifiedTime, charge. Required: id, app_id, m_id, metered_id.
• Get Get single Clover metered event by ID Get an app billing metered event in Clover by id. Retrieves the event details on a merchant's app billing metered event. Returns: id, appMetered, count, createdTime, modifiedTime, charge. Required: id, app_id, m_id, metered_id.
• Update Clover modifier group layout adds bulk update Add one or more modifiers to a modifier group in Clover, replacing the group's layout with the modifier order you supply. Returns an empty response on success (200). Required: m_id, mod_group_id.
• Update Clover modifier group layout removes bulk update Remove one or more modifiers from a Clover modifier group by keeping only the modifier ids supplied in the request body. Returns an empty 200 response on success. Required: m_id, mod_group_id.
• Create Create a Clover reload Reload an active Clover gift card by adding an amount to its balance. Returns the resulting charge object for the reload, including its id. Required: source, amount, currency.
• List List all Clover modifier group items List all items in a single Clover modifier group. Returns each inventory item with id, name, price, priceType, itemStock, plus related categories, tags, tax rates, and modifier groups. Default 100, max 1000 items per page. Required: m_id, mod_group_id.
• List List all Clover employee payments List all payments under a specific employee in Clover, including total amount, tip amount, tax amount, and result status. Required: m_id, emp_id.
• Create Create a Clover merchant authorization Create an authorization on a payment in Clover. Returns: id, payment, tabName, amount, cardType, last4, authcode, token, type, note, externalReferenceId, closingPayment, createdTime, additionalCharges, transactionSequenceCounter, acquirerTerminalId. The amount must be greater than 0. Required: m_id.
• Delete Delete a Clover merchant authorization by ID Delete an authorization for a payment in Clover by id. Returns an empty 200 response on success. Required: id, m_id.
• Get Get single Clover merchant authorization by ID Get a single authorization by id for a Clover merchant. Returns: id, payment, tabName, amount, cardType, last4, authcode, token, type, note, externalReferenceId, closingPayment, createdTime, additionalCharges, transactionSequenceCounter, acquirerTerminalId. Required: id, m_id.
• List List all Clover merchant authorizations List all authorizations for a Clover merchant. An authorization is a card-issuer permission to charge a customer later, created via the Bar Tabs and Authorizations apps. Returns: id, payment, amount, last4, authcode, token, type, note. Required: m_id.
• Update Update a Clover merchant authorization by ID Update an authorization for a Clover merchant by id; the payment amount must be greater than 0 and have a type. Returns: id, payment. Required: id, m_id.
• Get Get single Clover merchant billing info by ID Get a merchant's app billing information in Clover, including the current subscription tier and trial status. Returns: id, appSubscription, isInTrial, billable, appBillable, planBillable, appExportable, planExportable, billingStartTime, status, daysLapsed. Required: id, app_id.
• Get Get single Clover merchant credit refund by ID Get a single Clover credit refund by id for a specific merchant, including taxes and tips. Returns: id, orderRef, device, createdTime, clientCreatedTime, credit, employee, germanInfo, appTracking, transactionInfo. Supports expand for credit, germanInfo, appTracking, and transactionInfo. Required: id, m_id.
• List List all Clover merchant credit refunds List Clover credit refunds associated with payments for a merchant, including taxes and tips. Returns: id, device, credit, employee. Supports expand for credit, germanInfo, appTracking, and transactionInfo. Required: m_id.
• Create Create a Clover merchant payment Update a Clover payment. Only lineItemPayments and employee.id (when the payment is a preauth with captured currently set to null) are processed — all other body properties are ignored. Returns the updated payment: id, amount, tipAmount, taxAmount, result. Required: m_id, payment_id.
• Get Get single Clover merchant payment by ID Get a single Clover payment by id, including its total amount, tip amount, tax amount, and result status. Returns: id, order, device, tender, amount, tipAmount, taxAmount, cashbackAmount, cashTendered, externalPaymentId, employee, offline, result, attributes, refunds, note, authorization, merchant, increments, and 25 more. Required: id, m_id.
• List List all Clover merchant payments List all payments for a Clover merchant, each with its total amount, tip amount, tax amount, and result status. Returns: id, order, device, tender, amount, employee, offline, result, attributes, refunds, note, authorization, merchant, increments. Required: m_id.
• Create Create a Clover activate Activate a physical or virtual gift card in Clover. Returns the activated gift card details as a charge object, including id, captured, and created. Required: source, amount, currency.
• Create Create a Clover balance inquiry Request the current balance on an active Clover gift card. Returns: status, gift_card. Required: source.
• Create Create a Clover card read Read a card's track data using a Clover device. Initiates a read card operation on the device and returns the card track data; the data is encrypted unless the card is not a financial card or its BIN has been allowlisted. Requires a JSON request body.
• Create Create a Clover card token Create a single-use or multi-pay card token in Clover for use with subsequent payments. Returns the created token object with fields defined by the Clover TokenResponse schema. Requires a JSON request body. Tokenization is not supported in Europe.
• Create Create a Clover credit receipt Deliver a credit receipt from a Clover device in the format specified in the request. Returns the delivery outcome from the Clover device; Clover's docs reference the response schema but do not enumerate its fields. Required: credit_id.
• Create Create a Clover credit Create a credit on a Clover device — a refund that is not associated with an existing payment. Returns a Clover CreditResponse for the processed credit. Required: amount.
• Get Get single Clover credit by ID Get a single credit from Clover by id, specifying its Clover credit UUID. Returns a Clover CreditResponse for that credit. Required: id.
• Create Create a Clover ecom order pay Pay for a Clover order by id, charging the payment source or attached customer. Returns the paid order object: id, amount, status, items, past_charges, and metadata. Required: order_id, customer.
• Create Create a Clover ecom order return Create a return for a Clover ecommerce order, refunding selected order items or amounts against existing payment charges. Returns the created order return object: id plus Clover-defined order_return fields. Required: order_id. The order must be paid or fulfilled.
• Create Create a Clover ecom payment Create a payment in Clover E-commerce, starting the payment flow for the requested transaction type. Returns the payment object with its id once the payment completes.
• Get Get single Clover ecom payment by ID Get a single Clover E-commerce payment by its Clover payment UUID. Returns the payment object including its id. Required: id.
• Action Clover ecom payments void Void a Clover E-commerce payment before it settles. Returns the payment object with its id. Clover may convert a void into a refund, and final payments cannot be voided more than 25 minutes after the payment. Required: payment_id, voidReason.
• Create Create a Clover ecommerce subscription Create a subscription under a plan in Clover Ecommerce, associating a customer with a plan and its billing details. Returns: object, id, customerUuid, collectionMethod, plan, merchantId, active, tipAmount, amount, startDate, endDate, note, lastRunDate, createdTime, modifiedTime, and 4 more. Required: plan_id, customerId, collectionMethod.
• Delete Delete a Clover ecommerce subscription by ID Delete a Clover Ecommerce subscription by id. Returns the deleted subscription with id, customerUuid, collectionMethod, active, amount, and plan. Required: id.
• Get Get single Clover ecommerce subscription by ID Get a single Clover Ecommerce subscription by id. Returns: object, id, customerUuid, collectionMethod, plan, merchantId, active, tipAmount, amount, startDate, endDate, note, lastRunDate, createdTime, modifiedTime, deletedTime, softDescriptor, level2, taxRateUuids. Required: id.
• List List all Clover ecommerce subscriptions List all Clover Ecommerce subscriptions for a merchant, filterable by plan, customer, collection method, and start/end date ranges. Returns: object, id, customerUuid, collectionMethod, plan, merchantId, active, tipAmount, amount, startDate, endDate, note, lastRunDate, createdTime, modifiedTime, deletedTime, and 3 more. Max 100 per page.
• Update Update a Clover ecommerce subscription by ID Update a Clover Ecommerce subscription by id, overriding plan values such as amount, tip, note, tax rates, and soft descriptor. Returns: object, id, customerUuid, collectionMethod, plan, merchantId, active, tipAmount, amount, startDate, endDate, note, lastRunDate, createdTime, modifiedTime, deletedTime, softDescriptor, and 2 more. Required: id.
• Create Create a Clover payment capture Capture a pre-auth payment in Clover by finishing a pre-auth transaction with the final amount. Returns Clover's CaptureResponse confirming the captured payment (field-level shape defined by the CaptureResponse schema). Required: payment_id, amount.
• Create Create a Clover payment increment Increment an authorization (pre-auth) in Clover: increase a transaction's authorized amount to verify the cardholder has sufficient funds for the purchase. Returns: authorization, paymentId. Required: payment_id, amount.
• Create Create a Clover payment receipt Deliver a payment receipt for a Clover payment in the format specified in the request. Returns: message, printJobId, printJobStatus. Required: payment_id.
• Create Create a Clover payment refund Refund a Clover payment, returning some or all of the payment amount to the cardholder. Returns the Clover RefundResponse object; the field set is defined by Clover's RefundResponse schema. Required: payment_id.
• Create Create a Clover payment tip adjust Tip adjust an unclosed Clover payment: add a tipAmount or update an existing tip — tips are not additive, and the most recent amount is applied at closeout. Returns an opaque Clover TipAdjustResponse confirmation; its fields are not enumerated in the source spec. Required: payment_id, tipAmount.
• Get Get single Clover payments external by ID Get a Clover payment by its externalPaymentId. Returns: payment. Required: id.
• Create Create a Clover refund receipt Deliver a refund receipt for a Clover refund in the format specified in the request. Returns the receipt delivery result (ReceiptDeliveryResponse); Clover's published documentation does not enumerate its fields. Required: refund_id.
• Create Create a Clover token Create a gift card token in Clover to activate a physical gift card or to create and activate a virtual gift card with a promotional code. Returns: id, token, gift_card. Requires gift_card.number (6, 13, 16, or 19 digits).
• Create Create a Clover void receipt Deliver a void receipt for a Clover payment in the format specified in the request; PRINT is the only supported format at this time. Returns Clover's ReceiptDeliveryResponse confirming the delivery — the upstream reference does not enumerate its fields. Required: payment_id.
• Create Create a Clover atomic order checkout Check out an atomic order in Clover by submitting an orderCart with line items, discounts, and modifications; Clover calculates the order totals, taxes, and service charges. Returns the orderCart object with id, currency, title, note, clientCreatedTime, serviceCharge, discounts, and lineItems. Required: m_id.
• Create Create a Clover cash drawer open Open the cash drawer attached to a Clover device. Sends an open signal to the specified device and returns the device's response payload with device-specific fields indicating whether the drawer may have opened.
• Create Create a Clover custom activity Launch a previously installed custom activity on a Clover device. Returns a CustomActivityResponse with activity-specific fields; if blocking, waits until the activity completes, otherwise it runs until another foreground operation executes. Requires a JSON request body (CustomActivityRequest). Required: action.
• Create Create a Clover device cancel Send a cancel command from the POS software to stop in-flight operations on a Clover device. Returns an acknowledgement object confirming the cancel was received — not that it was processed successfully.
• List List all Clover device cash drawers List the cash drawers discovered on a Clover device. Returns: id, name, number. An entry means the drawer is currently connected or an available hardware port allows one to be connected — local RJ12-type drawers may be listed even when not physically attached, while USB drawers only appear if connected at the time of the call.
• List List all Clover device cash events List all cash events recorded for a specific device in Clover, such as drawer loads, transactions, and counts. Required: m_id, device_id.
• Create Create a Clover device display Display a text message on an idle Clover terminal by sending the text string to the device's display screen. Returns a JSON acknowledgement object confirming the text was shown to the customer. Required: text.
• Create Create a Clover device display order Display an order screen on an idle Clover device terminal so the customer can review the purchase before a payment request starts. Values sent are shown as-is and are not used in calculations or order updates. Requires a JSON display-order request body (schema: DisplayOrderRequest). Returns a generic JSON confirmation object.
• Create Create a Clover device notification Push a notification message to a Clover device that has your app installed and is listening for notifications. Returns a success response with no documented body. The data payload is limited to 4000 characters. Required: app_id, device_id.
• Create Create a Clover device ping Ping a Clover device (POST) to verify that your app can connect to it; a 200 response means the device was successfully reached. Returns a connectivity confirmation body whose fields Clover's docs do not enumerate.
• List List all Clover device pings Verify connectivity to a Clover device with a GET ping; a 200 response means the device was successfully reached. Returns a connectivity confirmation body whose fields Clover's docs do not enumerate.
• Create Create a Clover device printer List the printers connected to a Clover device via the POST variant of the retrieve-printers endpoint. Returns: printers. Sends no request body.
• List List all Clover device printers List the printers connected to a Clover device. Returns: id, model, name.
• Create Create a Clover device read confirmation Send a yes-no confirmation prompt to a Clover terminal and retrieve the customer's answer. Returns the confirmation result as a boolean (true = confirmed, false = declined). Requires a confirmation request body. Required: text.
• Create Create a Clover device read input Get a text response from a Clover device by displaying a request for information to the customer; the request can also specify a data entry format to make it easier for the customer to provide their information. Returns a text response based on the customer's input. Required: format, text.
• Create Create a Clover device read signature Capture a customer's signature by displaying the signature entry screen on a Clover device. Returns the captured signature image data in the requested format. Requires a JSON request body. Not needed for payment signatures — the screen appears automatically when merchant settings require one.
• Create Create a Clover device read tip Display a tip selection prompt on a Clover device asking the customer to choose a tip amount or percentage. Returns the customer's selected tip as an integer (IntegerResponse). Requires a TipDisplayRequest request body.
• Create Create a Clover device receipt option Display receipt options on a Clover device, presenting the customer with choices for their transaction receipt. Returns the customer's selection as a ReceiptOptionsResponse object; its field-level shape is defined by the vendor's ReceiptOptionsResponse schema. Send a JSON body matching the vendor's ReceiptOptionsRequest schema.
• Update Clover device resets bulk update Reset a Clover device to its initial state, cancelling all in-flight commands from the POS software. Returns an opaque JSON acknowledgment confirming only that the reset request was received, not that the reset was processed successfully. Target the device with the deviceId query parameter.
• Create Create a Clover device send debug Trigger a Clover device to send its debug logs to Clover's servers, logging your message to the device log so you can mark a specific event or sequence for troubleshooting. Returns an empty acknowledgement object on success — the server documents no response body fields. Required: message. Rate-limited to one successful request per device every 30…
• List List all Clover device status Get the current status of a Clover device. Returns the device's status payload with its status field, as defined by Clover's DeviceStatusResponse schema.
• Create Create a Clover device thank yous Display a thank you screen on an idle Clover terminal. Returns a bare acknowledgement object with no enumerated fields; a 200 confirms the screen was shown to the customer. Takes no request body or query parameters.

No tools match your search.