+Beyond-Bot.ai + Clover
Manage Clover merchant, inventory, customer, employee, order, payment, cash, notification, app, and print data through the regional Platform REST API.
What You Can Do with this Integration
Automate Data Entry
Automatically sync new contacts or deals from Beyond-Bot.ai to Clover.
Enrich Customer Profiles
Use Beyond-Bot.ai to find and add new information to your records in Clover.
Trigger Workflows
Start automated workflows in Clover based on conversations with your virtual expert.
Available Actions
Here are the specific actions your virtual expert can perform within Clover.
Apply Modification To Line Item
Applies a modifier to an order line item and snapshots the modifier's current name and price as a modification record.
Apply Order Service Charge
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.
Checkout Atomic Order
Calculates and previews an order cart, including totals, taxes, discounts, and service charges, without persisting an order.
Create Address For Customer
Adds a postal address to an existing customer record; it does not create the customer.
Create App Billing Metered Event
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.
Create Atomic Order
Creates an order with line items, modifiers, discounts, and service charges while Clover calculates inventory-based totals and taxes. Maximum 3,000 line items.
Create Attribute
Creates an inventory variant attribute within an item group, optionally with its initial options.
Create Authorization On Payment
Create an authorization for a payment. This has financial consequences and is not safely retryable without first checking whether Clover created the authorization.
Create Customer
Creates a customer record for the connected merchant with the supplied identity and contact details.
Create Customer Card
Creates a vaulted credit or debit card record for a customer. `first6` and `last4` are required.
Create Discount
Creates a merchant inventory discount with a fixed amount or percentage for later application.
Create Discount On Line Item
Applies a named fixed-amount or percentage discount to one order line item.
Create Discount On Order
Applies a named fixed-amount or percentage discount to an order subtotal, not a specific line item.
Create Email Address For Customer
Adds an email address to an existing customer record; it does not create the customer.
Create Employee
Creates a merchant employee profile with a required name and optional login, contact, and role details.
Create Inventory Item
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.
Create Item Category
Creates an inventory category used to organize items in Clover Register.
Create Item Category Associations
Creates one or more associations between inventory items and categories or subcategories. Every tuple requires both `category.id` and `item.id`.
Create Item Group
Creates an item group for related inventory variants and their attributes.
Create Item Modifier Group Associations
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`.
Create Item Option Associations
Creates one or more associations between Clover options and inventory items. Every tuple requires both `option.id` and `item.id`.
Create Item Stock
Creates the stock quantity and optional low-stock alert threshold for one inventory item.
Create Item Tax Rate Associations
Creates one or more associations between inventory items and tax rates. Every tuple requires both `item.id` and `taxRate.id`.
Create Merchant Opening Hours
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': []}`.
Create Modifier
Creates a named modifier with a price adjustment inside a specific modifier group.
Create Modifier Group
Creates a new modifier group. After you create a modifier group, you can associate modifiers with the group.
Create Multiple Inventory Items
Creates multiple inventory items in one request; use Update Inventory Items to patch existing items instead.
Create Notification For App
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.
Create Notification For Device
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.
Create Option
Creates a named option within an inventory attribute, such as `Small` for a `Size` attribute.
Create Order Line Item
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.
Create Order Line Items Bulk
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.
Create Order Type Category Associations
Creates associations that limit an order type to specific merchant categories. Every tuple requires both resource IDs.
Create Order Type For Merchant
Creates a custom order type for the merchant, such as dine-in, delivery, or takeout.
Create Payment Record On Order
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.
Create Phone Number For Customer
Adds a phone number to an existing customer record; it does not create the customer.
Create Role
Creates a merchant employee role based on a Clover system role.
Create Shift For Employee
Creates a time-clock shift for one employee, including clock-in/out times, cash tips, or override details.
Create Subcategory
Creates a subcategory within a parent inventory category; it inherits the parent's color when one is set.
Create Tag
Creates an inventory tag for reporting, with optional item and printer associations.
Create Tag Item Associations
Creates one or more associations between Clover tags and inventory items. Every tuple requires both `tag.id` and `item.id`.
Create Tax Rate
Creates a merchant tax rate as a percentage or flat amount, optionally making it the default or associating items.
Create Tender
Creates a merchant-level custom tender and returns its generated identifier.
Delete All Line Items In Order
Deletes every line item from an order. This is destructive; verify the order before calling.
Delete App Billing Metered Event
Deletes an unbilled app metered event. Billed events cannot be deleted; verify the event before calling.
Delete Attribute
Deletes an inventory variant attribute. This is destructive; verify the attribute identifier before calling.
Delete Authorization
Permanently delete a payment authorization. Only target an authorization the caller intends to remove; repeat only after confirming whether the first request succeeded.
Delete Categories
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.
Delete Customer
Deletes a customer from the connected merchant. This is destructive; verify the customer identifier before calling.
Delete Customer Address
Deletes one address from a customer. This is destructive; verify both identifiers before calling.
Delete Customer Card
Deletes one vaulted card record from a customer. This is destructive; verify both identifiers before calling.
Delete Customer Email Address
Deletes one email address from a customer. This is destructive; verify both identifiers before calling.
Delete Customer Phone Number
Deletes one phone number from a customer. This is destructive; verify both identifiers before calling.
Delete Employee
Deletes an employee from the connected merchant. This is destructive; verify the employee identifier before calling.
Delete Inventory Discount
Deletes a merchant inventory discount. This is destructive; verify the discount identifier before calling.
Delete Inventory Item
Deletes an inventory item. This is destructive; verify the item identifier before calling.
Delete Item Category
Deletes an inventory category. This is destructive; verify the category identifier before calling.
Delete Item Group
Deletes an inventory item group. This is destructive; verify the group identifier before calling.
Delete Item Stock
Deletes the stock record for an inventory item. This is destructive; verify the item identifier before calling.
Delete Line Item Discount
Removes a discount from an order line item. This changes order pricing; verify all identifiers before calling.
Delete Merchant Opening Hours
Deletes one merchant opening-hours interval. This is destructive; verify the interval identifier before calling.
Delete Modifier
Deletes one modifier from a modifier group. This is destructive; verify both identifiers before calling.
Delete Modifier Group
Deletes a modifier group and every modifier in it. This is destructive; verify the group identifier before calling.
Delete Modifier Groups
Permanently deletes the modifier groups identified by a comma-separated list of IDs, including every modifier in those groups. Get IDs from List Modifier Groups.
Delete Multiple Inventory Items
Permanently deletes the inventory items identified by a comma-separated list of item IDs. Get IDs from List Inventory Items and target only intended items.
Delete Option
Deletes an option from an inventory attribute. This is destructive; verify both identifiers before calling.
Delete Order
Deletes an order. This is destructive; verify the order identifier and current state before calling.
Delete Order Discount
Removes a discount from an order. This changes order pricing; verify both identifiers before calling.
Delete Order Line Item
Deletes a line item from an order. This is destructive and changes the order; verify both identifiers before calling.
Delete Order Type
Deletes a merchant order type. This is destructive; verify the order-type identifier before calling.
Delete Role
Deletes a merchant employee role. This is destructive; verify the role identifier before calling.
Delete Shift
Deletes one employee shift. Clover requires `account_id` to identify an employee permitted to edit shifts.
Delete Subcategory
Deletes a subcategory and reassigns its items to the parent category. This is destructive; verify the subcategory identifier before calling.
Delete Tag
Deletes an inventory tag. This is destructive; verify the tag identifier before calling.
Delete Tags
Permanently deletes the tags identified by a comma-separated list of tag IDs. Get IDs from List Tags and target only intended tags.
Delete Tax Rate
Deletes a merchant tax rate. This is destructive; verify the tax-rate identifier before calling.
Delete Tender
Deletes a merchant tender. This is destructive; verify the tender identifier before calling.
Exchange Order Line Item
Creates 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.
Export Customers Csv
Exports customers as CSV. Use `filter` to export only matching customers and `expand` to include selected related address, contact, card, or metadata fields.
Export Shifts Csv
Exports merchant shifts as CSV for a required effective clock-in time window.
Get App Billing Metered Event
Returns one metered billing event recorded for a merchant's app subscription.
Get Attribute
Returns one inventory variant attribute with the item-group and option references present in Clover's response.
Get Authorization
Retrieve one Clover payment authorization by identifier.
Get Category
Returns one inventory category, including its Register sort order and optional item expansion.
Get Configured Service Charge
Returns one service charge configured for the merchant, identified by `service_charge_id`.
Get Credit Refund
Retrieve one Clover credit refund, including its credit, order, device, employee, and transaction details.
Get Customer
Returns one customer profile, with addresses, email addresses, phone numbers, cards, or metadata when expanded.
Get Default Service Charge
Returns the merchant's default configured service charge.
Get Device Provisioned To Merchant
Returns one Clover device provisioned to the connected merchant.
Get Discount
Returns one merchant inventory discount, including its fixed amount or percentage.
Get Employee
Returns one merchant employee profile, with assigned roles or related shifts, payments, and orders when expanded.
Get Inventory Item
Returns one inventory item with pricing, availability, SKU, and requested related resources.
Get Item Group
Returns one inventory item group and its related variants or attributes when expanded.
Get Item Stock
Returns the current stock quantity and alert threshold for one inventory item.
Get Item Subcategory Associations
Returns an inventory item and, with `expand=categories.items`, its category and subcategory associations; subcategories have a `parentCategory`.
Get Legacy Sync Token
Retrieves 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.
Get Merchant
Returns the connected merchant's business profile and requested related resources.
Get Merchant Address
Returns the connected merchant's business address.
Get Merchant App Billing Information
Returns a merchant's app-billing status, including the current subscription tier and trial status.
Get Merchant Opening Hours
Returns one merchant opening-hours interval by identifier.