Commerce API
codat · Commerce
Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems. Standardize how you connect to your customers’ payment, PoS, and eCommerce systems. Retrieve orders, payouts, payments, and product data in the same way for all the leading commerce platforms. [Read more...](https://docs.codat.io/commerce-api/overview) [See our OpenAPI spec](https://github.com/codatio/oas)
Authentication
Sample Requests
List all commerce customers for the given company and data connection
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-customers?page=1&query=test&orderBy=-modifiedDate&pageSize=100"import requests
params = {
"page": "1",
"query": "test",
"orderBy": "-modifiedDate",
"pageSize": "100"
}
response = requests.get(
"https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-customers",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-customers');
url.searchParams.set('page', '1');
url.searchParams.set('query', 'test');
url.searchParams.set('orderBy', '-modifiedDate');
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-customers")
q := baseURL.Query()
q.Set("page", "1")
q.Set("query", "test")
q.Set("orderBy", "-modifiedDate")
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-customers")
uri.query = URI.encode_www_form({
"page" => "1",
"query" => "test",
"orderBy" => "-modifiedDate",
"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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-customers?" . http_build_query([
"page" => "1",
"query" => "test",
"orderBy" => "-modifiedDate",
"pageSize" => "100"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));List commerce disputes
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-disputes?page=1&query=test&orderBy=-modifiedDate&pageSize=100"import requests
params = {
"page": "1",
"query": "test",
"orderBy": "-modifiedDate",
"pageSize": "100"
}
response = requests.get(
"https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-disputes",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-disputes');
url.searchParams.set('page', '1');
url.searchParams.set('query', 'test');
url.searchParams.set('orderBy', '-modifiedDate');
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-disputes")
q := baseURL.Query()
q.Set("page", "1")
q.Set("query", "test")
q.Set("orderBy", "-modifiedDate")
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-disputes")
uri.query = URI.encode_www_form({
"page" => "1",
"query" => "test",
"orderBy" => "-modifiedDate",
"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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-disputes?" . http_build_query([
"page" => "1",
"query" => "test",
"orderBy" => "-modifiedDate",
"pageSize" => "100"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Retrieve information about the company, as seen in the commerce platform. This may include information like addresses, tax registration details and social media or website information.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-info"import requests
response = requests.get(
"https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-info",
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/codat.io/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-info';
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-info"
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-info")
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/commerce/2.1.0/companies/{companyId}/connections/{connectionId}/data/commerce-info";
$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
- See official documentation for authentication and setup.
What can you build with Commerce API?
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. 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?