# ChannelEngine (prebuilt connector)

## Description

**ChannelEngine** ensures product info and stock levels are synchronised across marketplaces - syncing product information, product data and stock information across channels.

## API documentation

API documentation for **ChannelEngine** (used to build this connector) can be found via the link below:

{% embed url="<https://support.channelengine.com/hc/en-us/articles/4409515268637-Merchant-API-before-you-start>" %}

Swagger documentation is available by composing your own company-specific link (using your ChannelEngine tenant subdomain) as below:

{% code lineNumbers="true" %}

```
https://<tenant subdomain>.channelengine.net/api/swagger/index.html
```

{% endcode %}

For example:

{% code lineNumbers="true" %}

```
https://patchworks-dev.channelengine.net/api/swagger/index.html
```

{% endcode %}

## Authentication&#x20;

When adding connector instances for **ChannelEngine**, the following authentication methods are supported:

* [Token authentication](#token-authentication)

### Token authentication

{% tabs %}
{% tab title="Required credentials" %}
When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **token** authentication, the credentials below are prompted:

<table><thead><tr><th width="193">Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Environment</code></td><td>true</td><td>This is your ChannelEngine tenant subdomain. For example:<br><code>patchworks-dev</code></td></tr><tr><td><code>Token</code></td><td>true</td><td>This is the API key generated from the ChannelEngine dashboard. </td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
**Finding your environment**

**Step 1**\
Log into the ChannelEngine dashboard.

**Step 2**\
Note the subdomain in the URL - this is your environment setting:

<img src="/files/qzQTusEBnCrb25zjXa5C" alt="" data-size="original">

\
**Finding your token**

**Step 1**\
Log into the ChannelEngine dashboard.

**Step 2**\
Select **settings** from the left-hand navigation bar, then **merchant API settings**:

<div align="left"><figure><img src="/files/DAJCNxNIurEBValuRXwL" alt="" width="319"><figcaption></figcaption></figure></div>

**Step 3**\
Existing API keys are displayed:

<figure><img src="/files/F3iiGIFDOyzPyUA0TM9W" alt=""><figcaption></figcaption></figure>

If necessary, you can add a new one for Patchworks. &#x20;
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/channelengine-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.