APIHub
Back to Explore

Commerce API

Codat's Commerce API allows you to access standardised data from over 11 commerce and POS systems.

Shopping
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-customers

List customers

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-disputes

List disputes

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-info

Get company info

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-locations

List locations

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-orders

List orders

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods

List payment methods

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-payments

List payments

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories

List product categories

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-products

List products

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
GET

/companies/{companyId}/connections/{connectionId}/data/commerce-taxComponents

List tax components

GET

/companies/{companyId}/connections/{connectionId}/data/commerce-transactions

List transactions

  • page (query, required, page) — Page number. [Read more](https://docs.codat.io/using-the-api/paging).
  • pageSize (query, limit) — Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
  • query (query) — Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
  • orderBy (query) — Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).

11 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X GET \
  "https://api.codat.io/companies/{companyId}/connections/{connectionId}/data/commerce-customers" \
  -H "Authorization: YOUR_API_KEY"

api.codat.io · HTTPS only