Jump to Content
Release Notes
Announcements
Blog
FAQ
Support
Guides
Recipes
API Reference
API Changelog
Release Notes
Announcements
Blog
FAQ
Support
Log In
API Reference
Log In
Guides
Recipes
API Reference
API Changelog
Update a merchant
Search
JUMP TO
CLOVER REST API
API Reference overview
Data types in Clover APIs
Platform API
MERCHANTS
Get a single merchant
get
Update a merchant
post
Get a merchant's address
get
Get a merchant's payment gateway configuration
get
Get a merchant's properties
get
Update merchant properties
post
Get default service charge for a merchant
get
Get a sync token (deprecated)
get
Get all tip suggestions for a merchant
get
Get a single tip suggestion
get
Update a single tip suggestion
post
Get all order types for a merchant
get
Create Order Type For Merchant
post
Get a single order type
get
Update a single order type
post
Delete an order type
delete
Create or delete associations between order types and categories
post
Return a list of system order types
get
Get all roles for a merchant
get
Create a role
post
Get a single role
get
Update a single role
post
Delete a role
delete
Get all tenders for a merchant
get
Adds a new tender
post
Get a single merchant tender
get
Updates an existing tender
post
Deletes an existing tender
delete
Get a list this merchant opening hours
get
Create a set of merchant opening hours
post
Get a specific set of merchant opening hours
get
Update a set of merchant opening hours
post
Delete a set of merchant opening hours
delete
Get all devices provisioned to a merchant
get
Get a single device provisioned to a merchant
get
CASH
Get all cash events
get
Get all cash events for an employee
get
Get all cash events for a device
get
CUSTOMERS
Get a list of customers in CSV format
get
Get a list of customers
get
Create a customer
post
Get a single customer
get
Update a customer
post
Delete a customer
delete
Create a phone number for a customer
post
Update a phone number for a customer
post
Delete a customer phone number
delete
Create an email address for a customer
post
Update an email address for a customer
post
Delete a customer email address
delete
Create an address for a customer
post
Update an address for a customer
post
Delete a customer address
delete
Create a credit/debit card entry for a customer
post
Update a credit/debit card record for a customer
post
Delete a customer card
delete
Create note, birthday, business name for a customer
post
EMPLOYEES
Get all employees
get
Create an employee
post
Get a single employee
get
Update an employee
post
Delete an employee
delete
Get all shifts
get
Get a single shift
get
Get .csv of all shifts
get
Get all shifts for an employee
get
Create shift for an employee
post
Get a single shift
get
Update a single shift
post
Delete a single shift
delete
Get all orders for an employee
get
INVENTORY
Get all inventory items
get
Create an inventory item
post
Delete multiple inventory items
delete
Get all inventory without a revenue class
get
Get a single inventory item
get
Update an existing inventory item
post
Delete an inventory item
delete
Update existing inventory items
put
Create multiple inventory items
post
Get the stock of all inventory items
get
Get the stock of an inventory item
get
Update the stock of an inventory item
post
Delete the stock of an inventory item
delete
Get all item groups
get
Create an item group
post
Get a single item group
get
Update an item group
post
Delete an item group
delete
Get all tags
get
Create a tag
post
Delete tags
delete
Get a single tag
get
Update a single tag
post
Delete a tag
delete
Get tags for a single item
get
Get all items for a single tag
get
Get a list of all tag to item mappings
get
Create or delete associations between tags and items
post
Get all tax rates
get
Create a tax rate for a merchant
post
Get a single tax rate
get
Update a single tax rate
post
Delete a single tax rate
delete
Get all categories
get
Create an item category
post
Delete categories
delete
Get a category
get
Update a category
post
Delete a single item category
delete
Update the order for categories on the menu at a time, up to 1000 categories.
post
Get all items in a single category
get
Get all categories of a single item
get
Create or delete associations between items and categories
post
Create or delete association between items and tax rates
post
Get items by tax rate
get
Get all modifier groups
get
Create a modifier group
post
Delete modifier groups
delete
Get a modifier group
get
Update a modifier group
post
Delete a modifier group
delete
Create or delete associations between inventory items and modifier groups
post
Update the priorities for a collection of up to 200 modifier groups at a time
post
Reorder modifiers in the modifier group based on the ordering of the incoming modifier id list. Remove deleted modifiers. Add missing modifiers.
put
Get all items in a single modifier group
get
Get all modifiers
get
Get all modifiers in a single modifier group
get
Create a modifier
post
Get a single modifier
get
Update a single modifier
post
Delete a single modifier
delete
Get all attributes
get
Create an attribute
post
Get a single attribute
get
Update a single attribute
post
Delete a single attribute
delete
Get all options
get
Get all options for an attribute
get
Create an option
post
Get an attribute and option by ID
get
Update an option
post
Delete an option
delete
Create or delete item/option association
post
Get all discounts
get
Create a discount
post
Get a single discount
get
Update an discount
post
Delete a discount
delete
Get all tax exemption rules
get
Get an individual tax exemption rule
get
NOTIFICATIONS
Create a notification for an app
post
Create a notification for a device
post
ORDERS
Create an atomic order
post
Checkout an atomic order
post
Gets a list of orders
get
Create custom orders
post
Get a single order
get
Update an order
post
Delete an order
delete
Get all discounts for an order
get
Create a discount on an order
post
Delete an order discount
delete
Get all line items for an order
get
Create a new line item
post
Delete all the line items in an order
delete
Get a line item
get
Update a line item
post
Void a line item
delete
Create a discount on a line item
post
Delete a discount
delete
Apply a modification to a line item
post
Remove a modification from a line item
delete
Create multiple line items
post
Create a payment record on an order
post
Apply a service charge to an order
post
Remove service charge from an order
delete
Create a list of voided line items
post
Get a list of line items from voided orders
get
Get summary about line items and orders which were deleted
get
Create or exchange a line item
post
PAYMENTS
Get all payments for an order
get
Get all authorizations
get
Create an authorization on a Payment
post
Get a single authorization
get
Update an authorization
post
Delete an authorization
delete
Get all payments
get
Get a single payment
get
Update a payment
post
Get all payments under an employee
get
Get all refunds for a merchant
get
Get a single refund
get
Get a list of credit refunds
get
Get a credit refund
get
APPS
Get merchant app billing information
get
Get all events for an app metered event type
get
Create an app billing metered event
post
Get an app billing metered event
get
Delete app billing metered event
delete
PRINT
Submit a print request to the merchant's default order printer
post
Get a print event by its ID
get
Multiple service charges (MSC) Pilot APIs
(MSC Pilot) REST API Index
MSC INVENTORY
Get all configured service charges for a merchant
get
Get a specific configured service charge for a merchant
get
MSC ORDERS
Gets a list of orders
get
Create custom orders
post
Get a single order
get
Update an order
post
Delete an order
delete
Get all line items for an order
get
Create a new line item
post
Delete all the line items in an order
delete
Get a line item
get
Update a line item
post
Void a line item
delete
Create a discount on a line item
post
Create multiple line items
post
Get all service charges applied to an order
get
Create a service charge on an order
post
Get a specific service charge applied to an order
get
Void or remove a service charge from an order
delete
Ecommerce Service API
CHARGES
Create a charge
post
Get charges
get
Get a charge
get
Capture a charge
post
CUSTOMERS
Create a card-on-file customer
post
Revoke a payment source
delete
Update a customer
put
REFUNDS
Create a refund
post
Get refunds list
get
Get a refund
get
ORDERS
Get orders
get
Create an order
post
Get an order
get
Pay for an order
post
Return an order
post
ECOMMGIFTCARD
Request gift card balance
post
Reload gift card
post
Request cashout of gift card balance
post
Create and activate physical and virtual gift card
post
PAKMS Service API
KEYS
Retrieve an Ecommerce API key or PAKMS key
get
Tokenization Service APIs
TOKENS
Create a card token
post
Create Clover token from an external token
post
Create an Apple Pay token
post
Create an ACH token
post
Create a gift card token
post
ECommerce Recurring Payments APIS
PLANS
Retrieve plans
get
Create plan
post
Delete a plan
delete
Get plan
get
Edit a plan
put
SUBSCRIPTIONS
Get subscriptions under a plan
get
Create subscription under a plan
post
Delete subscription
delete
Get subscription
get
Edit a subscription
put
Get all subscriptions
get
REST Pay Display API
CARD
Read a card's track data using a Clover device
post
Create a card token for use with subsequent payments
post
CREDITS
Send a credit request to the Clover device
post
Get a credit
get
Refund a payment
post
Void a payment
post
RECEIPTS
Deliver a credit receipt
post
Display receipt options
post
Deliver a payment receipt
post
Deliver a void receipt
post
Deliver a refund receipt
post
DEVICE
Cancel any in-flight operations
post
Opens the specified cash drawer
post
Retrieve a list of cash drawers
get
Execute a custom activity
post
Get merchant devices
get
Display a message
post
Display an order
post
Verify connectivity
get
Verify connectivity
post
Get the status of a print job
get
Print an image
post
Print text
post
Retrieve a list of printers
get
Retrieve a list of printers
post
Get a user confirmation response
post
Get a text response
post
Get a signature
post
Get a tip
post
Resets the device and cancels any in-flight operations
put
Get the device's status
get
Display a thank you screen
post
Display the welcome screen
post
PAYMENTS
Send a payment request to a Clover device
post
Get a payment by externalPaymentId
get
Get a payment
get
Capture a pre-auth payment
post
Increment an authorization (pre-auth)
post
Tip adjust a payment
post
Update a merchant
post
https://sandbox.dev.clover.com/v3/merchants/
{mId}
Language
Shell
Node
JavaScript
Java
Swift
Credentials
Bearer
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!
