# Integrate with BigCommerce

> BigCommerce  is an online shopping platform for established and rapidly-growing businesses. Integrate BigCommerce with Kustomer to see your customer's purcha...

Source: https://help.kustomer.com/en_us/integrate-with-bigcommerce-HJUd5LBhP

Last updated: 2025-08-22T17:54:19.347Z

[BigCommerce](https://www.bigcommerce.com/) is an online shopping platform for established and rapidly-growing businesses. Integrate BigCommerce with Kustomer to see your customer's purchases in the Kustomer timeline.

**Who can access this feature?**

**User types**

Admins can set up this integration.

  

### In this article

*   [Prerequisites](#prerequisites)
*   [How does BigCommerce work with Kustomer?](#features)
*   [Install the BigCommerce app](#install)
*   [Set up BigCommerce API](#api)
*   [Configure BigCommerce with Kustomer](#configure)
    *   [Updated order events](#updated)
    *   [Created order events](#created)
*   [FAQ](#faq)

### Prerequisites

Before starting the integration process, you must already have a store set up in BigCommerce.

### How does BigCommerce work with Kustomer?

Orders created or updated in BigCommerce are imported into Kustomer using an API subscription you'll create in Postman. Orders from BigCommerce will appear as a custom object with up to 10 custom fields on the customer timeline. This will display order information from BigCommerce, including order number and date, shipping and billing information, and products ordered.

![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/945c2e8846e2e743d83bbd8b2b60e536.png)

In addition, a BigCommerce insight card also displays summarized order details.

![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/475f377faa1ae1a6892bd401abdba687.png)

### Install the BigCommerce app

To integrate BigCommerce with Kustomer, install the BigCommerce app from within the Kustomer App Directory.

1.  Go to **Apps** and select **Explore Directory**.
2.  Search for **BigCommerce** in the App Directory, and then select **Install**.

This app installs various components in your Kustomer Settings, in the following locations:

*   Apps > BigCommerce (primary settings)
*   Platform > Klasses > _bigcommerce-order_ (Klass, attributes and KlassView)
*   Platform > Workflows > App Created > _big-commerce-ingest_ (ingests BigCommerce orders)
*   Platform > Form Hooks > _bigcommerce-1.0.1_ (used with ingest workflow)

### Set up BigCommerce API

Then, use the [BigCommerce API](https://developer.bigcommerce.com/api-docs/store-management/webhooks/overview) to create a webhook and API keys.

1.  [Obtain Store API Credentials](https://developer.bigcommerce.com/api-docs/getting-started/authentication/rest-api-authentication#obtaining-store-api-credentials%23obtaining-store-api-credentials): generate a Store API key by going to **Advanced Settings > API Accounts > API Keys** and call this key `Kustomer Integration`.
2.  A popup titled _BigCommerce API Credentials_ will appear and save a text file to your computer containing the Client ID and API Token. These two fields correspond directly to the **BigCommerce client ID** and **BigCommerce API token** fields in the Kustomer settings.
3.  Leave this window open while you return to the Kustomer Settings in another browser window.
4.  Back in Kustomer, Go to **Apps** and select **BigCommerce** in the sidebar. Copy the **Client ID** and **API Token** from the BigCommerce page into the corresponding fields in the Kustomer settings.  
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/4dddf68f6cefb7fb07426b968d4fd7b4.png)
5.  In the BigCommerce settings, return to **API Accounts > API Keys** and select the `Kustomer Integration` key. Use the toggles in the _OAuth Scopes_ section to grant **read-only** access to the following API resources: 
    *   **Orders**
    *   **Products**
    *   **Customers**
    *   **Information & Settings**
6.  Locate the _API Path_ field and note your store hash _within the URL._ The **store hash** is the alphanumeric value underlined in the screenshot below. Copy this alphanumeric store hash (not the entire URL) to the Kustomer Settings, into the **BigCommerce store hash** field.  
      
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/9b92a9f4c0c97bcf2e851575814e79ec.png)  
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/63e59cf3de23501550652a7d9b59a56f.png)

### Configure BigCommerce with Kustomer

After you install the BigCommerce app, you'll need to create the Call Events Subscription using Postman. You'll be creating requests to subscribe to two types of BigCommerce events:

*   [Updated order events](#updated)
*   [Created order events](#created)

#### To make the request for _updated order events_:

1.  Open Postman.
2.  Make a `POST` request to `https://api.bigcommerce.com/stores/**store hash**/v2/hooks` where **store hash** is the alphanumeric value used earlier during the setup process.  
      
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/61735b904006ab1e15999bdd428438ac.png)
3.  Select the **Body** tab and enter the following payload for _updated order events_:  
    
    { "scope": "store/order/updated",  
    "destination": "FORM HOOK URL GOES HERE",  
    "is\_active": true }
    
    **Note:** In the payload, the **destination** is the hook address for the _bigcommerce-1.0.1_ form hook. This hook is automatically created when installing the app. You can locate and copy the address by going to **Settings**![](https://lh5.googleusercontent.com/lGzoLBbAypGJVuWQZaP0-DNdRHeQ2ib6VPQXVVoUeKQ2vDwl1D3MVh2FXs2cerbHPw74pBM8pc0X0Te1oxGcbB8uU1UdsrtKnYS2YJbu7wL44IM13O9R6Un89txcaCtvGVETiSVy)**\> Platform > Inbound Webhooks > Form Hooks**, then select the **More** menu at the right.  
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/ed0961d22e399c249a988383a8ad8181.png)
    
4.  Select the **Headers** tab.
5.  In an empty row, type `X-Auth-Token` into the _Key_ column, then for the _Value_ enter the correct API key from the saved file.
6.  Repeat this process to add another header key named `X-Auth-Client`, with the corresponding saved value.  
      
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/42ac7ecb1e7568bc2d4fda601c11df68.jpg)  
    
7.  Select **Send** to submit the request. Confirm that the payloads are correct by checking the hook logs and that orders are being created.

#### To make the request for _created order events_:

1.  Open Postman.
2.  Make a `POST` request to `https://api.bigcommerce.com/stores/**store hash**/v2/hooks` where **store hash** is the alphanumeric value used earlier during the setup process.  
      
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/61735b904006ab1e15999bdd428438ac.png)
3.  Select the **Body** tab and enter the following payload for _updated order events_:  
    
    { "scope": "store/order/created",  
    "destination": "FORM HOOK URL GOES HERE",  
    "is\_active": true }
    
    **Note:** In the payload, the **destination** is the hook address for the _bigcommerce-1.0.1_ form hook. This hook is automatically created when installing the app. You can locate and copy the address by going to **Settings**![](https://lh5.googleusercontent.com/lGzoLBbAypGJVuWQZaP0-DNdRHeQ2ib6VPQXVVoUeKQ2vDwl1D3MVh2FXs2cerbHPw74pBM8pc0X0Te1oxGcbB8uU1UdsrtKnYS2YJbu7wL44IM13O9R6Un89txcaCtvGVETiSVy)**\> Platform > Inbound Webhooks > Form Hooks**, then select the **More** menu at the right.  
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/ed0961d22e399c249a988383a8ad8181.png)
    
4.  Select the **Headers** tab.
5.  In an empty row, type `X-Auth-Token` into the _Key_ column, then for the _Value_ enter the correct API key from the saved file.
6.  Repeat this process to add another header key named `X-Auth-Client`, with the corresponding saved value.  
      
    ![](https://cdn.kustomerhostedcontent.com/media/570fad9d9001bc1000163b28/42ac7ecb1e7568bc2d4fda601c11df68.jpg)  
    
7.  Select **Send** to submit the request. Confirm that the payloads are correct by checking the hook logs and that orders are being created.

After following these steps, orders placed through your BigCommerce store will be shown in Kustomer under a customer's timeline.

### FAQ

**Q: Are there any best practices for avoiding issues with importing orders?**

Yes, it's possible to see errors if an order is created then immediately updated. This occurs because when events occur simultaneously, the workflow might attempt to process the orders individually and create duplicate custom objects (KObjects).

You should be able to avoid this as long as there's a short delay between creating and updating an order in BigCommerce. Once one of the two events processes the order payload and creates a custom object, subsequent events with that object should update without issue.