Jump to Content
Clover Platform DocsClover Platform DocsRelease NotesAnnouncementsBlogFAQSupport
GuidesRecipesAPI ReferenceAPI Changelog
Release NotesAnnouncementsBlogFAQSupportLog InClover Platform Docs
API Reference
Log In
GuidesRecipesAPI ReferenceAPI Changelog

CLOVER REST API

  • API Reference overview
  • Data types in Clover APIs

Platform API

  • INVENTORY
    • Get all inventory itemsget
    • Create an inventory itempost
    • Delete multiple inventory itemsdel
    • Get all inventory without a revenue classget
    • Get a single inventory itemget
    • Update an existing inventory itempost
    • Delete an inventory itemdel
    • Update existing inventory itemsput
    • Create multiple inventory itemspost
    • Get the stock of all inventory itemsget
    • Get the stock of an inventory itemget
    • Update the stock of an inventory itemput
    • Delete the stock of an inventory itemdel
    • Get all item groupsget
    • Create an item grouppost
    • Get a single item groupget
    • Update an item grouppost
    • Delete an item groupdel
    • Get all tagsget
    • Create a tagpost
    • Delete tagsdel
    • Get a single tagget
    • Update a single tagpost
    • Delete a tagdel
    • Get tags for a single itemget
    • Get all items for a single tagget
    • Get a list of all tag to item mappingsget
    • Create or delete associations between tags and itemspost
    • Get all tax ratesget
    • Create a tax rate for a merchantpost
    • Get a single tax rateget
    • Update a single tax ratepost
    • Delete a single tax ratedel
    • Get all categoriesget
    • Create an item categorypost
    • Delete categoriesdel
    • Get a categoryget
    • Update a categorypost
    • Delete a single item categorydel
    • Update the order for categories on the menu at a time, up to 1000 categories.post
    • Get all items in a single categoryget
    • Get all categories of a single itemget
    • Create or delete associations between items and categoriespost
    • Create or delete association between items and tax ratespost
    • Create a Subcategorypost
    • Get items by tax rateget
    • Delete a Subcategorydel
    • Get all modifier groupsget
    • Update Subcategory Informationput
    • Create a modifier grouppost
    • View items in a subcategoryget
    • Delete modifier groupsdel
    • View subcategories in a categoryget
    • Get a modifier groupget
    • Update a modifier grouppost
    • Delete a modifier groupdel
    • Create or delete associations between inventory items and modifier groupspost
    • Update the priorities for a collection of up to 200 modifier groups at a timepost
    • Add Modifiers to a Groupput
    • Get all items in a single modifier groupget
    • Remove Modifiers from a Groupput
    • Get all modifiersget
    • Get all modifiers in a single modifier groupget
    • Create a modifierpost
    • Get a single modifierget
    • Update a single modifierpost
    • Delete a single modifierdel
    • Get all attributesget
    • Create an attributepost
    • Get a single attributeget
    • Update a single attributepost
    • Delete a single attributedel
    • Get all optionsget
    • Get all options for an attributeget
    • Create an optionpost
    • Get an attribute and option by IDget
    • Update an optionpost
    • Delete an optiondel
    • Create or delete item/option associationpost
    • Get all discountsget
    • Create a discountpost
    • Get a single discountget
    • Update an discountpost
    • Delete a discountdel
    • Get all tax exemption rulesget
    • Get an individual tax exemption ruleget
    • Create item stockpost
  • MERCHANTS
    • Get a single merchantget
    • Update a merchantpost
    • Get a merchant's addressget
    • Get a merchant's payment gateway configurationget
    • Get a merchant's propertiesget
    • Update merchant propertiespost
    • Get default service charge for a merchantget
    • Get a sync token (deprecated)get
    • Get all tip suggestions for a merchantget
    • Get a single tip suggestionget
    • Update a single tip suggestionpost
    • Get all order types for a merchantget
    • Create Order Type For Merchantpost
    • Get a single order typeget
    • Update a single order typepost
    • Delete an order typedel
    • Create or delete associations between order types and categoriespost
    • Return a list of system order typesget
    • Get all roles for a merchantget
    • Create a rolepost
    • Get a single roleget
    • Update a single rolepost
    • Delete a roledel
    • Get all tenders for a merchantget
    • Adds a new tenderpost
    • Get a single merchant tenderget
    • Updates an existing tenderpost
    • Deletes an existing tenderdel
    • Get a list this merchant opening hoursget
    • Create a set of merchant opening hourspost
    • Get a specific set of merchant opening hoursget
    • Update a set of merchant opening hourspost
    • Delete a set of merchant opening hoursdel
    • Get all devices provisioned to a merchantget
    • Get a single device provisioned to a merchantget
  • CASH
    • Get all cash eventsget
    • Get all cash events for an employeeget
    • Get all cash events for a deviceget
  • CUSTOMERS
    • Get a list of customers in CSV formatget
    • Get a list of customersget
    • Create a customerpost
    • Get a single customerget
    • Update a customerpost
    • Delete a customerdel
    • Create a phone number for a customerpost
    • Update a phone number for a customerpost
    • Delete a customer phone numberdel
    • Create an email address for a customerpost
    • Update an email address for a customerpost
    • Delete a customer email addressdel
    • Create an address for a customerpost
    • Update an address for a customerpost
    • Delete a customer addressdel
    • Create a credit/debit card entry for a customerpost
    • Update a credit/debit card record for a customerpost
    • Delete a customer carddel
    • Create note, birthday, business name for a customerpost
  • EMPLOYEES
    • Get all employeesget
    • Create an employeepost
    • Get a single employeeget
    • Update an employeepost
    • Delete an employeedel
    • Get all shiftsget
    • Get a single shiftget
    • Get .csv of all shiftsget
    • Get all shifts for an employeeget
    • Create shift for an employeepost
    • Get a single shiftget
    • Update a single shiftpost
    • Delete a single shiftdel
    • Get all orders for an employeeget
  • NOTIFICATIONS
    • Create a notification for an apppost
    • Create a notification for a devicepost
  • ORDERS
    • Create an atomic orderpost
    • Checkout an atomic orderpost
    • Gets a list of ordersget
    • Create custom orderspost
    • Get a single orderget
    • Update an orderpost
    • Delete an orderdel
    • Get all discounts for an orderget
    • Create a discount on an orderpost
    • Delete an order discountdel
    • Get all line items for an orderget
    • Create a new line itempost
    • Delete all the line items in an orderdel
    • Get a line itemget
    • Update a line itempost
    • Void a line itemdel
    • Create a discount on a line itempost
    • Delete a discountdel
    • Apply a modification to a line itempost
    • Remove a modification from a line itemdel
    • Create multiple line itemspost
    • Create a payment record on an orderpost
    • Apply a service charge to an orderpost
    • Remove service charge from an orderdel
    • Create a list of voided line itemspost
    • Get summary about line items and orders which were deletedget
    • Create or exchange a line itempost
  • PAYMENTS
    • Get all payments for an orderget
    • Get all authorizationsget
    • Create an authorization on a Paymentpost
    • Get a single authorizationget
    • Update an authorizationpost
    • Delete an authorizationdel
    • Get all paymentsget
    • Get a single paymentget
    • Update a paymentpost
    • Get all payments under an employeeget
    • Get all refunds for a merchantget
    • Get a single refundget
    • Get a list of credit refundsget
    • Get a credit refundget
  • APPS
    • Get merchant app billing informationget
    • Get all events for an app metered event typeget
    • Create an app billing metered eventpost
    • Get an app billing metered eventget
    • Delete app billing metered eventdel
  • PRINT
    • Submit a print request to the merchant's default order printerpost
    • Get a print event by its IDget

