Clover

Applies a modifier to an order line item and snapshots the modifier's current name and price as a modification record.

Applies 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.

Calculates and previews an order cart, including totals, taxes, discounts, and service charges, without persisting an order.

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

Records 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.

Creates an order with line items, modifiers, discounts, and service charges while Clover calculates inventory-based totals and taxes. Maximum 3,000 line items.

Creates an inventory variant attribute within an item group, optionally with its initial options.

Create an authorization for a payment. This has financial consequences and is not safely retryable without first checking whether Clover created the authorization.

Creates a customer record for the connected merchant with the supplied identity and contact details.

Creates a vaulted credit or debit card record for a customer. `first6` and `last4` are required.

Creates a merchant inventory discount with a fixed amount or percentage for later application.

Applies a named fixed-amount or percentage discount to one order line item.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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