> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/integration-setup-guides/shipping-services/shipworks-integration.md). # ShipWorks Integration [ShipWorks](https://www.shipworks.com/) 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. ### Setup To connect to ShipWorks click on the **Manage Integrations** link in the left sidebar. Under the **Shipping** tab, find and enable the ShipWorks integration. ![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FfF5c0LOAqUWFnpYu99mA%2Flegacy-54690d5bb2b140beaa9f.png?alt=media) Alternatively, search for ShipWorks from the available integration search. ![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FvAvx906cCotSgdtT5oc5%2Flegacy-418f519af83cc029673b.png?alt=media) #### Connection Information #### Order Desk 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. ![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FWMlqbeVg4dSA1lG4nPjl%2Flegacy-2a4bfe93e30844ae0c18.png?alt=media) #### ShipWorks If you haven’t already, [download ShipWorks](https://registration.shipworks.com/WebRegistration/#!\&p=create-account) to complete the connection. In the ShipWorks program, follow these steps and select your preferences as ShipWorks guides you through their setup: 1. Open ShipWorks and click the **Manage Tab**. 2. Click the **Stores** icon. 3. Click **Add Store** and select Order Desk. 4. Enter the login information and Module URL from Order Desk. 5. On the next screen, confirm the store information you added to Order Desk. If you need to, you can update that here. 6. Select how far back to go for your first order download. 7. Configure the two-way communication. These settings should not need to be changed. 8. Set up your email service and automatic downloading frequency. 9. 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. ### Integration Settings ![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FF4p9HrLaOfEbuIpDhlPj%2Flegacy-7622ba1d89e0d00dc5a0.png?alt=media) #### Folder/Status Syncing 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](/start-here/getting-started-series/quick-start-overview.md#working-with-folders) guide. #### Order Shipment Syncing Enable this setting to have the order shipments sync between ShipWorks and Order Desk. #### Customer Identification 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](/guided-walkthroughs/orders-and-folders/how-to-work-with-checkout-data.md) guide. #### Order Number Format Use to select the order number format for your orders. #### Order Field Filter Use this field to filter which Orders are sent from Order Desk to ShipWorks. #### 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. #### Custom Order Nodes ![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FMCqk7mU0hz3LfEhoFe9T%2Flegacy-7d760815c9daf2b3e0b2.png?alt=media) Allows you to create a node that lets you map custom XML nodes to be sent to ShipWorks. #### Store Information ![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/5ced29550428632d9eebff23/file-gznZtLMo0d.png) 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. ### Custom Details 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. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.orderdesk.com/integration-setup-guides/shipping-services/shipworks-integration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.