Etsy: Migrate to the New Etsy API

Background

Etsy has recently introduced a new API used to connect Etsy to third-party applications such as ShipWorks. ShipWorks users with an active Etsy store need to update their Etsy store connection prior to March 31, 2023 to avoid issues with processing Etsy orders.

If you have not migrated ShipWorks to the new Etsy API by March 31 you may encounter the following error when downloading orders from Etsy.

Unable to connect to Etsy. Please update your Etsy credentials in Manage > Stores.

The ShipWorks download screen is shown, displaying the Etsy download error.

This article will guide you through the process of migrating your Etsy store to the new Etsy API.

First Things First

In order to migrate your Etsy store to the new API:

You will need your Etsy store login credentials
You will need to log in to ShipWorks as a user with administrator rights

The Process

1. Upgrade ShipWorks to the Latest Version

You must be running ShipWorks 9.12.0 or later to migrate your Etsy store connection to the new Etsy API.

See our help article, How Do I Upgrade ShipWorks, for detailed information on how to check your current version of ShipWorks and how to upgrade to the latest version.

2. Update the Etsy Token

After updating ShipWorks to the latest version, the next step is to enter a new Etsy login token in ShipWorks. Here's how:

Click on the Manage tab and then on the Stores button.
Select your Etsy store and click the Edit button.
Select Store Connection.
Click the Create Etsy Token button. A new browser window will open to the Etsy login page.
Log in to your Etsy store using your Etsy store credentials.
Click the Allow Access button. The web browser screen will refresh and display your login token.
Click the Copy Etsy token button to copy the token to the clipboard.
Switch back to ShipWorks and paste the token into the Enter the Etsy Token field. Then, click the OK button.
Click the Close button to exit the Manage Stores screen.

You are now connected to the new Etsy API.

The last step is to check for an action that may cause an error when processing Etsy shipping labels.

3. Check ShipWorks Actions for Your Etsy Store

The new Etsy API no longer supports the Update Store Status action. With this action configured, you will encounter the following error after processing an Etsy shipment:

The action "Update store status" is not supported. Please use "Upload Shipment Details"

Check the Actions Manager to ensure that there is not an Update Store Status action configured for your Etsy store. This action, if configured, will need to be deleted or disabled. Here's how:

Leave the 'Upload Shipment Details' Action

There is an Upload Shipment Details action that was created for you when you added your Etsy store. This action uploads the tracking information to Etsy. Be sure not to delete or disable this action.

Click on the Manage tab and then on the Actions button.
Check the list of actions in the Actions Manager. Look at the Tasks column of the configured actions for a description of Update store status (your Etsy store name).
If there is an Update Store Status action configured for your Etsy store, perform one of the following two options:
- Disable the action: Uncheck the box to the left of the action to disable it.
- Delete the Action: Select the action, click the delete button, and click OK.