Table of Contents
ShipWorks connects directly to your BigCommerce account. With one click, or on an automated schedule, your orders are downloaded from BigCommerce. As soon as you process a shipment, ShipWorks communicates the updated order status, shipping method and tracking information back to BigCommerce.
This article will guide you through how to connect to your BigCommerce store using the BigCommerce OAuth API. If you need information on how to connect BigCommerce using the legacy API, please see this article.
First Things First
Prior to connecting ShipWorks to your BigCommerce store, there are a few things you will need to have in place:
- 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 are below). Please have your BigCommerce admin panel username and password available.
Creating the BigCommerce Auth Token
1. Log into your BigCommerce administrator panel.
2. Click on the Advanced Settings link on the left side of the screen.
3. Click on the API Accounts link.
4. Click on the Create API Account button.
5. On the Create API Account screen, give the connection a descriptive name.
6. Make note of the API Path. You will need this path when adding BigCommerce to the ShipWorks software.
7. Set all of the OAuth Scopes to match the below screen-shot.
8. Click Save.
9. The BigCommerce API Credentials screen is displayed. Please note: This is the only time that this information is displayed.
Copy, write down, or take a screenshot of the information on this screen and save it to a secure location. You will need it to when adding BigCommerce to ShipWorks. Click Done once you have securely saved this information.
Adding BigCommerce to ShipWorks
1. In ShipWorks, click on the Manage tab and then on the Stores button.
2. Click the Add Store button on the Manage Stores screen.
3. Select BigCommerce from the What platform do you sell on? drop-down menu.
4. Enter the API Path, Client ID, and Access Token you obtained from the previous steps. Then, click Next.
5. On the BigCommerce Store Settings screen:
- Weights are entered into BigCommerce as: - Select the unit of weight measure that you use in BigCommerce for your products.
- Note: If you are unsure, please go back to your BigCommerce store and double-check. Selecting the wrong option may cause adverse effects in ShipWorks with how weights are displayed.
- Check for modified or shipped orders: - It is recommended to leave the default settings.
6. Enter the Store Name and Address information on the Store Information screen and click Next.
7. Enter the additional Contact Information and click Next. Note that this information is optional.
8. Select how much order history you would like to download into ShipWorks during your initial download. The default is to download 30 Days of order history into ShipWorks. You can modify this by clicking on the Edit link.
9. Select the order status to which you would like ShipWorks to update the order after an order is processed from the Set the online order status to drop-down menu. Then, click Next.
10. Click Finish then click Close. Your orders will begin to download automatically.