What is the MerchantSpring API and when should I use it?

The MerchantSpring API allows authorised users and applications to request available MerchantSpring data programmatically. It is designed for businesses that want to move beyond standard in-platform reporting and use MerchantSpring data in their own systems, reports or workflows.

An endpoint is a defined API operation for a particular resource or report. For example, one endpoint may return your connected channels while another may request sales or profitability data. Each endpoint has its own supported parameters and response format.

• Build a custom dashboard or reporting application
• Load MerchantSpring data into your own data warehouse
• Combine MerchantSpring data with CRM, ticketing, invoicing or other business data
• Automate a recurring report or workflow
• Create a repeatable integration that needs a predictable response structure

For standard reports, dashboards and day-to-day analysis, the MerchantSpring interface is usually the fastest and simplest option. The API is most useful when you need customisation, automation or system-to-system integration.

Not every report or field visible in MerchantSpring is automatically available through the API. Customer-facing endpoints are developed and released individually, so available API coverage may differ from the platform.

Need more help? Contact MerchantSpring Support at support@merchantspring.io.