IN THIS GUIDE
ShipWorks is a program with advanced label printing and shipping capabilities that can be used by merchants with a Windows-based PC. With Order Desk, you can send your orders into ShipWorks.
This guide explains how to connect to the ShipWorks integration and begin using the integration.
To connect to ShipWorks click on the Manage Integrations link in the left sidebar. Under the Shipping tab, find and enable the ShipWorks integration.
Alternatively, search for ShipWorks from the available integration search.
As soon as you enable the ShipWorks integration, Order Desk will create a Username, Password, Module URL and a Test URL.
You will need to take some of this information into ShipWorks to complete the connection. This will be covered after your store information is filled out.
At the bottom of the integration settings, add your store's address information. These details will be passed to ShipWorks to initialize your store setup, and can be updated later.
If you haven't already, download ShipWorks to complete the connection.
In the ShipWorks program, follow these steps and select your preferences as ShipWorks guides you through their setup:
- Open ShipWorks and click the Manage Tab.
- Click the Stores icon.
- Click Add Store and select Order Desk.
- Enter the login information and Module URL from Order Desk.
- On the next screen, confirm the store information you added to Order Desk. If you need to, you can update that here.
- Select how far back to go for your first order download.
- Configure the two-way communication. These settings should not need to be changed.
- Set up your email service and automatic downloading frequency.
- Click Finish on the setup wizard.
Once you have completed these steps, you will need to initiate your first sync. To do this, click the Home tab in the button bar at the top of the ShipWorks window. Click the Download button. Your orders will now download.
Enable this setting to have your Order Desk folder structure be mirrored in ShipWorks. This will allow the folder/status to sync between programs.
Keep disabled if you do not want to sync order folder status from ShipWorks back to Order Desk.
For more information on folder structure in Order Desk, see the Working with Folders guide.
Order Shipment Syncing
Enable this setting to have the order shipments sync between ShipWorks and Order Desk.
By default, the email address is used to identify customers. To use the customer ID instead, select External ID instead of Email.
Keeping this set to Email is recommended unless your store requires the customer to login, and they change their email often.
Send Checkout Data
Enable to send the checkout data fields on your orders to ShipWorks.
If you are unfamiliar with checkout data, see the How to Work with Checkout Data guide.
Import Date Override
You can edit order details in Order Desk, and those details will be sent into ShipWorks to update the order record there as well.
Because ShipWorks pulls orders from Order Desk at specific intervals, by default, it will pull in all orders that have been modified since the last time it checked.
If you need to re-import a batch of orders but can’t modify them all at once, set the Import Date Override to an earlier time for ShipWorks to go back to and pull those orders. Once the orders have been pulled into ShipWorks, this date override will be removed from your settings.
Do Not Send $0 Orders to ShipWorks
Select this setting if you do not want to include $0 orders to ShipWorks.
As an example, if you use Foxy and do not want subscription updates sent to ShipWorks, check this setting.
ShipWorks accepts some custom fields on items. The following details can be added as item metadata:
|Field Name||Field Description|
| custom1 - custom5
||Set custom1 through custom5 as item metadata to pass through custom information in the value field(s).|
|mpn||Set the mpn for the item.|
|brand||Set the brand for the item.|
|length||Set the dimensions for the item for box size. Must be an integer.|
|width||Set the dimensions for the item for box size. Must be an integer.|
|height||Set the dimensions for the item for box size. Must be an integer.|