See what the Clover integration can do →

This article catalogs the Clover Platform REST API endpoints the Clover integration calls, grouped by the entity you work with in iPaaS.com (Customers, Orders, Items/Products, Inventory, and Options/Attributes). Use it as a reference for firewall allow-listing, troubleshooting, and confirming whether the integration is affected when Clover publishes a change or deprecation notice.

All endpoints are part of the Clover Platform REST API, version 3 (v3). Every request the integration makes is scoped to a single Clover merchant and authenticated with an OAuth access token. Subscribers or their MiSP do not need to call these endpoints directly; the integration handles all Clover API traffic. The endpoints are documented here so you can see exactly which Clover resources the integration touches.

Subscribers manage their Clover account and view merchant data through the Clover web dashboard.

Your Environment URL subscription setting determines which Clover environment the integration connects to. Use the sandbox environment for testing and the matching production dashboard for live merchants.

The Clover Platform API is a REST API. All endpoints below are scoped to a single merchant, so every path begins with the merchant-scoped prefix /v3/merchants/{MerchantId}/, where the {MerchantId} placeholder is your Clover merchant identifier from the Merchant ID subscription setting. The base URL varies by environment:

For example, in the sandbox environment a customer lookup resolves to https://apisandbox.dev.clover.com/v3/merchants/{MerchantId}/customers/{Id}. Throughout this article, [Base URL] stands in for the environment-specific base URL from the table above so the endpoint patterns work across environments.

Expandable fields: Several read requests append an expand query parameter (for example ?expand=addresses,emailAddresses) so Clover returns related records inline in a single response instead of requiring follow-up calls. (Source: Clover, "Use expandable fields for API responses," docs.clover.com, retrieved 2026-07-06.)

Filtering: List requests use the filter query parameter with comparison operators (=, !=, >, >=, <, <=); multiple conditions are joined with &. Time-based filters (such as modifiedTime) are restricted by Clover to a 90-day range per request. (Source: Clover, "Apply filters to API requests," docs.clover.com, retrieved 2026-07-06.)

Pagination: Clover returns list results 100 items at a time by default. The limit and offset query parameters page through larger result sets; the maximum limit Clover accepts is 1000 items per request. (Source: Clover, "Add pagination requests," docs.clover.com, retrieved 2026-07-06.)

Rate limits: Clover enforces a request-rate limit of 16 requests per second per access token (50 per second per app) and a concurrent-request limit of 5 simultaneous requests per token (10 per app). When a limit is exceeded, Clover returns HTTP 429 Too Many Requests; concurrent-limit responses include a retry-after header indicating how many seconds to wait before retrying. The integration paces its own Clover traffic; these limits are documented here so subscribers understand Clover's platform behavior. (Source: Clover, "Work with API usage and rate limits," docs.clover.com, retrieved 2026-07-06.)

The integration reads and writes Clover customer records, including their nested addresses. Customer data moves both to and from iPaaS.com.

Retrieves a single customer, expanding addresses, email addresses, phone numbers, and metadata so the full record returns in one response.

Creates a new customer, expanding addresses on the response.

Updates an existing customer. Clover uses the POST method for updates to existing records. (Source: Clover, "Update a single customer," docs.clover.com, retrieved 2026-07-06.)

Removes a customer.

Retrieves a single address on a customer.

Adds an address to a customer.

Updates an existing customer address.

Removes an address from a customer.

The integration reads and writes Clover orders (transactions), including their line items and payments. Order data moves both to and from iPaaS.com. When polling Clover for new and updated transactions, the integration reads orders and expands their payments, line items, and customer details in a single response.

Retrieves the merchant's orders for the polling window, expanding payments, line items, tax rates, and customers. The integration uses a filter query parameter with a time-based condition to page through new and updated orders; Clover restricts time-based filters to a 90-day window per request. (Source: Clover, "Apply filters to API requests," docs.clover.com, retrieved 2026-07-06.)

Retrieves a single order, expanding its customer details.

Creates a new order.

Updates an existing order. Clover uses the POST method for order updates. (Source: Clover, "Update a single order," docs.clover.com, retrieved 2026-07-06.)

Removes an order.

Adds multiple line items to an order in a single request using Clover's bulk line-items endpoint.

Removes line items from an order. When updating an order's lines, the integration deletes the existing lines before adding the new set.

Records a payment against an order.

Reads the merchant's own address, used to populate the transaction address when an order transfers to iPaaS.com.

The integration creates Clover items (products) and their grouping records. Product data moves from iPaaS.com to Clover only.

Creates a Clover inventory item. The integration uses this endpoint to create both standalone products and product variants, which Clover represents as items. (Source: Clover, "Create an item," docs.clover.com, retrieved 2026-07-06.)

Updates an existing item.

Creates an item group, which Clover uses to relate a product's variants.

Looks up an existing item group by id when updating a product's variants.

Removes an item. Used only when the delete-and-recreate behavior is enabled, before recreating a product's item group.

The integration writes stock levels for products and product variants. Inventory data moves from iPaaS.com to Clover only.

Sets the stock level for an item (product or variant).

Updates the stock level for an existing item.

The integration creates the attributes and options Clover uses to define product variants, and assigns option values to variant items. This data moves from iPaaS.com to Clover only.

Retrieves the attributes defined for an item group, filtered to the relevant group.

Creates a product attribute (for example, "Size" or "Color").

Retrieves the options defined under an attribute.

Creates an option value under an attribute (for example, "Large" under "Size").

Associates an attribute option with a variant item so the variant is defined by its option values.

The integration authenticates to the Clover API using OAuth 2.0. During installation, the subscriber authorizes the Clover app; Clover returns an authorization code, which the integration exchanges for an access token. That token is stored as the API Key subscription setting and sent on every Clover API request in the Authorization: Bearer {AccessToken} header. (Source: Clover, "Use OAuth 2.0," docs.clover.com, retrieved 2026-07-06.)

The OAuth endpoints vary by environment:

The Client Id and Client Secret used in the token exchange are supplied in the subscription's custom fields. See the Clover Installation Instructions article for the step-by-step authorization walkthrough.