> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runconverge.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BigCommerce

> Connect your BigCommerce store backend to Converge

export const OutboundLink = ({linkText, linkTarget}) => {
  return <a target="_blank" href={linkTarget}> {linkText} 
    <div className="inline h-3 w-3 fill-gray-500 dark:fill-gray-100 text-gray-500 dark:text-gray-300 ml-1 mr-1">
      <svg className="inline w-2.5 h-2.5 bg-gray-500 dark:bg-gray-300" style={{
    maskImage: `url('https://mintlify.b-cdn.net/v6.5.1/solid/up-right-from-square.svg')`,
    maskRepeat: "no-repeat",
    maskPosition: "center center"
  }}></svg> 
    </div>
    </a>;
};

export const IconText = ({name, text, iconSource = "mintlify", iconLocation = "before", iconType = "solid"}) => {
  const sourceUrl = iconSource === 'local' ? `url('/images/icons/${name}.svg')` : `url('https://mintlify.b-cdn.net/v6.5.1/${iconType}/${name}.svg')`;
  return <>
            <div className="inline-block pl-2">
                {iconLocation === 'before' && <div className="h-3.5 w-3.5 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100 inline-block align-middle mr-2">
                        <svg className="w-4 h-4 bg-gray-800 dark:bg-gray-100 " style={{
    maskImage: sourceUrl,
    maskRepeat: "no-repeat",
    maskPosition: "center center"
  }} />
                    </div>}
                <span className="inline-block align-middle font-semibold fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100 pl-1 pr-2">{text}</span>
                {iconLocation === 'after' && <div className="h-3.5 w-3.5 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100 inline-block align-middle mr-2">
                        <svg className="w-4 h-4 bg-gray-800 dark:bg-gray-100 pr-3" style={{
    maskImage: sourceUrl,
    maskRepeat: "no-repeat",
    maskPosition: "center center"
  }} />
                    </div>}
            </div>
        </>;
};

<Note> This is a webhook-based source, meaning that it does not sync historical data. </Note>

## Installation instructions

<Steps>
  <Step title="Navigate to your Store-level API Tokens">
    1. Go to <OutboundLink linkText="Settings › Store-level API Tokens" linkTarget="http://login.bigcommerce.com/deep-links/settings/api-accounts" />  and click <IconText text="Create API account" name="plus" />.
  </Step>

  <Step title="Configure your API Token">
    2. Select **V2/V3 API token** as your **Token type**.
    3. Enter `Converge` in the **Name**-field
    4. Keep note of the API path, you will need it later.
    5. Under **OAuth Scopes**, grant Converge **read-only** access to all available scopes.
    6. Click **Save**. You will be prompted to download a `.txt` file containing the credentials you will need to set up your Converge source.
  </Step>

  <Step title="Create a new Server-side source in Converge">
    7. In Converge, click on **Create a new source**
    8. Pick *Server-side* from the modal
    9. Name your source: e.g. `{Storename} Store Backend`
    10. Choose the **BigCommerce** app from the dropdown menu.
  </Step>

  <Step title="Connect the Source to BigCommerce">
    11. Enter the hash parameter from the API path retrieved in *Step 4*.
        <Info> If your API path is `https://api.bigcommerce.com/stores/xxxxxx/`, the hash is `xxxxxx`. </Info>
    12. Paste the Access Token from the `.txt` file in *Step 6* in the **Access Token** field.
    13. Unless you have a good reason not to, you should leave **Storefronts** and **Start Date** blank. Click on **Create Source**.
        <Info> You might have multiple storefronts of which only one is relevant for Converge. In that case, you can pass the specific storefront name under **Storefronts** and Converge will only sync orders belonging to that Storefront.</Info>
  </Step>
</Steps>

***

## Event spec

This integration auto-tracks the following events on the server with all properties available according to the [Converge event spec](/sources/converge-spec).

| Event Name                                          | Event Description                |
| --------------------------------------------------- | -------------------------------- |
| [Placed Order](/sources/converge-spec#placed-order) | When a customer places an order. |

### Sales channels

Events received by Converge from BigCommerce are automatically mapped to Converge's [sales channels types](/sources/concepts/sales-channels) whenever possible.

More on sales channels can be found [here](/sources/concepts/sales-channels).

<Note> Converge falls back to "web" if a mapping cannot be found. This is typically the case with third-party integrations with BigCommerce. </Note>

An example of how Converge maps BigCommerce sales channels:

| Bigcommerce         | Converge       | Description                                                     |
| ------------------- | -------------- | --------------------------------------------------------------- |
| www                 | web            | Browser                                                         |
| iphone              | web            | iPhone web                                                      |
| ipad                | web            | iPad web                                                        |
| android             | web            | Android web                                                     |
| mobile              | web            | mobile browser                                                  |
| external            | -              | Orders API - depends on third party integration (e.g. Recharge) |
| manual              | offline        | Manual Order                                                    |
| checkout\_api       | web            | Checkout API                                                    |
| buybutton           | web            | Buy Button                                                      |
| amazon              | marketplace    | Amazon integration                                              |
| ebay                | marketplace    | Ebay integration                                                |
| facebookcheckout    | facebook\_shop | Facebook Checkout                                               |
| facebookshop        | facebook\_shop | Facebook Shop                                                   |
| facebookmarketplace | facebook\_shop | Facebook Marketplace                                            |
| pinterest           | facebook\_shop | Pinterest                                                       |
| socialshop          | marketplace    | Social Shop                                                     |