How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Codat

Codat Sales API

Retrieve standardized sales data from a linked commerce software.

Documentation Provider Profile APIs.io OpenAPI GitHub

Codat Sales API is one of 40 APIs that Codat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sales. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 23 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://api.codat.io.

23 operations 23 paths 29 schemas 23 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://api.codat.io
Authentication
API Key
Contact
Codat
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Codat Sales API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (auth_header). By default, every request must be authenticated.

  • auth_header — The word "Basic" followed by a space and your API key. [API keys](https://docs.codat.io/platform-api/schemas/ApiKeyDetails) are tokens used to control access t…

Paths & Operations 23

Across 23 paths, the API surfaces 23 operations — 23 GET. Each is listed below with its method, path, parameters, and response codes.

Sales 23

Retrieve standardized sales data from a linked commerce software.

GET
/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue
Get commerce revenue metrics
get-commerce-revenue-metrics 7 params → 200400401402403404429500
GET
/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders
Get orders report
get-commerce-orders-report 7 params → 200400401402403404429500
GET
/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds
Get refunds report
get-commerce-refunds-report 7 params → 200400401402403404429500
GET
/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention
Get customer retention metrics
get-commerce-customer-retention-metrics 7 params → 200400401402403404429500
GET
/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue
Get lifetime value metrics
get-commerce-lifetime-value-metrics 7 params → 200400401402403404429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-customers
List customers
list-commerce-customers 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}
Get customer
get-commerce-customer 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-disputes
List disputes
list-commerce-disputes 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}
Get dispute
get-commerce-dispute 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-locations
List locations
list-commerce-locations 2 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}
Get location
get-commerce-location 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-orders
List orders
list-commerce-orders 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}
Get order
get-commerce-order 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods
List payment methods
list-commerce-payment-methods 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}
Get payment method
get-commerce-payment-method 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-payments
List payments
list-commerce-payments 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}
Get payment
get-commerce-payment 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories
List product categories
list-commerce-product-categories 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}
Get product category
get-commerce-product-category 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-products
List products
list-commerce-products 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}
Get product
get-commerce-product 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-transactions
List transactions
list-commerce-transactions 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}
Get transaction
get-commerce-transaction 3 params → 200401402403404409429500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are SourceAccount (10 properties), ErrorMessage (7 properties), CommerceAddress (7 properties), CommerceReport (5 properties). Each schema is shown below with its type and property counts.

CommerceProducts
CommerceDispute
object
A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incor…
CommerceReport
object
Structure Assess reports follow a consistent structure. Reports contain four sections of information: 1. Report definition Information such as: 1. The report i…
5 properties
CommercePayment
object
Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment statu…
CommerceTransaction
object
Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service…
CommerceProduct
object
A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sal…
DateTime
string
In Codat's data model, dates and times are represented using the ISO 8601 standard . Date and time fields are formatted as strings; for example: 2020-10-08T22:…
CommerceAddress
object
7 properties
CommerceLocation
object
The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. A Location…
CommerceOrder
object
Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each o…
PagingInfo
object
4 properties 4 required
CommerceTaxComponent
object
The Tax Components endpoints return tax rates data from the commerce software, including tax rate names and values. This is to support the mapping of tax rates…
CommercePayments
CommerceOrders
CommerceDisputes
CommerceLocations
PaymentMethodRef
object
The payment method the record is linked to in the accounting or commerce software.
2 properties 1 required
ErrorMessage
object
7 properties
CommerceCustomer
object
When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers end…
CommerceCustomers
CommercePaymentMethod
object
A Payment Method represents the payment method(s) used to make payments.
CommerceTransactions
PhoneNumber
object
2 properties 1 required
CommerceRecordRef
object
2 properties 2 required
SourceAccount
object
The target bank account in a supported accounting software for ingestion into a bank feed.
10 properties 1 required
CommerceProductCategory
object
Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
SupplementalData
object
Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the…
1 property
CommercePaymentMethods
CommerceProductCategories

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codat-sales-api-openapi.yml Raw ↑

Other APIs Codat publishes across the network.

Codat Sync for Expenses API
AE Profile APIs.io
Codat Bill Pay API
AE Profile APIs.io
Codat Spend Insights API
AE Profile APIs.io
Codat Sync for Commerce API
AE Profile APIs.io
Codat Sync for Payroll API
AE Profile APIs.io
Codat Account mapping API
AE Profile APIs.io
Codat Accounting bank data API
AE Profile APIs.io
Codat Accounts payable API
AE Profile APIs.io
Codat Accounts receivable API
AE Profile APIs.io
Codat Bank accounts API
AE Profile APIs.io
Codat Bank statements API
AE Profile APIs.io
Codat Companies API
AE Profile APIs.io
#Sales
← Back to C APIs
API Details
ID
codat:codat-sales-api
Server
https://api.codat.io
Docs
https://docs.codat.io/using-the-api/overview
Provider
Codat
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=codat-sales-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/codat-sales-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Codat Sales API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.