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.
Apply Order Service ChargeApplies a configured merchant service charge or creates an ad-hoc order-fee line item on an order.
Checkout Atomic OrderCalculates and previews an order cart, including totals, taxes, discounts, and service charges, without persisting an order.
Create Address For CustomerAdds a postal address to an existing customer record; it does not create the customer.
Create App Billing Metered EventRecords metered app usage and bills the merchant at the configured price; `count` defaults to 1.
Create Atomic OrderCreates an order with line items, modifiers, discounts, and service charges while Clover calculates inventory-based totals and taxes.
Create AttributeCreates an inventory variant attribute within an item group, optionally with its initial options.
Create Authorization On PaymentCreate an authorization for a payment.
Create CustomerCreates a customer record for the connected merchant with the supplied identity and contact details.
Create Customer CardCreates a vaulted credit or debit card record for a customer.
Create DiscountCreates a merchant inventory discount with a fixed amount or percentage for later application.
Create Discount On Line ItemApplies a named fixed-amount or percentage discount to one order line item.
Create Discount On OrderApplies a named fixed-amount or percentage discount to an order subtotal, not a specific line item.
Create Email Address For CustomerAdds an email address to an existing customer record; it does not create the customer.
Create EmployeeCreates a merchant employee profile with a required name and optional login, contact, and role details.
Create Inventory ItemCreates an inventory item.
Create Item CategoryCreates an inventory category used to organize items in Clover Register.
Create Item Category AssociationsCreates one or more associations between inventory items and categories or subcategories.
Create Item GroupCreates an item group for related inventory variants and their attributes.
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.
Create Item Option AssociationsCreates one or more associations between Clover options and inventory items.
Create Item StockCreates the stock quantity and optional low-stock alert threshold for one inventory item.
Create Item Tax Rate AssociationsCreates one or more associations between inventory items and tax rates.
Create Merchant Opening HoursCreates merchant opening hours.
Create ModifierCreates a named modifier with a price adjustment inside a specific modifier group.
Create Modifier GroupCreates a new modifier group.
Create Multiple Inventory ItemsCreates multiple inventory items in one request; use Update Inventory Items to patch existing items instead.
Create Notification For AppSend a message to devices that have the connected Clover app installed and are listening for notifications.
Create Notification For DevicePush a message to a device that has the connected Clover app installed and is listening for notifications.
Create OptionCreates a named option within an inventory attribute, such as `Small` for a `Size` attribute.
Create Order Line ItemCreates one line item for a standard or Multiple Service Charges order; provide `price` or `item.
Create Order Line Items BulkCreates up to 100 priced line items for either a standard or Multiple Service Charges order.
Create Order Type Category AssociationsCreates associations that limit an order type to specific merchant categories.
Create Order Type For MerchantCreates a custom order type for the merchant, such as dine-in, delivery, or takeout.
Create Payment Record On OrderRecords an externally processed payment on an order for bookkeeping; it does not process a Clover credit or debit payment.
Create Phone Number For CustomerAdds a phone number to an existing customer record; it does not create the customer.
Create RoleCreates a merchant employee role based on a Clover system role.
Create Shift For EmployeeCreates a time-clock shift for one employee, including clock-in/out times, cash tips, or override details.
Create SubcategoryCreates a subcategory within a parent inventory category; it inherits the parent's color when one is set.
Create TagCreates an inventory tag for reporting, with optional item and printer associations.
Create Tag Item AssociationsCreates one or more associations between Clover tags and inventory items.
Create Tax RateCreates a merchant tax rate as a percentage or flat amount, optionally making it the default or associating items.
Create TenderCreates a merchant-level custom tender and returns its generated identifier.
Delete All Line Items In OrderDeletes every line item from an order.
Delete App Billing Metered EventDeletes an unbilled app metered event.
Delete AttributeDeletes an inventory variant attribute.
Delete AuthorizationPermanently delete a payment authorization.
Delete CategoriesPermanently deletes the categories identified by a comma-separated list of category IDs.
Delete CustomerDeletes a customer from the connected merchant.
Delete Customer AddressDeletes one address from a customer.
Delete Customer CardDeletes one vaulted card record from a customer.
Delete Customer Email AddressDeletes one email address from a customer.
Delete Customer Phone NumberDeletes one phone number from a customer.
Delete EmployeeDeletes an employee from the connected merchant.
Delete Inventory DiscountDeletes a merchant inventory discount.
Delete Inventory ItemDeletes an inventory item.
Delete Item CategoryDeletes an inventory category.
Delete Item GroupDeletes an inventory item group.
Delete Item StockDeletes the stock record for an inventory item.
Delete Line Item DiscountRemoves a discount from an order line item.
Delete Merchant Opening HoursDeletes one merchant opening-hours interval.
Delete ModifierDeletes one modifier from a modifier group.
Delete Modifier GroupDeletes a modifier group and every modifier in it.
Delete Modifier GroupsPermanently deletes the modifier groups identified by a comma-separated list of IDs, including every modifier in those groups.
Delete Multiple Inventory ItemsPermanently deletes the inventory items identified by a comma-separated list of item IDs.
Delete OptionDeletes an option from an inventory attribute.
Delete OrderDeletes an order.
Delete Order DiscountRemoves a discount from an order.
Delete Order Line ItemDeletes a line item from an order.
Delete Order TypeDeletes a merchant order type.
Delete RoleDeletes a merchant employee role.
Delete ShiftDeletes one employee shift.
Delete SubcategoryDeletes a subcategory and reassigns its items to the parent category.
Delete TagDeletes an inventory tag.
Delete TagsPermanently deletes the tags identified by a comma-separated list of tag IDs.
Delete Tax RateDeletes a merchant tax rate.
Delete TenderDeletes a merchant tender.
Exchange Order Line ItemCreates a replacement line item under the client-supplied `line_item_id` and exchanges `old_line_item_id` for it.
Export Customers CsvExports customers as CSV.
Export Shifts CSVExports merchant shifts as CSV for a required effective clock-in time window.
Get App Billing Metered EventReturns one metered billing event recorded for a merchant's app subscription.
Get AttributeReturns one inventory variant attribute with the item-group and option references present in Clover's response.
Get AuthorizationRetrieve one Clover payment authorization by identifier.
Get CategoryReturns one inventory category, including its Register sort order and optional item expansion.
Get Configured Service ChargeReturns one service charge configured for the merchant, identified by `service_charge_id`.
Get Credit RefundRetrieve one Clover credit refund, including its credit, order, device, employee, and transaction details.
Get CustomerReturns one customer profile, with addresses, email addresses, phone numbers, cards, or metadata when expanded.
Get Default Service ChargeReturns the merchant's default configured service charge.
Get Device Provisioned To MerchantReturns one Clover device provisioned to the connected merchant.
Get DiscountReturns one merchant inventory discount, including its fixed amount or percentage.
Get EmployeeReturns one merchant employee profile, with assigned roles or related shifts, payments, and orders when expanded.
Get Inventory ItemReturns one inventory item with pricing, availability, SKU, and requested related resources.
Get Item GroupReturns one inventory item group and its related variants or attributes when expanded.
Get Item StockReturns the current stock quantity and alert threshold for one inventory item.
Get Item Subcategory AssociationsReturns an inventory item and, with `expand=categories.
Get MerchantReturns the connected merchant's business profile and requested related resources.
Get Merchant AddressReturns the connected merchant's business address.
Get Merchant App Billing InformationReturns a merchant's app-billing status, including the current subscription tier and trial status.
Get Merchant Opening HoursReturns one merchant opening-hours interval by identifier.
Get Merchant Payment Gateway ConfigurationReturns the connected merchant's payment-gateway configuration and supported capabilities.
Get Merchant PropertiesReturns the connected merchant's operational properties and feature settings.
Get ModifierReturns one modifier from a specific modifier group, including its name and price adjustment.
Get Modifier GroupReturns one modifier group and its configuration, with related modifiers or items when expanded.
Get Option For AttributeReturns one option from a specific inventory attribute, including its item references.
Get OrderReturns one order with totals, state, and any related resources requested through `expand`.
Get Order Line ItemReturns one line item from any order, including age-restriction or Multiple Service Charges fields when Clover provides them.
Get Order TypeReturns one merchant order type, including taxability and category-filter settings.
Get PaymentRetrieve one Clover payment, including amount, tax, tip, and result status.
Get Print EventGet a print event for the connected Clover merchant by event ID.
Get RefundRetrieve one Clover refund, including associated payment, tax, tip, and transaction details.
Get RoleReturns one merchant employee role and its base system role.
Get Service Charge Applied To OrderReturns one service-charge line item already applied to an order.
Get ShiftRetrieves one shift by ID.
Get TagReturns one inventory tag and its item or printer associations when expanded.
Get Tax Exemption RuleReturns one tax exemption rule that links order types and items to excluded tax rates.
Get Tax RateReturns one merchant tax rate, including its rate, type, and default status.
Get TenderReturns one merchant tender and its payment-handling settings.
Get Tip SuggestionReturns one merchant tip suggestion, including its percentage or flat amount.
Get Voided Line Item TotalsReturns deleted line-item and order totals for a required caller-supplied deletedTime window.
List App Billing Metered EventsLists billing events recorded for one app metered-event type, such as `reservation`.
List AttributesLists inventory variant attributes, such as size or color.
List AuthorizationsList payment authorizations for the connected merchant.
List Cash EventsList cash events for the merchant, one device, or one employee.
List CategoriesLists inventory categories in Register sort order, optionally with associated items.
List Categories Of ItemRetrieves all categories of an item.
List Category SubcategoriesReturns a category with its subcategories expanded by default; use `subCategories.
List Configured Service ChargesLists service charges configured for the merchant; use the applied-service-charge tools for charges already attached to an order.
List Credit RefundsList credit refunds for the connected merchant, including associated tax and transaction details.
List CustomersLists customer records for the connected merchant, optionally filtered or expanded with related contact data.
List Devices Provisioned To MerchantLists Clover devices provisioned to the connected merchant, optionally filtered by documented device fields.
List DiscountsLists the merchant's inventory discounts.
List Discounts For OrderLists discounts currently applied at the order level; line-item discounts are returned by the line-item tools.
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`.
List EmployeesList employees for the connected Clover merchant, optionally filtered or expanded.
List Inventory ItemsLists inventory items for the connected merchant.
List Inventory Without Revenue ClassLists inventory items that have no revenue-class tag.
List Item GroupsLists item groups used to organize related inventory variants and attributes.
List Items By Tax RateLists inventory items associated with the specified tax rate.
List Items For TagLists inventory items associated with one tag.
List Items In CategoryRetrieves all items in a category.
List Items In Modifier GroupRetrieves a list of all items in a single modifier group.
List Item StocksLists stock quantities and alert thresholds for the merchant's inventory items.
List Item TagsLists inventory tags associated with one item.
List Merchant Opening HoursLists the connected merchant's opening-hours intervals.
List Modifier GroupsLists modifier groups that organize selectable item modifiers.
List ModifiersRetrieves all modifiers from all modifier groups.
List Modifiers In Modifier GroupRetrieves a list of modifiers in a single modifier group.
List OptionsLists options across all inventory variant attributes.
List Options For AttributeRetrieves all available variants or options associated with an attribute.
List Order Line ItemsLists line items from any order, including age-restriction or Multiple Service Charges fields when Clover provides them.
List OrdersLists orders through Clover's merchant `/orders` route, which requires `Read orders`, with filtering, expansion, and offset pagination.
List Order TypesLists merchant-defined order types and their system-type or category settings.
List PaymentsList payments for the merchant, one order, or one employee.
List RefundsList merchant refunds, including taxes and tips.
List RolesRetrieves all system and employee roles for a merchant's business.
List Service Charges Applied To OrderLists service-charge line items already applied to an order; use configured-service-charge tools for merchant templates.
List ShiftsList shifts for the connected merchant or, when `employee_id` is provided, for one employee.
List System Order TypesLists Clover's system order-type categories used to classify merchant-defined order types, such as takeout.
List Tag Item AssociationsLists every association between the merchant's inventory tags and items.
List TagsLists the merchant's inventory tags.
List Tax Exemption RulesLists tax exemption rules that link order types and items to tax rates excluded from those items.
List Tax RatesLists percentage and flat-amount tax rates.
List TendersRetrieves all tenders for a merchant.
List Tip SuggestionsRetrieves all tip suggestions for a merchant, for example: flat tip or percentage.
Record Voided Line ItemsRecords voided line items on an order for reporting, including their quantities and reasons.
Remove Item Category AssociationsPermanently removes specific item-category associations or all associations on one supplied side.
Remove Item Modifier Group AssociationsPermanently removes a specific item-modifier-group association or all associations on one supplied side.
Remove Item Option AssociationsPermanently removes specific option-item associations or all associations on one supplied side.
Remove Item Tax Rate AssociationsPermanently removes specific item-tax-rate associations or all associations on one supplied side.
Remove Modification From Line ItemRemoves an applied modifier snapshot from an order line item.
Remove Order Service ChargePermanently removes a configured service charge or order-fee line item from an order.
Remove Tag Item AssociationsPermanently removes specific tag-item associations or all associations on one supplied side.
Submit Print RequestQueues content for the merchant's default order printer.
Update Address For CustomerUpdates one postal address on an existing customer record.
Update AttributeUpdates an inventory variant attribute, including its name, item group, or option references.
Update AuthorizationUpdate a payment authorization.
Update CategoryUpdates an inventory category's name, Register sort order, color, or item associations.
Update Category Sort OrdersUpdates Register menu sort positions for up to 1,000 inventory categories in one request.
Update CustomerUpdates one customer's identity, contact, marketing, or metadata fields using the supplied values.
Update Customer CardUpdates a customer's vaulted credit or debit card record.
Update DiscountUpdates a merchant inventory discount's name, fixed amount, percentage, or approval reference.
Update Email Address For CustomerUpdates one email address on an existing customer record.
Update EmployeeUpdates one employee's name, login, contact, or role details using the supplied fields.
Update Inventory ItemUpdates one inventory item's supplied fields.
Update Inventory ItemsPatches multiple existing inventory items in one request without replacing omitted fields; use Create Multiple Inventory Items for new records.
Update Item GroupUpdates an inventory item group's name, member items, or variant attributes.
Update Item StockUpdates the stock quantity or low-stock alert threshold for one inventory item.
Update MerchantUpdates the connected merchant's business profile using the supplied fields.
Update Merchant Opening HoursUpdates one merchant opening-hours interval, including its day and start or end time.
Update Merchant PropertiesUpdates the connected merchant's operational properties and feature settings.
Update ModifierUpdates a modifier's name, price adjustment, or availability; Clover does not allow moving it to another modifier group.
Update Modifier GroupUpdates a modifier group's name, selection rules, or item references.
Update Modifier Group Sort OrdersUpdate the priorities for a collection of up to 200 modifier groups at a time.
Update OptionUpdates a named option within a specific inventory attribute, including its item associations.
Update OrderUpdates one order using the supplied order fields; omitted fields remain unchanged.
Update Order Line ItemUpdates one line item on either a standard or Multiple Service Charges order using the supplied fields.
Update Order TypeUpdates a merchant order type's label, taxability, system classification, or category settings.
Update PaymentUpdate payment line-item allocations or the employee on an uncaptured preauthorization.
Update Phone Number For CustomerUpdates one phone number on an existing customer record.
Update RoleUpdates a merchant employee role's name, base system role, or employee references.
Update ShiftUpdates one employee shift's clock-in/out times, cash tips, or override details.
Update SubcategoryUpdates a subcategory's name or color within its parent inventory category.
Update TagUpdates an inventory tag's name, reporting behavior, or item and printer associations.
Update Tax RateUpdates a merchant tax rate's name, rate, type, or default status.
Update TenderUpdates a merchant tender's label, availability, cash-drawer, tipping, or processing settings.
Update Tip SuggestionUpdates a merchant tip suggestion's name, percentage, flat amount, or enabled status.
Upsert Customer MetadataCreates or updates a customer's note, birthday, and business-name metadata.
Upsert Custom OrderCreates or updates a custom order for merchants with or without Multiple Service Charges.