BigCommerce is a platform for creating online stores, including tools for SEO, hosting, marketing, and security. The BigCommerce Connector App keeps your Yext account in sync with your BigCommerce product catalog.

This guide covers three steps:

1. Create an API account in BigCommerce
2. Install the BigCommerce Product Connector App
3. Set up webhooks in your BigCommerce account

Create an API account in BigCommerce

You'll need to create a custom API account in BigCommerce to give Yext permission to access your store.

1. Navigate to Settings > API > API Accounts.
2. Click Create API account, select V2/V3 API Token as the Token type, and give the account a name.
3. Under OAuth scopes, select read-only next to Products. Leave all other scopes set to None.
4. Click Save. A popup will display your BigCommerce API Credentials, and a .txt file will automatically download to your computer. Save the .txt file or copy the Client ID, Client Secret, and Access Token. You will need these when installing the BigCommerce Connector App in Yext. You will not be able to access this information again. If you lose these credentials, repeat steps 1–4 to create a new API account.
5. Click Done.

Install the BigCommerce Product Connector App

This app creates one connector: the BigCommerce Products Connector, which pulls in product data and product detail fields.

1. Navigate to Apps > Directory and search for the BigCommerce Product Connector app.
2. Review the app details and click Install.
3. Allow the connector to access your Yext account by clicking Next.
4. Input the following:
   • Access Token: From the .txt file generated in Step 1.
   • Store Hash: The 10-character string in the API Path URL from the .txt file, e.g., https://api.bigcommerce.com/stores/YOUR-STORE-HASH/v3/.
   • Sale Price Currency: The currency code for sale prices (USD, EUR, INR, etc.).
   • Store Name: Found at the beginning of your storefront URL, e.g., https://YOUR-STORE-NAME.mybigcommerce.com/. Do not include "mybigcommerce.com" — enter your store name only.
   • Retail Price Currency: The currency code for retail (regular) prices (USD, EUR, INR, etc.).
5. Click Authorize, which will install and run the connector. You will be redirected to the BigCommerce Product Connector overview page.
6. Click Run Connector to pull in all your products.

After installing, you can click Edit Configuration to add additional data transforms or field mappings.

Set up webhooks in your BigCommerce account

To keep your product information up to date, set up a webhook so that whenever product data changes in BigCommerce, your connector re-runs automatically. If webhooks are not configured, your connector will still sync updates every hour.

1. Create a Yext Developer App with Read/Write permission for the Management API > Connectors endpoint. See Create an App for full steps.
2. Click the eye icon to reveal the API Key and copy it. You will need it in the POST request below (YOUR_API_KEY).
3. Create a POST request to: https://api.bigcommerce.com/stores/[store-hash]/v3/hooks (replace [store-hash] with your 10-character store hash).

4. In the body of the POST request, add the following code, replacing YOUR_API_KEY with your Yext API key:

   {
     "scope": "store/product/*",
     "destination": "https://api.yext.com/v2/accounts/me/connectors/bigCommerce_ProductsConnector/trigger?v=20230221&runMode=COMPREHENSIVE&api_key=YOUR_API_KEY",
     "is_active": true,
     "events_history_enabled": true,
     "headers": {
       "custom": "string"
     }
   }

You have now created a webhook to trigger a new connector run any time product data changes in BigCommerce. Make a change to one of your products in BigCommerce to test that the webhook is working.