Available Clover APIs

Merchants

Get a single merchant

X

Get a merchant's address

X

Get a merchant's payment gateway configuration

X

Get a merchant's properties

X

Get default service charge for a merchant

X

Get all tip suggestions for a merchant

X

Get a single tip suggestion

X

Get all order types for a merchant

X

Get a single order type

X

Return a list of system order types

X

Get all roles from a merchant

X

Get a single role

X

Get all tenders for a merchant

X

Get a single merchant tender

X

Get a list this merchant opening hours

X

Get a specific set of merchant opening hours

X

Get all devices provisioned to a merchant

X

Get a single device provisioned to a merchant

X

Cash

Get all cash events

X

Get all cash events for an employee

X

Get all cash events for a device

X

Customers

Get a list of customers

X

Get a single customer

X

Employees

Get all employees

X

Get a single employee

X

Get all shifts

X

Get a single shift

X

Get all shifts for an employee

X

Get a single shift for an employee

X

Get all orders for an employee

X

Inventory

Get all inventory items

X

Get a single inventory item

X

Get the stock of all inventory items

X

Get the stock of an inventory item

X

Get all item groups

X

Get a single item group

X

Get all tags

X

Get a single tag

X

Get tags for a single item

X

Get all items for a single tag

X

Get all tax rates

X

Get a single tax rate

X

Get all categories

X

Get a category

X

Get all items in a single category

X

Get all categories of a single item

X

Get items by tax rate

X

Get all modifier groups

X

Get a modifier group

X

Get all items in a single modifier group

X

Get all modifiers

X

Get all modifiers belonging to a single modifier group

X

Get a single modifier belonging to a single modifier group

X

Get all attributes

X

Get a single attribute

X

Get all options

X

Get all options with a given attribute

X

Get an attribute and option by id

X

Get all discounts

X

Get a single discount

X

Get all tax exemption rules

X

Get an individual tax exemption rule

X

Orders

Gets a list of orders

X

Get a single order

X

Get all discounts for an order

X

Get all line items for an order

X

Get a line item

X

Get summary about line items and orders which were deleted

X

Get order line items that were recorded after a void

X

Payments

Get all payments for an order

X

Get all authorizations

X

Get a single authorization

X

Get all payments

X

Get a single payment

X

Get all refunds for a merchant

X

Get a single refund

X

Get a list of credits

X

Get a single credit

X

Get a list of credit refunds

X

Get a credit refund

X

Merchants

Update a merchant

X

Update merchant properties

X

Update a single tip suggestion

X

Create order type for merchant

X

Update a single order type

X

Delete an order type

X

Create or delete a order type category

X

Create a role

X

Update a single role

X

Delete a role

X

Adds a new tender

X

Updates an existing tender

X

Delete an existing tender

X

Create a set of merchant opening hours

X

Update a set of merchant opening hours

X

Delete a set of merchant opening hours

X

Customers

Create a customer

X

Updates a customer

X

Delete a customer

X

Create a phone number for a customer

X

Updates a phone number for a customer

X

Delete a phone number for a customer

X

Create an email address for a customer

X

Updates an email address for a customer

X

Delete an email address for a customer

X

Create an address for a customer

X

Updates an address for a customer

X

Delete an address for a customer

X

Create a credit/debit card entry for a customer

X

Updates a credit/debit card record for a customer

X

Delete a customer card

X

Birthday

Create note business name for a customer

X

Employees

Create an employee

X

Updates an employee

X

Delete an employee

X

Create shift for an employee

X

Updates a single shift

X

Delete a single shift

X

Inventory

Create an inventory item

X

Updates an existing inventory item

X

Delete an inventory item

X

Update the stock of an inventory item

X

Delete the stock of an inventory item

X

Create an item group

X

Updates an item group

X

Delete an inventory item group

X

Create a tag

X

Updates a single tag

X

Delete a tag

X

Create a tax rate for a merchant

X

Update a single tax rate

X

Delete a single tax rate

X

Create an item category

X

Update a category

X

Delete a single item category

X

Create or delete an item/category association

X

Create or delete a tax rate item

X

Create a modifier group

X

Updates a modifier group

X

Delete a modifier group

X

Create or delete item to modifier group associations

X

Update the priorities for a collection of up to 200 modifier groups at a time

X

Reorder modifiers in the modifier group based on the ordering of the incoming modifier id list. remove deleted modifiers. add missing modifiers.

X

Create a modifier

X

Updates a single modifier

X

Delete a single modifier

X

Create an attribute

X

Updates a single attribute

X

Delete a single attribute

X

Create an option

X

Updates a single attribute

X

Delete an option

X

Create or delete item/option association

X

Create an discount

X

Update an discount

X

Delete a discount

X

Create multiple inventory items

X

Update existing inventory items

X

Delete multiple inventory items

X

Orders

Create an order

X

Updates an order

X

Delete an order

X

Create a discount on an order

X

Create a discount on a line item

X

Delete a discount on an order

X

Delete a discount on a line item

X

Create a new line item

X

Updates a line item

X

Void a line item

X

Apply a modification to a line item

X

Remove a modification from a line item

X

Create a payment record on an order

X

Apply a service charge to an order

X

Remove service charge from an order

X

Void a line item

X

Create or exchange a line item

X

Create multiple line item

X

Delete all the line items in an order

X

Payments

Update a payment

X