Multiple service charge (MSC) APIs

  • Multiple service charges (MSC) REST API Index
  • MSC INVENTORY
    • Get all configured service charges for a merchantget
    • Get a specific configured service charge for a merchantget
  • MSC ORDERS
    • Gets a list of ordersget
    • Create custom orderspost
    • Get a single orderget
    • Update an orderpost
    • Delete an orderdel
    • Get all line items for an orderget
    • Create a new line itempost
    • Delete all the line items in an orderdel
    • Get a line itemget
    • Update a line itempost
    • Void a line itemdel
    • Create a discount on a line itempost
    • Create multiple line itemspost
    • Get all service charges applied to an orderget
    • Create a service charge on an orderpost
    • Get a specific service charge applied to an orderget
    • Void or remove a service charge from an orderdel

Ecommerce Service API

  • ORDERS
    • Get ordersget
    • Create an orderpost
    • Get an orderget
    • Pay for an orderpost
    • Return an orderpost
  • CHARGES
    • Create a chargepost
    • Get chargesget
    • Get a chargeget
    • Capture a chargepost
  • CUSTOMERS
    • Create a card-on-file customerpost
    • Revoke a payment sourcedel
    • Update a customerput
  • REFUNDS
    • Create a refundpost
    • Get refunds listget
    • Get a refundget
  • ECOMMGIFTCARD
    • Request gift card balancepost
    • Reload gift cardpost
    • Request cashout of gift card balancepost
    • Create and activate physical and virtual gift cardpost
  • CHECKOUT
    • Create checkoutpost

