Connect BigCommerce

Connecting BigCommerce takes about five minutes and needs no code. You create an API account in your BigCommerce control panel, paste two of its values into Clakta, and Clakta creates the order webhooks for you. It can also add the Clakta script to your storefront.

Create an API account in BigCommerce

The API account is what lets Clakta read your orders. Clakta needs these permissions on it:

Content and Checkout content are only used to install the Clakta script. If you plan to add the script by hand, you can leave them on None.

1. In your BigCommerce control panel, go to Settings → Store-level API accounts and click Create API account.
2. Set Token type to V2/V3 API token and give the account a name, such as Clakta.
3. Under OAuth scopes, set the permissions in the table above. Leave every other scope on None.
4. Click Save. BigCommerce shows the account's credentials. Keep that window open: you need the API path and the Access token.

Connect in Clakta

You need to be an owner or an editor of the team to connect a sales platform.

1. Open your project and go to Project settings → Sales platforms.
2. Find BigCommerce and click Connect.
3. Paste the API path. It looks like https://api.bigcommerce.com/stores/abc123/v3/.
4. Paste the Access token.
5. Leave Install the Clakta Script automatically on. The next section explains what it does.
6. Click Connect.

Clakta checks the API account before saving anything. When it's done, the BigCommerce card shows your store's name and Added.

Clakta then creates three webhooks on your store: one for new orders, one for order updates and one for refunds. New orders reach Clakta within a few seconds. Orders placed before you connected are not imported.

Clakta stores the access token encrypted. It only uses it to read your orders and to manage its own webhooks and scripts.

Turn on the Clakta script

The Clakta script records the visits to your store and links each order to the visit that led to it. With Install the Clakta Script automatically on, Clakta adds two scripts in BigCommerce under Storefront → Script Manager:

• Clakta Script runs on every page and records visits.
• Clakta Purchase runs on the order confirmation page and tells Clakta which visit placed the order.

Leave both as they are. If one is deleted or disabled, Clakta puts it back within a day.

The order confirmation script works on BigCommerce's standard themes (Stencil). Catalyst storefronts don't run it, so their orders arrive without a visit attached.

If you turned the automatic installation off, you can still add the script by hand: in Clakta, go to Project settings → Script, open Install instructions on the script's row and follow the BigCommerce steps. That records visits, but only the automatic installation adds Clakta Purchase, so orders won't be linked to visits.

Disconnect

When you disconnect the store in Clakta, Clakta removes its webhooks and both scripts from your store and deletes the access token it kept. To make sure Clakta can't reach your store anymore, also delete the API account in Settings → Store-level API accounts.

Common questions