Bigcommerce Webstore OAuth Authentication Integration Setup

Starting September 2018, the new OAuth Authentication is required for any new store setup with AmberPOS. Old integration expires December 31, 2018


1. Enable Webstore Licencing in AmberPOS


Please ensure that an invoice for the purchase of webstore integration has been completed before it can be setup.  Once purchased, AmberPOS should also be upgraded to the latest version of the software before setting up the webstore integration.

An AmberPOS representative will need to enable the webstore integration in AmberPOS.  Below information details how this is setup.



2. Configure Stores in AmberPOS


Next, navigate to the Stores tab.  Consultation between the AmberPOS representative and the customer should be done to determine whether transactions are to be imported into a different store in AmberPOS or into their existing retail store.  Setting it up in a different store is normally preferred as it is easier to separate retail sales from in-store ones based on Day End.  In this situation the AmberPOS representative can create a new store location in AmberPOS to populate the Webstore Integration settings.


Skip this step if you are using the existing retail location to populate the Bigcommerce Integration


Click on  in the top right corner of the screen.



2.1 - Populate the name "Webstore" for a required store name.

2.2 - Populate the id 50 unless it is already utilized.  You want an ID higher than the current store assignments so that the webstore always appears at the bottom of the list of store locations.

2.3 - Forward-date the expiry date to not expire until at least 100 years later.

2.4 - Save the options populate to create the store location.


3. Create Webstore Attributes


A) New integration setup

In the webstore location in AmberPOS that will populate the integration to Bigcommerce, navigate to the  tab and click on .



The following fields will be added into the window.  Each section of attributes are utilized for different factors of integration.


B) Converting to new integration

If a previous version of webstore integration has been setup, you may need to upgrade to the new integration fields, and remove old integration fields.

See: Managing Attributes


Fields to add


Fields to remove



4. Populate Webdav Attributes


Certain attributes fields populated here will be static, and the same for the majority of businesses.  Populate them as shown below.




The other fields that are available will have values that you populate from the customer's website based on the user account created on it for AmberPOS integration.  




4.1 - A new user account will be created on BigCommerce, which will be used for WebDav Integration.  The AmberPOS representative will create this account with a specific E-mail address.  


4.2 - On Bigcommerce you will navigate to Users and edit the account that was created via 4.1.  Editing this account will allow you to find the Password field.  Copy this value (without spaces) and paste it into 'WebDav Password' field in AmberPOS.


4.3 - On Bigcommerce you will navigate to Users and edit the account that was created via 4.1.  Editing this account will allow you to find the Path field.  Copy this value (without spaces) and paste it into 'The Web Store URL' field, removing the trailing 'dav' characters from the value you paste into the 'The Web Store URL' field.



 5. Populate API Attributes


In order to obtain the fields to populate into the AmberPOS API Attributes you will need to be logged into the Bigcommerce webstore with the owner account.  This isn't the account you created earlier for the WebDav settings.  The Owner account is the only account that can generate the API values needed in AmberPOS.  Once logged into that account you will navigate to API Accounts on Bigcommerce and Create an API Account.



When creating the API Account, the name you populate into the 'Name' field is the same value you will populate into the App Name field.


Note: Use the value 'amberpos' as an assumed default value.


 Before saving to create the API Account be sure to enable full permissions to modify/login for all API Permission properties.



When you save to create the API Account a file will be downloaded through the web browser.  Open this file to access the remaining required field values that need to be populated into AmberPOS for API Integration.

Note: In order to access these integration fields again in the future, you will need to 


The values are only separated by the name of the field (no delimiter).  Make sure to copy only the value of each field without the leading space and to paste them into each of the fields in AmberPOS.



Note: For the API Path, append the end of the path by removing 'v3/' and replacing it with 'v2'.


***** If your store is V3 then make sure you put /api/v3 not /api/v3/ as this is provided by BigCommerce.


Note: In order to access these integration fields again in the future, you will need to either access the file that is downloaded, or delete the existing API account and recreate it new in the BigCommerce API Account management.


 6. Integration Properties Attributes


These fields are optional to populate values to, depending on the configurations of stores and preferences by the customer.  See below a summary of each field attribute.


Combine Stores - Used to consolidate inventory levels between your webstore and another store to reflect a total QOH level to be displayed online.  For example, '1,50' would combine the QOH of an item for the webstore location and the retail location to be reflected online.  Without a value being populated into this field, only the Webstore location's QOH will have quantities reflected online, and none from the retail location.

Web Sync(seconds) - The frequency (in seconds) that your store will update information via API to Bigcommerce.  Extending the value to a longer period of time adds an enforced latency to the regularity of data being uploaded.

Auto Transfer StoreID - The store ID of your local store to have automatically transfer inventory to your Webstore in the occurrence of a sale online.  No value in this field will assign that the default webstore location will subtract QOH for transactions.

Inventory Quantity Adjustment - A quantity buffer that will be added on top of the QOH from your local store. (Example: value 10 + QOH 8 = 18 available online)

QOHSyncStartDate - Calculates QOH Web Adjustment value for a particular item.  Any orders prior to the entered date will be ignored for QOH adjustments in AmberPOS.

Show RP Savings - Allows RP price and Sale price to be populated for your products on Bigcommerce.  This essentially shows discounted items with a price adjustment that is notable for the customer's to see online when viewing products.


If they do not exist for some reason, then you can also manually create them.


 7. Test Webstore Integration


Once all the fields have been populated as required for the business you will want to test the connection to see that AmberPOS can talk to the Bigcommerce account.



If either the Webdav or API tests fail then try deleting the currently stored values and try repopulating them before testing again.


After integration is setup properly, you will want to go to do the following:


- Update LC Database

- Adjust Web Sync Configurations



Additional Attributes (Optional):


Inventory Quantity Adjustment - A quantity buffer that will be added on top of the QOH from your local store. This will apply to each individual dimension of the SKU. (Example: value 10 + QOH 8 = 18 available online)


Max Number of objects in HTTP return: Increases the length before time-out for the updating of LC database.  (Default Value is 250 Set to less for less time outs.)


LC general resources update timeout: This value represents the time interval in minutes between LC background updates for general resources only (this value has no effect for items, customers and orders, use 60 as default).


MaxThread#:This attribute allows you to adjust the multi-threading power allocated to the CPU specifically for AmberPOS functions. Increasing the value of the attribute will increase the speed of the AmberPOS functions, but requires more CPU power. It will affect the following functions in AmberPOS:

1. Loading data from Amber/LC to our GUI;

2. Updating data in LC

3. Uploading items from Amber to the Web.


By default, if this attribute is not added, your AmberPOS software will set the value to 25. 

However, with this attribute, you can set the value to any number. WARNING: setting the value too high may slow down your computer significantly if the CPU is not fast enough. 

- 0 will turn off cpu multi-threading completely 

- 25 will use 25% of the cpu multi-threading power (default) *** As of version Default Threading has been set to 5 ***

- 100 is the max value, and will use 100% of the cpu multi-threading power (only recommended for i5, i7 or faster)


For generating any of these attributes you will need to manually create them.




Article is closed for comments.
Powered by Zendesk