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

​
Installation Instructions

1

Navigate to your Store-level API Tokens

  1. Go to Settings › Store-level API Tokens
     and click
    Create API account
    .
2

Configure your API Token

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

Create a new Server-side source in Converge

  1. In Converge, click on Create a new source
  2. Pick Server-side from the modal
  3. Name your source: e.g. {Storename} Store Backend
  4. Choose the BigCommerce app from the dropdown menu.
4

Connect the Source to BigCommerce

  1. Enter the hash parameter from the API path retrieved in Step 4.
    If your API path is https://api.bigcommerce.com/stores/xxxxxx/, the hash is xxxxxx.
  2. Paste the Access Token from the .txt file in Step 6 in the Access Token field.
  3. Unless you have a good reason not to, you should leave Storefronts and Start Date blank. Click on Create Source.
    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.

​
Event Spec

This integration auto-tracks the following events on the server with all properties available according to the Converge Event Spec.

Event NameEvent Description
Placed OrderWhen a customer places an order.

​
Sales Channels

Events received by Converge from Bigcommerce are automatically mapped to Converge’s sales channels types whenever possible.

More on sales channels can be found here.

Converge fall back to “web” if a mapping cannot be found. This is typically the case with third party integrations with Bigcommerce.

An example of how Converge map Bigcommerce sales channels:

BigcommerceConvergeDescription
wwwwebBrowser
iphonewebiPhone web
ipadwebiPad web
androidwebAndroid web
mobilewebmobile browser
external-Orders API - depends on third party integration (e.g. Recharge)
manualofflineManual Order
checkout_apiwebCheckout API
buybuttonwebBuy Button
amazonmarketplaceAmazon integration
ebaymarketplaceEbay integration
facebookcheckoutfacebook_shopFacebook Checkout
facebookshopfacebook_shopFacebook Shop
facebookmarketplacefacebook_shopFacebook Marketplace
pinterestfacebook_shopPinterest
socialshopmarketplaceSocial Shop