Own Codat? Customize your docs with AI search, analytics, and more.

Claim your docs

Sync for Commerce API

Codat

Powered by Specway

Own Codat? Customize your docs with AI search, analytics, and more.

Claim your docs

Sync for Commerce API

Codat

Powered by Specway

Back to APIs Authentication

Endpoints

List visible accountsGET

Run a Commerce sync from the last successful syncPOST

Create or update configuration.POST
Get branding for an integrationGET
List information on Codat's supported integrationsGET
Retrieve config preferences set for a company.GET
Retrieve sync flow urlGET

Create a data connectionPOST
Create a sync for commerce companyPOST
Get status for a company's syncsGET
List companiesGET
List data connectionsGET
Run a Commerce sync from a given date rangePOST
Update data connectionPATCH

Retrieve preferences for text fields on Sync FlowGET
Update preferences for text fields on sync flowPATCH
Update the visible accounts on Sync FlowPATCH

Back to APIs Authentication

Endpoints

List visible accountsGET

Run a Commerce sync from the last successful syncPOST

Create or update configuration.POST
Get branding for an integrationGET
List information on Codat's supported integrationsGET
Retrieve config preferences set for a company.GET
Retrieve sync flow urlGET

Create a data connectionPOST
Create a sync for commerce companyPOST
Get status for a company's syncsGET
List companiesGET
List data connectionsGET
Run a Commerce sync from a given date rangePOST
Update data connectionPATCH

Retrieve preferences for text fields on Sync FlowGET
Update preferences for text fields on sync flowPATCH
Update the visible accounts on Sync FlowPATCH

Authentication

How to authenticate with the Sync for Commerce API API.

auth_header

API Key

The word "Basic" followed by a space and your API Key, base64 encoded, which can be found [here](https://app.codat.io/developers/api-keys)

Location:: header
Parameter Name:: Authorization

Authentication

How to authenticate with the Sync for Commerce API API.

auth_header

API Key

The word "Basic" followed by a space and your API Key, base64 encoded, which can be found [here](https://app.codat.io/developers/api-keys)

Location:: header
Parameter Name:: Authorization