Welcome to Codat's API Documentation

Develop against the Codat API.

Guides    API Reference

Commerce data


Codat's commerce integrations allow clients to retrieve up-to-date, useful data from ecommerce, point of sale and payment providers directly from Codat's API.

Key features

Codat's commerce integrations give you access to your customers' commerce transactions.

These can be used for a variety of use cases. For example, lenders can supplement decision-making by using up-to-date sales, customer, and product information to extract:

  • Gross sales values
  • Monthly recurring revenue
  • Churn rates
  • Average transaction volumes, etc.

Data types available via Codat API

Availability of data types depends on the commerce integration you are using. The following commerce data types are available via Codat's API:

  • Company info — details of a linked company, such as their address, phone number, and company registration.
  • Customers — details of customers who have placed orders with the company.
  • Disputes — details of all transactions that customers have challenged.
  • Orders — details of all orders received by a company, including payments, service charges, and refunds.
  • Payments — amounts reserved against the customer's funding source.
  • Products — details of the products a company has available in the system, including the price and quantity of those products, and product variants (where available).
  • Transactions — details of all financial transactions recorded in the system.

This data is available via the following endpoints:


Supported packages

Codat supports integrations with the following commerce data sources:

Updated about 13 hours ago

Commerce data

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.