Setup BigCommerce

You can:

  • Connect multiple BigCommerce shopping carts to import Sales Orders and create or match to the corresponding Customer records in your system.
  • Import Customer Orders as:
     
    • Pending Sales Orders
    • Pending Cash Sales
    • Pending Sales Invoices

This includes Tax, Shipping Charges and Gift/Discount Coupons, which will be displayed on Sales Orders as separate line Items.

  • Import Item master details from BigCommerce.
  • Update stock levels in BigCommerce from your system.

To connect your cart

Before you begin, you’ll need to create an ‘API Account’ in the BigCommerce Admin area of your store.

  1. Go to ‘Advanced Settings’ > ‘API Accounts’ > Create API Account
  2. On the ‘Create API Account’ menu dropdown, choose ‘Create V2/V3 APi Token’

Before you go any further you need to know the data you will need to record and paste into your Salesorder system will only appear once when you Save the API Account setup.

        3. You’ll need to set a relevant ‘Name’ for this API Account, so you can             recognise it later. The name has to be more than three characters.

        4. Make a note of the URL in the API Path field, you’ll need this later.

Now you need to set the ‘OAuth scopes’. These control what sections of the API an external system like Salesorder can access and read, write to, or modify.

        5. You should set your ‘OAuth scopes’ as follows:

Capture 111

In this article

        6. When you ‘Save’ your settings, the system will automatically generate a screen containing:

                       a. CLIENT ID:
                      b. ACCESS TOKEN:

        7. The system will also give you an option to download a .txt file containing:

                       a. ACCESS TOKEN:
                       b. CLIENT NAME:
                       c. API PATH:
                       d. CLIENT ID:
                       e. CLIENT SECRET:

           Save this file to a folder you can easily locate.

        8. Go to Setup>Shopping Carts>Actions>New BigCommerce Cart

        9. Enter the corresponding data into the following fields:

Shopping Cart Type

This will be set by default to ‘BigCommerce’

Cart name (mandatory)​

Specify a name e.g. Nick’s Cart.

Cart Connect URL (mandatory)​

Copy and paste this value from ‘API Path’, you’ll find it here:

BigCommerce Admin>Advanced Settings>API Accounts>Create API Account’

It should looks like this:

https://api.bigcommerce.com/stores/w5z5htrnkd/v3/

API Version (mandatory)

Select V2 or V3 in the dropdown.

June 2021: Our system supports integration with BigCommerce V2 and V3. The API Path will contain the version suffix. For example:

https://api.bigcommerce.com/stores/w5z5htrnkd/v3/

The cart version you should select is ‘V3’ as indicated at the end of the above API path address.

API Key (mandatory)

In the V3 integration the API Key is a concatenation of: 

  • ClientID
  • Access Token

You should enter these two values separated by a colon (:)

ClientID:Access Token, here’s an example

kcv50obtxqx2za2ox73u8qohbg29hii:88w6xund9dhk5b087uocysw5v6wgrqq

Customer Prefix (optional)

When your Salesorder system imports a new order, if the Customer does not already exist you system creates a new Customer record together with the corresponding Sales Order. The value you enter in the ‘Customer Prefix’ field is prefixed to Customer Ref#.

Order Prefix (optional)

When your Salesorder system imports a new order it creates a new Customer record together with the corresponding Sales Order. The value you enter in the ‘Order Prefix’ field is prefixed to Sales Order Ref#.

Important: If you don’t set a prefix your system will not create and form order numbers correctly. You’ll see the correct order numbers in your BigCommerce admin area and on the Import Orders tab in your Salesorder system, however when Salesorder imports the order from your store, the Ref# of the corresponding Sales Order created in your system will contain a random string of characters.

Import Orders with Status (optional)

To stipulate which types of orders you want Salesorder to import you can insert value from this list into this field.

Make sure you separate them with a comma as in the list below.

Pending, Awaiting Payment, Awaiting Fulfillment, Awaiting Shipment, Awaiting Pickup, Partially Shipped, Completed, Shipped, Cancelled, Declined, Refunded, Disputed, Manual Verification Required , Partially Refunded

Customer Address Origin (optional)

To stipulate which types of orders you want Salesorder to import you can insert value from this list into this field.

Make sure you separate them with a comma as in the list below.

Pending, Awaiting Payment, Awaiting Fulfillment, Awaiting Shipment, Awaiting Pickup, Partially Shipped, Completed, Shipped, Cancelled, Declined, Refunded, Disputed, Manual Verification Required , Partially Refunded

Properties to Link Customers

Using field names from the Customer Master in Salesorder and separated by a comma, you can specify how when your system creates a new customer record from an imported order your system checks for an existing customer record (to avoid duplicates) or stores a Sales Order from an existing customer on the commensurate record.

For example, you might store just the email address as the unique key for a check for a match.

Item Code for Shipping Costs

When your Salesorder system creates a new Sales Order from an imported cart order, if the captured order has a shipping charge then this is added to the Line Item Table as a normal Item.

To specify which Item is added you add the Item name in this field.

Item Code for discount (Gift:Store Credit:Coupon)

To model and apply discounts to a customer order, or offer a customer a credit you’ll need to create an appropriate item in salesorder and then use this so the system can add this item to the Sales Order i.e. a Discount Item (See Discount Items).

When the store captures a Sales Order and Store Credit, or Coupon is applied it will be recorded on the Sales Order by the Discount Item you specify in this field. See Discount Items.

If the Discount Item name is ‘Store Discount’ then the syntax for a ‘Store Credit’ would be –  :Store Discount:

If the Discount Item name is ‘Coupon Discount’ then the syntax for a ‘Store Credit’ would be – ::Coupon

Note the position of the colons.

Gift:Store Credit:Coupon

Item Code for Gift certificate

If you are selling Gift Certificates, you’ll need to create a corresponding Item and enter the name of this Item Here.

Cart timezone shift

Use this field to align the timezone settings in your cart and Salesorder system by the difference i.e. -6.

Was this helpful?