How do I connect my WSM site with Shipworks?

What is Shipworks? 

Shipworks is a shipping platform designed to help online retailers streamline their ability to process, fulfill, and ship orders. With Shipworks, you can import orders from Web Shop Manager, create domestic and international shipping labels, and automate customer updates when orders have shipped. 

STEP 1: Enabling the Shipworks API in WSM

  1. Contact WSM to enable the Shipworks API Key.
  2. Create a Shipworks account

STEP 2: Create a user in WSM for Shipworks

  1. Log into your WSM Admin
  2. Use this help page to create a WSM User. It is recommended that your user name is your site tag and Shipworks. Your tag can be found on the Admin Dashboard below the charts. ie TAGshipworks. This user account should only be used for the store connection; users should not use this account to access WSM. 

STEP 3: Connecting Shipworks API Key with User

  1. Contact WSM to connect your new user created in STEP 2 with the API key your requested in STEP 1

STEP 4: Download and connect store with shipworks

To connect your WSM store to Shipworks, do the following: 

  1. Visit and follow the steps
  2. Open shipworks and select "Start from scratch"
  3. Enter your username and password
  4. Select WebShopManager from the select box
  5. Enter username and password you created in STEP 2 above
  6. Enter the Module URL, which is your website with /shipworks at the end
  7. Complete all remaining Store settings required by Shipworks
  8. Use the table below when completing your Store Options setting for Status Types

The table below provides details about the form fields in the connection window: 

URL to custom CML page

The location of your web endpoint. HTTPS is recommended. 

Unpaid Status The name of the system status indicating an order is unpaid and not ready to be shipped. Multiple statuses may be separated by a comma.
Paid Status Name of the system status indicating an order is paid and ready to ship.
Shipped Status Name of the system status indicating an order is shipped.
Canceled Status Name of the system status indicating an order is canceled.
On-Hold Status Name of the system status indicating an order is on hold.

Order Status

  1. The order statuses set up in Shipworks must mirror the order statuses in WSM to flow through.
  2. ShipStation only offers a limited amount of fields to add order statuses, so pick the statuses you use the most.
  3. These are the options in WSM 
    1. new
    2. processing
    3. backorder
    4. complete
    5. held
    6. canceled
    7. fraud
    8. deleted
    9. ready_to_ship
    10. return
    11. shipped
  4. If updating the existing list in Shipworks a recommendation is the following
    Order Status
    Change From/To
    In Process/Processing
    New Order/New
    Not Shipped/Held
    Item Status
    Change From/To
    New Order/New
    Not Shipped/Cancelled
  5. You can use the New button to add any additional status' from the list above

The status fields map WSM's order statuses to Shipworks's Status Types to determine where orders will import into Shipworks. These fields are case-sensitive. 

    STEP 5: Importing Orders

    1. In Shipworks, click the Download icon in the upper right-hand corner
    2. Once Shipworks downloads your orders you can use any of the options available, for which you have an account setup, including creating shipping labels.

    Note: the Item ID that is sent in the API to Shipworks is based on the ID selected in the System>Configuration>Catalog tab

      WSM only updates the order to Shipworks once. If you make any changes to orders in WSM after it is loading Shipworks you will need to manually update the order in Shipworks as well. Once the tracking number is added to the order in Shipworks, Shipworks will send WSM the tracking number.