Codat

Sync for Commerce API

The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to provide high-quality integrations with numerous accounting platform through standardized API, seamlessly transforming business sale's data into accounting artefacts.
Read More...

Endpoints 17

Company management

  • GETList companies/meta/companies?page=1&pageSize=100&query=string&orderBy=-modifiedDateRetrieve a list of all companies the client has created.
  • POSTCreate a sync for commerce company/meta/companies/syncCreates a Codat company with a commerce partner data connection.
  • GETList data connections/meta/companies/:companyId/connections?page=1&pageSize=100&query=string&orderBy=-modifiedDateRetrieve previously created data connections.
  • POSTCreate a data connection/meta/companies/:companyId/connectionsCreate a data connection for company.
  • PATCHUpdate data connection/meta/companies/:companyId/connections/:connectionIdUpdate a data connection

Configuration

  • GETRetrieve config preferences set for a company./config/companies/:companyId/sync/commerceRetrieve current config preferences.
  • POSTCreate or update configuration./config/companies/:companyId/sync/commerceMake changes to configuration preferences.
  • GETGet status for a company's syncs/meta/companies/:companyId/sync/commerce/statusCheck the sync history and sync status for a company.

Sync flow preferences

  • GETList visible accounts/clients/:clientId/config/ui/accounts/platform/:platformKeyEnable retrieval for accounts which are visible on sync flow.
  • GETRetrieve sync flow url/config/sync/commerce/:commerceKey/:accountingKey/start?merchantIdentifier=stringGet a URL for Sync Flow including a one time passcode.
  • PATCHUpdate the visible accounts on Sync Flow/sync/commerce/config/ui/accounts/platform/:commerceKeyTo enable update of accounts visible preferences set on Sync Flow.
  • GETRetrieve preferences for text fields on Sync Flow/sync/commerce/config/ui/textTo enable retrieval of preferences set for the text fields on Sync Flow.
  • PATCHUpdate preferences for text fields on sync flow/sync/commerce/config/ui/textTo enable update of preferences set for the text fields on sync flow.

Sync

  • POSTRun a Commerce sync from the last successful sync/companies/:companyId/sync/commerce/latestRun a Commerce sync from the last successful sync up to the date provided (optional), otherwise UtcNow is used. If there was no previously successful sync,…
  • POSTRun a Commerce sync from a given date range/meta/companies/:companyId/sync/commerce/historicRun a Commerce sync from the specified start date to the specified finish date in the request payload.

Integrations

  • GETList information on Codat's supported integrations/config/integrations?page=1&pageSize=100&query=string&orderBy=-modifiedDateRetrieve a list of available integrations support by datatype and state of release.
  • GETGet branding for an integration/config/integrations/:platformKey/brandingRetrieve Integration branding assets.

API details

Base URL
https://api.codat.io
Authentication
An API key in the Authorization header
Operations
17 operations on 14 pathsGET 9POST 5PATCH 3
Main resources
Company management 5Sync flow preferences 5Configuration 3Integrations 2Sync 2
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Sync for Commerce API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Sync for Commerce API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List companies” (GET /meta/companies?page=1&pageSize=100&query=string&orderBy=-modifiedDate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Sync for Commerce API?

The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to… It is listed under E-commerce and has 17 endpoints.

Who publishes the Sync for Commerce API?

It is listed from Codat's public API description (an OpenAPI document), not published by Codat on Swastik Codes. Anyone who controls codat.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Sync for Commerce API?

Requests go to https://api.codat.io. Endpoint paths are added to this base URL.

How do I authenticate with the Sync for Commerce API?

With an API key in the Authorization header.

How many endpoints does the Sync for Commerce API have?

17 operations on 14 paths (9 GET, 5 POST, 3 PATCH). The largest groups are Company management, Sync flow preferences, Configuration, Integrations.

Is forking the Sync for Commerce API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.