Reference · built on requestConnectorHospitality & property systems

Clover

Merchants, orders, payments, inventory, customers, and employee shifts from Clover point-of-sale accounts.

About

Clover is a point-of-sale platform from Fiserv, sold in the United States, Canada, the United Kingdom, Ireland, Germany, Austria, and Argentina. Its REST API is scoped per merchant under /v3/merchants/{mId} and covers orders, line items, payments, refunds, inventory items and stock, customers, employees, shifts, and cash events, with webhooks per event category.

Through Fibric, an operator watches orders and stock across merchants and proposes a refund, an order, or a stock count for your approval. Nothing is applied twice, and each approved change leaves a receipt: what changed, why, and how to undo it.

This is a reference listing. It documents what Fibric would read from Clover and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Orders through GET /v3/merchants/{mId}/orders, filtered by modifiedTime or state and expanded with lineItems, payments, refunds, and discounts
  • Payments and refunds under /v3/merchants/{mId}/payments and the refunds endpoint
  • Inventory items, item groups, categories, and stock counts through /v3/merchants/{mId}/items and the item stock endpoints
  • Customers, employees, and employee shifts through /v3/merchants/{mId}/customers, /employees, and /shifts
  • Cash events per merchant, employee, or device through /v3/merchants/{mId}/cash_events
  • Webhook events keyed A, C, CA, E, I, O, M, P, and SH with type CREATE, UPDATE, or DELETE and a Unix timestamp
  • Merchant address, order types, opening hours, and tip suggestions through the merchants endpoints

Proposed actions

  • Target capability: propose a refund through POST /v1/payments/{paymentId}/refunds, full or partial in cents
  • Target capability: propose an order through the atomic order endpoint, or a line item change on an existing order
  • Target capability: propose a stock count through the update item stock endpoint
  • Target capability: propose a customer record change through /v3/merchants/{mId}/customers
  • Target capability: propose an employee shift through the create shift endpoint

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Refund within policy

    Payment webhooks (P) and expanded orders show each refund request against the original tender. The operator proposes a full or partial refund and waits for a manager's approval.

    With Refund Policy

  • Count stock before it runs out

    Item stock endpoints and inventory webhooks (I) track quantities per merchant. The operator proposes a stock count or reorder when an item nears zero.

    With Stockout Forecast, Reorder Point

  • Match punches to sales

    Employee shifts and orders per employee show who rang what and when. The operator flags a shift without matching sales and proposes the correction.

    With Punch Match

  • Reconcile cash drawers

    Cash events per device and employee list every drawer action. The operator ties them to payments and proposes the entries a manager should review.

    With Bank Reconciliation

Requirements

  • A Clover app in the Global Developer Dashboard with the read and write permissions each endpoint needs
  • The merchant's install of the app; permission changes after install need the merchant to reinstall
  • The regional base URL: api.clover.com, api.eu.clover.com, or api.la.clover.com; sandbox at apisandbox.dev.clover.com
  • A public https webhook URL confirmed with the verificationCode Clover posts, then event subscriptions per category
Authentication
v2 OAuth: a merchant installs the app, Clover redirects with a code and merchant_id, and the app exchanges it at /oauth/v2/token for an expiring access token and refresh token, renewed at /oauth/v2/refresh; low-trust apps use PKCE.

Limits

  • 50 requests per second per app and 16 per token, with 10 and 5 concurrent; over the limit returns 429 with retry-after
  • Order searches on createdTime, state, total, and similar filters cover only the last 90 days; older data comes from the Export API
  • Refunds route through a device: X-Clover-Device-Id, X-POS-Id, and a request key header are required
  • The Ecommerce API is available in the US and Canada only

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Clover ↗

Questions and answers

How do Clover webhooks work?
Register an https callback in the Developer Dashboard, echo the verificationCode Clover posts, then subscribe to categories such as Orders (O), Payments (P), or Inventory (I). Each POST carries a merchants map of objectId, type, and ts, plus an X-Clover-Auth header to check.
Which regions does the API serve?
Production base URLs are api.clover.com for North America, api.eu.clover.com for Europe, and api.la.clover.com for Latin America, with apisandbox.dev.clover.com for testing. Clover operates in the United States, Canada, the United Kingdom, Ireland, Germany, Austria, and Argentina.
How far back can I query orders?
Filters on createdTime, state, total, payType, title, note, and similar fields return only the last 90 days. Clover directs historical pulls two months or older to the Export API, and recommends modifiedTime filters, local caching, and webhooks over polling.
Ask about Clover

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.