# Commerce API API

> Commerce API API on Apizie: 11 endpoints (List customers, List disputes, Get company info, List locations, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/ecommerce:codat-commerce/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:codat-commerce`
- Category: E-commerce
- Status: byok
- Source: https://codat.io
- Page: https://apizie.tech/api/ecommerce/codat-commerce
- OpenAPI: https://apizie.tech/api/ecommerce/codat-commerce/openapi.json

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,…

## Endpoints

### List customers
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### List disputes
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-disputes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### Get company info
`GET https://apizie.tech/v1/ecommerce:codat-commerce/get-company-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |

### List locations
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-locations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |

### List orders
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### List payment methods
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### List payments
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### List product categories
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-product-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### List products
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

### List tax components
`GET https://apizie.tech/v1/ecommerce:codat-commerce/get-tax-components` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |

### List transactions
`GET https://apizie.tech/v1/ecommerce:codat-commerce/list-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Unique identifier for your SMB in Codat. |
| connectionId | string | yes | Unique identifier for a company's data connection. |
| page | integer | yes | Page number. [Read more](https://docs.codat.io/using-the-api/paging). |
| pageSize | integer | no | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). |
| query | string | no | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). |
| orderBy | string | no | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). |

## Example
```
curl "https://apizie.tech/v1/ecommerce:codat-commerce/list-customers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Commerce API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/ecommerce:codat-commerce/list-customers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Commerce API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Commerce API itself also needs your own key from codat.io.

### Can AI agents use the Commerce API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:codat-commerce.

### What is the status of the Commerce API API?
Needs your own provider key (bring your own key)