> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/bigcommerce-prebuilt-connector.md).

# BigCommerce (prebuilt connector)

## Description

**BigCommerce** is a cloud-based eCommerce platform, providing software as a service services to retailers.

## API documentation

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

{% embed url="<https://developer.bigcommerce.com/docs/api>" %}

## Authentication

When adding connector instances for BigCommerce, 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>store hash</code></td><td>true</td><td>Generated when you follow instructions to create a BigCommerce <strong>API account</strong> for your store.</td></tr><tr><td><code>token</code></td><td>true</td><td>Generated when you follow instructions to create a BigCommerce <strong>API account</strong> for your store.</td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
**Finding your store hash and access token**

**Step 1**\
Follow the instructions provided by BigCommerce - here:

{% embed url="<https://support.bigcommerce.com/s/article/Store-API-Accounts?language=en_US>" %}

**Step 2**\
Having completed these steps, you will see an API path - the number at the end is the **store hash**. Next, a pop-up window displays the **client ID**, **client secret** and **access token**. Add these details to your password manager immediately as they are only shown once.
{% endtab %}
{% endtabs %}