PAKMS Service API

  • KEYS
    • Retrieve an Ecommerce API key or PAKMS keyget

Tokenization Service APIs

  • TOKENS
    • Create a card tokenpost
    • Create Clover token from an external tokenpost
    • Create an Apple Pay tokenpost
    • Create an ACH tokenpost
    • Create a gift card tokenpost

ECommerce - Recurring APIs

  • PLANS
    • Get all plansget
    • Create a planpost
    • Delete a plandel
    • Get a planget
    • Update a planput
  • SUBSCRIPTIONS
    • Get subscriptions under a planget
    • Create a subscription under a planpost
    • Delete a subscriptiondel
    • Get a subscriptionget
    • Update a subscriptionput
    • Get all subscriptionsget

Clover Card Present REST API

  • PAYMENTS
    • Send a payment request to a Clover devicepost
    • Get a payment by externalPaymentIdget
    • Get a paymentget
    • Capture a pre-auth paymentpost
    • Increment an authorization (pre-auth)post
    • Tip adjust a paymentpost
  • CARD
    • Read a card's track data using a Clover devicepost
    • Create a card token for use with subsequent paymentspost
  • CREDITS
    • Send a credit request to the Clover devicepost
    • Get a creditget
    • Refund a paymentpost
    • Void a paymentpost
  • DEVICE
    • Cancel any in-flight operationspost
    • Opens the specified cash drawerpost
    • Retrieve a list of cash drawersget
    • Execute a custom activitypost
    • Get merchant devicesget
    • Display a messagepost
    • Display an orderpost
    • Verify connectivityget
    • Verify connectivitypost
    • Get the status of a print jobget
    • Print an imagepost
    • Print textpost
    • Retrieve a list of printersget
    • Retrieve a list of printerspost
    • Get a user confirmation responsepost
    • Get a text responsepost
    • Get a signaturepost
    • Get a tippost
    • Resets the device and cancels any in-flight operationsput
    • Get the device's statusget
    • Send device debug logspost
    • Display a thank you screenpost
    • Display the welcome screenpost
  • RECEIPTS
    • Deliver a credit receiptpost
    • Display receipt optionspost
    • Deliver a payment receiptpost
    • Deliver a void receiptpost
    • Deliver a refund receiptpost
  1. CLOVER REST API

API Reference overview

Updated 4 months ago


Data types in Clover APIs
Did this page help you?

Updated 4 months ago


Data types in Clover APIs
Did this page help you?
    • Before you begin
    • Sandbox base URLs
    • Production base URLs
    • Use the API Reference
      • Prerequisites
      • Make a sample REST API call
    • Sample REST API requests
    • Set additional query parameters