Vinculum Knowledge Central

BIGCOMMERCE

Integration Document
 

About BIGCOMMERCE

BigCommerce is a public technology company and provides a SaaS ecommerce platform.

It is an online store builder (hosted shopping cart software) that powers tens of thousands of online stores in more than 120 countries. It allows you to do everything yourself, including add products, upload photos, process orders, create pages, create discount coupons, and more. You can also design your store with it, using drag and drop panels. 

Founded in 2009, the company offers two plans for new or small to mid-size businesses, and two plans for large or high-volume businesses, each with various features ranging from fraud monitoring, abandoned cart saver, product ratings, and more. 

It serves a wide range of industries including fashion, electronics, health products, gifts, jewelry and others, and it can be integrated with various shopping and comparison sites like eBay, Shopzilla, Nextag, and Shopping.com. 

Integration Highlights

• SKU Pull
• Order Pull and Order Fetch 
• Order Status Update i.e. Awaiting Pickup, Awaiting Fulfilment, Shipped delivered etc 
• Order Shipment 
• Inventory Push
• Inventory Reconciliation
• Order Returns (Only Returned Status) 
• Order Cancellation Push                                            

Prerequisites of Integration

•  API Credentials

• API URL

How to get API Credentials?

App API Credentials: We can create app API credentials in the BigCommerce Developer Portal. App API credentials are used during the OAuth flow to request authorization “on behalf” of a store owner, allowing the app to make API requests against store data. App API credentials are OAuth only, and the store owner must install the app before the app is granted access to the store. To get the API Credentials, you have to create API Accounts on the admin page of your BigCommerce store. Only the user set as a store owner can create API Accounts, and a maximum of 50 accounts can be created per store.

 1. Login to your BigCommerce Admin Portal.

2. Go to Advanced Settings >  API Accounts > Create API account. Choose Create V2/V3 API Token.

3. Enter a Name for the app/migration corresponding to this account. Then copy or make note of the API Path – you’ll need it to interact with the API.

4. Under OAuth Scopes, specify the API resources and permissions to which your app/migration requires access. Select the “Modify Scope” (Customer, order, products, order transactions, carts)

5. Click on the “Save” button. If it’s successful, a .txt file containing the API credentials will download to your computer and a pop-up containing the same credentials will be displayed. This file also contains the base API Path for your store, preconfigured for the V3 API. 

Note: Save your credentials. There is no way to re-display this pop-up after selecting Done, so be sure to securely store the credentials before exiting this screen.

The base API path will look like this: https://api.bigcommerce.com/stores/123456. 

In the base path, the store hash is 123456. 

This API URL format, Client ID, Client Secret details are required in Channel Configuration in Vin ERP instance.

Channel Configuration

Once the API Credentials are gathered Open Vin ERP instance.

1. Login to Vin ERP instance and go to “Manage Channels” under the sales section.

2. Go to the top right-hand side of the window and click on “Add New.”         
                                       

3. Pick the channel from the list.

4. Fill in all the details like Channel Name, order Source WH, Order Sync from date, Return Sync from Date, Inventory Sync Method, Enable Inventory Reconciliation, etc. as per the Channel Maintenance window.

5. Click on “Configure Interface.” 

6. Enter the details.

a. API URL: The API URL of the BIGCOMMERCE website should be like: https://api.bigcommerce.com/stores/123456 (only the store Id varies, the base URL remains the same).

b. Minimum Inventory Level:  This works as BUFFER STOCK for BigCommerce. (The Buffer stock and Minimum Inventory Level value should always be the same). 

c. Client Id: API Client ID generated as mentioned above. 

d. Client Secret:  API Client Secret generated as mentioned above.

e. Minutes to add as per UTC time: BigCommerce works in UTC timezone and hence always the last order pull date/lasttransmitdate is 5 hours 30 minutes lesser than the current IST time.

For BigCommerce, the Time zone and Minutes are to be added as per the UTC and IST time difference. Make sure that the correct time in minutes is defined else orders will be created with incorrect timezones/DateTime. 

For Example: For India, the time difference is 5 hours 30 minutes and hence the user must convert 5 hours 30 minutes into minutes i.e., 330. So, Keep 330 this section. 

7. Click “OK.” Click on SAVE on the “Channel Maintenance” screen. A new channel code will be created.

5. Channel Maintenance

Channel Maintenance setup helps the client to reduce manual intervention and avoid the multiple usages of the website. With the selection of below options at Channel Maintenance window (Sales > Manage Channels > Add New > Select BigCommerce) in Vin eRetail instance, User can get the advantage of using multiple features of Vin eRetail:

Note:  Only Order return status is maintained.

Channel Mappings  

BIGCOMMERCER does not have any provision available to fetch the product Ids from the Admin portal. So, it is mandatory to use SKU Pull and Map the SKUs accordingly. 

Here BIGCOMMERCE Id needs to be mapped In-Channel Product Id and BIGCOMMERCE SKU is used at Channel SKU Code.