APIHub
Back to Explore

Sync for Commerce API

The Sync for Commerce API lets you configure, launch, and monitor commerce‑to‑accounting data syncs, manage UI preferences for visible accounts and text fields, and handle company, connection, and integration metadata—including listing supported platforms and retrieving branding information.

Shopping
apiKeyHeader
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

305ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/config/sync/commerce/{commerceKey}/{accountingKey}/start

Retrieve sync flow url

  • commerceKey (path, required) — Commerce platform key
  • accountingKey (path, required) — Accounting platform key
  • merchantIdentifier (query) — Identifier for your merchant, can be the merchant name or Codat company id.
GET

/clients/{clientId}/config/ui/accounts/platform/{platformKey}

List visible accounts

POST

/companies/{companyId}/sync/commerce/latest

Run a Commerce sync from the last successful sync

GET

/config/companies/{companyId}/sync/commerce

Retrieve config preferences set for a company.

POST

/config/companies/{companyId}/sync/commerce

Create or update configuration.

GET

/config/integrations

List information on Codat's supported integrations

GET

/config/integrations/{platformKey}/branding

Get branding for an integration

  • platformKey (path, required) — PlatformKey
GET

/meta/companies

List companies

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
POST

/meta/companies/sync

Create a sync for commerce company

GET

/meta/companies/{companyId}/connections

List data connections

POST

/meta/companies/{companyId}/connections

Create a data connection

PATCH

/meta/companies/{companyId}/connections/{connectionId}

Update data connection

POST

/meta/companies/{companyId}/sync/commerce/historic

Run a Commerce sync from a given date range

GET

/meta/companies/{companyId}/sync/commerce/status

Get status for a company's syncs

PATCH

/sync/commerce/config/ui/accounts/platform/{commerceKey}

Update the visible accounts on Sync Flow

  • commerceKey (path, required)
GET

/sync/commerce/config/ui/text

Retrieve preferences for text fields on Sync Flow

PATCH

/sync/commerce/config/ui/text

Update preferences for text fields on sync flow

17 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X GET \
  "https://api.codat.io/config/sync/commerce/{commerceKey}/{accountingKey}/start" \
  -H "Authorization: YOUR_API_KEY"

api.codat.io · HTTPS only