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...](https://docs.codat.io/sfc/overview)
Sync for Commerce API is a shopping API from codat.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 17 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Shopping
- Base URL
https://api.codat.io- Version
- 1.1
- Endpoints
- 17
- OpenAPI
- Specification ↗
- Spec updated
- 2023-04-18
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.codat.io/config/integrations" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://api.codat.io/config/integrations", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.codat.io/config/integrations",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| 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 |
| GET | /config/sync/commerce/{commerceKey}/{accountingKey}/start | Retrieve sync flow url |
| GET | /meta/companies | List companies |
| 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 |
| 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 |
Questions
Does the Sync for Commerce API API need an API key?
Yes. The Sync for Commerce API API uses API key authentication; the documentation explains how to get credentials.
Does the Sync for Commerce API API support HTTPS?
Yes, the Sync for Commerce API API is served over HTTPS.
How many endpoints does the Sync for Commerce API API have?
Its OpenAPI description lists 17 endpoints in version 1.1. All of them are shown on this page.
What are alternatives to the Sync for Commerce API API?
Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.
Similar shopping APIs
Compare alternatives →Etsy
ShoppingManage shop and interact with listings
eBay
ShoppingSell and Buy on eBay
Flipkart Marketplace
ShoppingProduct listing management, Order Fulfilment in the Flipkart Marketplace
Inventory Management
ShoppingMaintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you.
Intel Product Catalogue Service
ShoppingThis is the documentation for PIM Micro services. In order to use this tool you need to have Basic Auth credentials and a client id. If you dont have one, please make sure to request one by sending an email to the PIM MS team: [[email protected]](mailto:[email protected]?subject=PIMServices)
Item API
ShoppingPlease make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.
Listed from APIs.guru (CC0).