For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.


Before you start

You’ll need

  • The order-sync add-on

  • A compatible marketplace

  • 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

1

Generate a Channable API token

  1. In your Channable account, go to Company settings > Channable API.

  2. Click Generate token.

  3. Click to copy your token.

2

Set up your backend to use your new token

The technical documentation for implementing the Channable API can be found here.

Note: This is a technical process that often requires a developer’s help.

3

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.

  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.

Note: You can test multiple products by separating your IDs with commas.

  1. Country: Select a country you sell this item in.

  2. Click Send test order. Channable will test using randomized product information (e.g. price, description).

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.

Last updated

Was this helpful?