> For the complete documentation index, see [llms.txt](https://helpcenter.channable.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://helpcenter.channable.com/list-advertise/orders/order-connections/supported-ecommerce-platforms-for-order-connections/how-to-set-up-the-channable-api-for-an-order-connection.md).

# How to set up the Channable API for an order connection

Learn how to set up the Channable API for Order Sync when your webshop platform is not supported and test the connection with a sandbox order.

Use the Channable API when your webshop platform is not supported for Order Sync. You build the integration in your own backend. Channable still handles the marketplace side of the order connection.

The API reference is at [api.channable.com](https://api.channable.com/v1/docs).

***

### <i class="fa-memo-circle-check">:memo-circle-check:</i> Before you start

**You’ll need**

* The order-sync add-on
* [A compatible marketplace](/list-advertise/orders/order-connections/supported-marketplaces-for-order-connections.md)
* Owner access (required to generate token)

**Good to know**

* This is a technical process that often requires a developer’s help.
* The Channable API can connect to any eCommerce platform

{% stepper %}
{% step %}

### Generate a Channable API token

1. Open **Company settings**:

{% tabs %}
{% tab title="Modern version" %}

<figure><img src="https://3067532480-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8GepmoSonQRG6RnHOxJ%2Fuploads%2FFKAkbYMNwRFrQZ4LUdCw%2Fgenerate-token.png?alt=media&amp;token=31089fb4-5e58-4933-aa69-e4c3cb573d47" alt=""><figcaption></figcaption></figure>

In the company dropdown, select **Company settings**. Then open **Channable API**.
{% endtab %}

{% tab title="Legacy version" %}
![](https://3067532480-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8GepmoSonQRG6RnHOxJ%2Fuploads%2FSzbIU0ITCRPJ1Xtbxeu6%2Funknown.png?alt=media\&token=f99645ed-aee1-4eb6-be68-cfd8915f5177)

1. In the sidebar while in the company, select **Company settings > Channable API**.
2. Click **Generate token**.
3. Click <i class="fa-clipboard">:clipboard:</i> to copy your token.
   {% endtab %}
   {% endtabs %}
   {% endstep %}

{% step %}

### Set up your backend to use your new token

The technical documentation for implementing the Channable API can be found [here](https://api.channable.com/v1/docs).

{% hint style="info" %}
**Note:** This is a technical process that often requires a developer’s help.
{% endhint %}
{% endstep %}

{% step %}

### Send a test order via Channable sandbox

Sending a test order tests whether Channable can successfully send and receive information from your backend source. It does not test whether it can receive information from your marketplace channels.

{% hint style="warning" %}
**Important:** Make sure the Product ID provided matches the Unique ID for your items in your webshop.
{% endhint %}

1. Go to **Setup > Order connections**.
2. For **Platform**, select Channable API.
3. For **Channel**, select Channable Sandbox.
4. Click **Save**.
5. Click **Send test > Send test order**.
6. Provide the following information:
7. **Product ID:** Fill in the product ID of an item from your imported items. *This ID must be the same unique ID used for that item in your webshop.*

{% hint style="info" %}
**Note:** You can test multiple products by separating your IDs with commas.
{% endhint %}

8. **Country:** Select a country you sell this item in.
9. Click **Send test order**. Channable will test using randomized product information (e.g. price, description).
   {% endstep %}
   {% endstepper %}

If successful, your test order will appear in your Channable account. If you receive an error message or are unable to send a test order, please [contact our technical support team](https://app.gitbook.com/o/QRs4Yua0yRsGzJScLQzF/s/UAGSVlvcNsqEqVUgr0tD/contact-support).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://helpcenter.channable.com/list-advertise/orders/order-connections/supported-ecommerce-platforms-for-order-connections/how-to-set-up-the-channable-api-for-an-order-connection.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
