Sync for Commerce API

codat · Commerce

Commerce No Auth Free & Open ecommerce

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)

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET List companies

Retrieve a list of all companies the client has created.

https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies?page=1&query=test&orderBy=date&pageSize=100

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies?page=1&query=test&orderBy=date&pageSize=100"

import requests
params = {
    "page": "1",
    "query": "test",
    "orderBy": "date",
    "pageSize": "100"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies');
url.searchParams.set('page', '1');
url.searchParams.set('query', 'test');
url.searchParams.set('orderBy', 'date');
url.searchParams.set('pageSize', '100');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies")
	q := baseURL.Query()
	q.Set("page", "1")
	q.Set("query", "test")
	q.Set("orderBy", "date")
	q.Set("pageSize", "100")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies")
uri.query = URI.encode_www_form({
  "page" => "1",
  "query" => "test",
  "orderBy" => "date",
  "pageSize" => "100"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/meta/companies?" . http_build_query([
    "page" => "1",
    "query" => "test",
    "orderBy" => "date",
    "pageSize" => "100"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List information on Codat's supported integrations

Retrieve a list of available integrations support by datatype and state of release.

https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/config/integrations";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve preferences for text fields on Sync Flow

To enable retrieval of preferences set for the text fields on Sync Flow.

https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/codat.io/sync-for-commerce/1.1/sync/commerce/config/ui/text";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Sync for Commerce API?

Sync for Commerce API is a Commerce API. Developers commonly use commerce APIs for:

syncing product catalogues and inventory levels
building price comparison and deal-finder tools
processing orders and tracking shipments
managing customer wishlists and reviews
automating abandoned-cart and promotional emails

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Sync for Commerce API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