Commerce API

Name: Commerce API API
Brand: Commerce API
Availability: InStock

✓ Official Vendor SpecE CommerceOrder ManagementapiKey21 EndpointsREST

For Agents

Read normalised orders, payments, products, customers, and disputes from a merchant's connected commerce platform such as Shopify, Square, Stripe, or Amazon.

Connect the Commerce API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Commerce API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Commerce API API.

Retrieve orders with line items, totals, taxes, and customer references from connected commerce platforms

Read payment records and transactions tied to orders for payout reconciliation

List customers and customer profiles linked to commerce orders

Access products, variants, and SKU-level catalogue data from the connected store

GET STARTED

Start building with Commerce API API

Explore with Jentic

View OpenAPI Document

Use for: I want to list a merchant's orders from Shopify or Square, Get the payment record attached to a specific commerce order, Find all disputes filed against a merchant in the last 30 days, Retrieve product catalogue data for a connected store

Not supported: Does not handle writing commerce data, accounting ledger access, or payment processing — use for reading normalised orders, payments, products, and disputes from connected commerce platforms only.

Codat's Commerce API exposes a unified read interface for orders, payments, customers, products, locations, disputes, transactions, and tax components from a customer's connected commerce platform. It normalises data from Shopify, Square, Stripe, Amazon, eBay, and other commerce systems so a single integration covers every supported platform. The API is used by lenders evaluating revenue quality, finance platforms reconciling payouts, and B2B SaaS products that build dashboards on top of merchant commerce data.

Use Cases

Patterns agents use Commerce API API for, with concrete tasks.

★ Revenue-Based Lending Diligence

Capital providers offering revenue-based finance use the Commerce API to verify a merchant's order volume and payment history. The /companies/{companyId}/connections/{connectionId}/data/commerce-orders, /commerce-payments, and /commerce-transactions endpoints provide the trailing volume series the underwriting model needs, normalised across Shopify, Square, Stripe, and Amazon so one integration covers every applicant.

Fetch the last 12 months of commerce-orders for company {companyId} connection {connectionId} and compute monthly gross merchandise volume.

Payout Reconciliation

Finance teams at multi-channel merchants reconcile platform payouts using the Commerce API's payments and transactions endpoints. The /commerce-payments and /commerce-transactions data ties each settled amount back to the originating order so the team can match payout deposits in the bank to the gross order plus fees and refunds reported by the commerce platform.

List commerce-payments for company {companyId} for the last week and group them by order ID to support payout matching.

Multi-Channel Merchant Analytics

B2B SaaS products serving multi-channel sellers use the Commerce API to build a unified analytics view across Shopify, Amazon, eBay, and Square. The same /commerce-orders, /commerce-products, and /commerce-customers endpoints work regardless of source, eliminating the per-platform connector work that historically blocked these products from launching with broad coverage.

Pull product catalogue and last-30-day order data for company {companyId} across all connections and compute revenue per SKU.

AI Agent Merchant Insights

AI agents that surface merchant-specific insights use the Commerce API through Jentic. The agent searches Jentic for 'list commerce orders', loads the schema, and pulls trailing orders and disputes for a merchant. Jentic isolates the Codat API key in its vault and the unified search means the agent does not have to know the Codat path naming scheme.

Search Jentic for 'commerce disputes codat', load the operation, and list every open dispute for company {companyId} with reason and amount.

Key Endpoints

21 endpoints — codat's commerce api exposes a unified read interface for orders, payments, customers, products, locations, disputes, transactions, and tax components from a customer's connected commerce platform.

METHOD

PATH

DESCRIPTION

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-orders

List commerce orders from a connected platform

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-payments

List commerce payments

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-transactions

List underlying commerce transactions

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-customers

List commerce customers

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-products

List products in the connected catalogue

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-disputes

List disputes and chargebacks

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-orders

List commerce orders from a connected platform

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-payments

List commerce payments

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-transactions

List underlying commerce transactions

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-customers

List commerce customers

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-products

List products in the connected catalogue

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Codat API keys are stored encrypted in the Jentic vault. Agents receive a scoped execution token; the 'Basic' Authorization header is constructed inside Jentic and never enters the agent runtime.

Intent-based discovery

Agents search Jentic by intent (e.g. 'list commerce orders for a merchant') and Jentic returns the matching Commerce operation with its input schema, so the agent does not browse the 21 paths manually.

Time to first call

Direct Codat Commerce integration: 1-2 weeks for auth and per-platform connection lifecycle. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Codat Sync for Commerce

Writes commerce data into accounting platforms; Commerce API reads it

Use Sync for Commerce when the agent needs to push orders or payments into a customer's accounting software; use Commerce when the agent needs to read commerce data.

Complementary

Codat Assess API

Builds lending metrics like MRR, retention, and LTV on top of commerce data

Use Assess when the agent needs derived lending metrics; use Commerce when the agent needs raw orders and transactions.

Complementary

Codat Accounting API

Pairs commerce data with the merchant's accounting ledger for full financial visibility

Use Accounting alongside Commerce when the agent needs both store and ledger views of the same merchant.

FAQs

Specific to using Commerce API API through Jentic.

What authentication does the Codat Commerce API use?

The API uses an API key passed in the Authorization header as 'Basic <base64-encoded-key>'. The single security scheme in the spec is named auth_header. Through Jentic, the Codat API key is stored encrypted in the vault and never enters the agent context — Jentic injects the Authorization header at execution time.

Can I read Shopify and Stripe order data with the Codat Commerce API?

Yes. The /companies/{companyId}/connections/{connectionId}/data/commerce-orders endpoint returns orders normalised across Shopify, Stripe, Square, Amazon, eBay, and other supported commerce platforms, so the same call works regardless of which platform the merchant uses.

What are the rate limits for the Codat Commerce API?

Codat does not publish a fixed rate limit in the OpenAPI spec; limits are governed at the company and connection level and depend on the underlying commerce platform's own limits. Codat returns HTTP 429 with a Retry-After header when limits are hit and recommends exponential backoff for retries.

How do I pull dispute records through Jentic?

Search Jentic for 'commerce disputes codat', load the GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes operation, and execute it with the company and connection IDs. Install with pip install jentic and use the standard async search, load, and execute flow.

Does the Codat Commerce API support write operations?

No. The Commerce API is read-only — it surfaces orders, payments, customers, products, and disputes from the connected platform. To push data back into accounting platforms use the Codat Sync for Commerce or Accounting API instead.