Using the Channable API for an order connection

If you are not using any of the eCommerce platforms that Channable supports for an order connection, you have the option to connect to the Channable API. By doing so, you still make use of the advantages of our order connection features.

This method does require some programming on your end, but it offers the flexibility to connect with any other eCommerce platform. In this article, we provide some general information about the Channable API, including its functionalities, costs, and how to start using the Channable API.

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

Functionalities

The functionalities for which the order connection can be used are lined out on our website.

Important: we don't support the full list of features for every marketplace. Check out Order connections for marketplaces to find out for which marketplaces Channable supports an order connection and the possible exceptions.

Costs

Using the Channable API is free of charge on its own, however, we do invoice an amount each month per order connection that's set up in your Channable account.

Importing products

The Channable API is currently used exclusively for processing orders. To send your products to marketplaces, you must first set up an import in your project. This enables you to send the products to the marketplace of your choice.

Information on how items can be imported can be found here.

Important: If you don't have an active feed or API to make listings on your desired marketplace, please create one as an active export is needed for an order connection to work reliably.

Getting started

1

Enable the Order sync add-on

To be able to use the Channable API, you need to have the Order sync add-on enabled in your subscription. You can find more information about this add-on and how to enable it on this page.

2

Generate an API token

Once the Order sync add-on is added to your account, you will get access to the Channable API in your account menu. Here you can generate an API token for the Channable API.

Note: Only owners of companies can generate an API Token.

3

Set up your backend to use the API token

After you generated your token, you can now continue to set up the Channable API connection.

All information on how to use the Channable API token, and how to set up your webshop backend to work with the Channable API, can be found in the technical documentation on this page.

If you have issues regarding the setup or if you have any questions regarding the Channable API, you can contact [email protected]. Make sure to mention 'Channable API' in the subject of your e-mail.

Sending a test order

You can test the order connection yourself by sending test orders. You can use the Channable Sandbox environment to do this. The sandbox will mimic the behavior of real channels without connecting them. First set up an order connection between the Channable API and the Channable Sandbox by going to Setup > Setup Orders and selecting 'Channable API' as the platform and 'Channable Sandbox' as the API.

1

Activate the order connection

Activate the order connection you set up between Channable API and Channable Sandbox.

2

Send the test order

Go to Setup > Setup orders > Settings. Click on the gear icon in the top right and select 'Send test order'. Fill in the ID of the product you want to send the test order with and the country, and then you can send the test order.

3

Sandbox specifications

For the exact specifications for sandbox testing, see this part of the API documentation.

Setting up the transporter

You can set up the transporter for the order connection in Channable like any other order connection by following this guide. To see the specifications of setting up the transporter in the Channable API documentation, follow this link.