Skip to content

Commerce API API

by codat.io

API keyHTTPSShopping
Open documentation ↗

Overview

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)

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 11 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Shopping
Base URL
https://api.codat.io
Version
2.1.0
Endpoints
11
Spec updated
2023-04-18

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.codat.io/companies/COMPANYID/connections/CONNECTIONID/data/commerce-customers" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://api.codat.io/companies/COMPANYID/connections/CONNECTIONID/data/commerce-customers", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.codat.io/companies/COMPANYID/connections/CONNECTIONID/data/commerce-customers",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/companies/{companyId}/connections/{connectionId}/data/commerce-customersList customers
GET/companies/{companyId}/connections/{connectionId}/data/commerce-disputesList disputes
GET/companies/{companyId}/connections/{connectionId}/data/commerce-infoGet company info
GET/companies/{companyId}/connections/{connectionId}/data/commerce-locationsList locations
GET/companies/{companyId}/connections/{connectionId}/data/commerce-ordersList orders
GET/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethodsList payment methods
GET/companies/{companyId}/connections/{connectionId}/data/commerce-paymentsList payments
GET/companies/{companyId}/connections/{connectionId}/data/commerce-productCategoriesList product categories
GET/companies/{companyId}/connections/{connectionId}/data/commerce-productsList products
GET/companies/{companyId}/connections/{connectionId}/data/commerce-taxComponentsList tax components
GET/companies/{companyId}/connections/{connectionId}/data/commerce-transactionsList transactions

Questions

Does the Commerce API API need an API key?

Yes. The Commerce API API uses API key authentication; the documentation explains how to get credentials.

Does the Commerce API API support HTTPS?

Yes, the Commerce API API is served over HTTPS.

How many endpoints does the Commerce API API have?

Its OpenAPI description lists 11 endpoints in version 2.1.0. All of them are shown on this page.

What are alternatives to the Commerce API API?

Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.

Compare alternatives →

Listed from APIs.guru (CC0).