Overview

The Clover REST API lets you query relevant information about Clover merchants, such as inventory, orders, and payments. You can build a browser-based integration that uses our REST API along with the relevant OAuth flow.

In the Clover REST API, each endpoint indicates a type of merchant information. Use the REST API Reference to send requests to the endpoints and receive relevant response parameters and codes.

Before you begin

To get started, see how to:

• Use API tokens in sandbox
• Make a sample REST API call

Use the REST API

See the following REST API tutorials on how to use query parameters and retrieve responses:

• Work with API usage and rate limits
• Sort collections
• Apply filters
• Use filters to retrieve multiple results from an endpoint
• Add pagination requests
• Use expandable fields
• Use object associations
• Display null fields
• Convert Clover timestamps to Unix time
• Troubleshoot API errors