--- title: "Set Up BigCommerce Integration" slug: "set-up-bigcommerce-integration" description: "Review the following information before you connect BigCommerce to Gladly. Learn more on how to set up BigCommerce Integration in Help Docs." updated: 2025-01-13T17:14:34Z published: 2025-01-30T20:02:22Z --- > ## Documentation Index > Fetch the complete documentation index at: https://help.gladly.com/llms.txt > Use this file to discover all available pages before exploring further. # Set Up BigCommerce Integration | **REQUIRED USER ROLE** Administrator | **PERMISSION OVERVIEW** [View permissions by role](https://help.gladly.com/docs/managing-users-and-roles#roles-and-responsibilities) | | --- | --- | ## **Before you start** Review the following information before you connect BigCommerce to Gladly. - BigCommerce integrates with Gladly via the Lookup Adaptor. - Make sure you have proper account permission to create API accounts in BigCommerce. This is required to connect BigCommerce to Gladly. ## Set up BigCommerce API and Permissions 1. Before you continue with connecting BigCommerce to Gladly, you must first configure the correct permissions in BigCommerce. Go to Advanced Settings > API Accounts > Create API Account > Create V2/V3 API token. From there, follow the permission set as shown in the image below: ![configure the correct permissions in BigCommerce](http://connect.gladly.com/wp-content/uploads/2023/04/permissions20bigcommerce.png) 2. Set a name for this API Account Token. Use a name that allows you to easily identify that this account is used for Gladly. Click Save when you're done. 3. Once saved, BigCommerce will ask you to download a file like the text below. Take note of the Client ID and Access Token. ![Access token name for BigCommerce](http://connect.gladly.com/wp-content/uploads/2023/04/access20token20name20bigcommerce.png) ## Connect Gladly to BigCommerce The next step is to connect Gladly to BigCommerce. From the [Apps](https://help.gladly.com/docs/add-new-integration) page, click **Add App > BigCommerce**. 1. From the Add New BigCommerce App page, enter the following information: 1. **Name –** Enter a name that will help you identify the BigCommerce instance. 2. **Store Hash**– Enter the unique identifier for your store, which is found in the URL assigned to your store by BigCommerce. - **Note – D**o not include the text "store-" when entering the Store Hash value into Gladly. For help finding your Store Hash ID, click [here](https://support.bigcommerce.com/s/question/0D54O00006QpiLnSAJ/where-i-get-store-hash-code?language=en_US). 3. **Client ID** – Enter the Client ID from the downloaded file. This is required to allow the processing of refunds, cancellations, and discounts. 4. **Access Token –** Enter the Access Token from the downloaded file. This is required to allow the processing of refunds, cancellations, and discounts. 5. **Search Query Attributes –**There are two columns (Attribute, Label) required for Search Query Attributes. You can look up Customers using email/Email or phone/Phone Number attributes. - You must have at least one search attribute (email or phone number). - **Don't change** the Attribute column for email or phone number. - Currently, only exact search by email or phone number is supported to query BigCommerce for matching Profiles. 6. **Search Results Attributes –**There are two columns (Attribute, Label) required for Search Results Attributes. The name/Name and email/Email attributes are the default attributes. Click Add an attribute to add a new attribute. - If you use an attribute besides email and phone, the column still appears for Agents, but it may not be populated with any information. See [List of Search Results Attributes](https://help.gladly.com/docs/set-up-bigcommerce-integration/#list-of-search-results-attributes) below. 7. **Auto-Linking Fields –**If a Customer Profile is not currently linked to a BigCommerce instance and if your BigCommerce instance responds with a unique profile with at least one [auto-linking](https://help.gladly.com/docs/automatically-link-customer-data) field match and no conflicts, Gladly will automatically link the profiles without any user intervention and populate the pulled information in the Customer Profile. - **Customer Email –** Check this box to activate auto-linking by matching email addresses. - **Phone Number –** Check this box to activate auto-linking by matching phone numbers. 8. **Overwrite Existing Values –** If activated and a Customer Profile is linked to a profile in BigCommerce, Gladly will overwrite the existing name, address, and editable custom attributes in the Customer Profile with data from BigCommerce. 9. **Actions –** If activated, Agents can complete [Actions](https://help.gladly.com/docs/refund-discount-and-cancel-orders-through-bigcommerce-actions) like process refunds, create discount codes, and cancel orders without leaving Gladly. 10. Click **Save App** when you're done. An error will appear if required fields are not completed; they are highlighted in red. Complete the missing fields and click Save App again. ## **List of Search Results Attributes** BigCommerce allows a specific set of attributes to be pulled and displayed in Gladly. For the **Attribute** column, you can use: - name - phone - email - externalCustomerId You can use any **Label** for each attribute that provides an Agent friendly name for the attribute. For example, *phone* can be labeled as *Phone Number*. Click the **trash** icon to delete an attribute. If you use an attribute not listed above, the column still appears for Agents in the search results table, but it will not be populated with any information.