Table of Contents
BigCommerce has recently introduced a new API, referred to as the OAuth API, used to connect BigCommerce to third party applications such as ShipWorks. BigCommerce recommends that all stores convert to using the OAuth API for connecting to ShipWorks.
This article will guide you through how to obtain your BigCommerce OAuth API credentials and how to convert your current ShipWorks connection to the new OAuth API. If you are adding BigCommerce to ShipWorks for the first time, please refer to this article instead.
First Things First
In order to convert your BigCommerce connection to the OAuth API:
- Please ensure that you have ShipWorks version 5.13 (or later) installed and that you have logged into ShipWorks as a user with administrator rights. You can check your version of ShipWorks by clicking on the Help tab and then on the About ShipWorks button. For assistance upgrading, click here.
- You will need to obtain your BigCommerce API Path, Client ID, and Access Token. (instructions below). Please have your BigCommerce admin panel username and password available.
Creating the BigCommerce Auth Token
To create your OAuth API Token and to obtain your API Path, Client ID, and Access Token, please see the Creating the BigCommerce Auth Token section of this article. Then, return to this article and continue with the following steps.
Updating ShipWorks to the OAuth API
1. In ShipWorks, click on the Manage tab and then on the Stores button.
2. Select your BigCommerce store and then click on the Edit button.
3. Select the Store Connection link on the left side of the Store Settings screen.
4. Click on the Connect using OAuth button.
5. Verify that the API Path, Client ID, and Access Token you obtained from the above steps are entered correctly. Then, click the OK button.
6. Click the Close button. You are now connected to BigCommerce using the OAuth API.