ShipStation: Integration Settings and Features
IN THIS GUIDE
In August 2017, we released a new ShipStation integration that is more reliable and provides more options than our legacy ShipStation integration did. This guide covers the new integration settings and features.
If you are using the legacy integration, upgrade to the new integration at your earliest convenience following the instructions in this guide. The legacy integration has LEGACY written in the logo.
Setup and Advanced Settings
After creating a manual store in your ShipStation account following the instructions in the ShipStation setup guide, you can adjust the details about how Order Desk handles your ShipStation orders, starting with the Setup and Advanced Settings sections.
After Import, Move To
Choose which folder orders should be moved into after they are sent to ShipStation from Order Desk.
After Shipment, Move To
Choose which folder orders should be moved into as shipments are added to them in ShipStation.
If Canceled, Move To
Choose which folder orders should move into if they are canceled in ShipStation.
Shipment Import Delay
If you prefer to have a delay in how long it takes shipment information from the moment the shipping label is created in ShipStation to it being pulled into Order Desk, select the delay time in this setting.
Having a delay provides time to void a label in ShipStation before Order Desk imports the information and, potentially, sends it back to the cart or the customer.
The Store dropdown displays all the stores in your ShipStation account. Select the manual store you created following the steps in the ShipStation Setup guide.
Do not select a store which connects to another integration or to the store being used with the Legacy ShipStation integration if you still have that enabled on your Order Desk store.
Get Shipment Notifications for All ShipStation Stores
Select this if you send orders to more than one ShipStation store to allow Order Desk to pull in tracking details from each store. Do not select this if you are only sending to a single ShipStation store.
Send Customer Email Address to ShipStation
If you want your customer’s email addresses sent to ShipStation with their orders, keep this box checked. If unchecked, customer email addresses will not be sent to ShipStation.
Automatically Send Imported Orders to ShipStation
If every one of your orders will be sent to ShipStation, enable the Automatically Send Imported Orders to ShipStation setting. Orders will immediately be sent to ShipStation as they come into Order Desk.
If only some orders need to be sent to ShipStation, keep this setting disabled and use the Rule Builder to tell Order Desk which orders are meant for ShipStation.
You can also manually click the submit to ShipStation button to send individual orders to ShipStation:
Or to send groups of orders to ShipStation:
Send Discounts to ShipStation
By default, all discounts will be sent to ShipStation as adjustment line items. If you do not want discounts to be sent to ShipStation, uncheck the Send Discounts to ShipStation option. Discounts must be over $0.01 to be sent.
Check for Fulfillments
Select if you want to check for external fulfillment from ShipStation.
If any of your orders in ShipStation receive shipment information from external services or by any means that is not ShipStation creating a label, keep this setting enabled for Order Desk to pull those shipment details in.
Check for Canceled Orders
If you would like Order Desk to check twice a day for canceled orders, check this option. If any are found, they will be moved into the folder specified in the If Canceled, Move To setting.
Create Ship From Locations Automatically
If you have the setting disabled, the order is sent to ShipStation with no warehouse ID. The default Ship From name is set in ShipStation. You can override this on a case-by-case basis by setting the WarehouseID as a custom order metadata or checkout data field in Order Desk, details here.
Request Insurance and Insurance Type
Check the Request Insurance setting if you want to use insurance.
If selected, choose which option you want from the Insurance Type dropdown. Options are Carrier Insurance and Shipsurance.
Custom Field Names
In ShipStation, you can add custom columns to your orders to display specific information from Order Desk.
To add these columns in ShipStation, click on Orders then Columns and select Custom 1, Custom 2, and/or Custom 3 to have them show up in the order details:
Back in your Order Desk ShipStation integration settings, you can pass information from your orders to ShipStation in the Custom Field Name 1, 2 and 3 fields:
These custom fields are pulled from the checkout data fields or order metadata on your orders in Order Desk, which you can see in the upper right corner of an order page:
In some cases, checkout data and/or order metadata is added to an order automatically from certain shopping carts, but it can also be added with a rule or added manually by an Order Desk store user.
Use the checkout data field names that you want to pass through to ShipStation, such as "gift_from_buyer", "Vendor", "Source", or whichever custom field name you may have on your orders.
When Custom 1, 2 and/or 3 are enabled in ShipStation, these fields will show up on your orders there:
If ShipStation has given you a partner key, add it here.
Custom Order and Item Details
Custom Order Details
Order Desk can send certain custom values to ShipStation.
Set these field names as either checkout data or order metadata with your chosen values if you want to send them to ShipStation with your orders:
|HoldUntilDate||the date or string (like +3days) until which the order should be held (if setting a date, use UTC timezone)|
|InsuranceProvider||carrier or shipsurance; integration default will be used if nothing is entered|
|Insurance||set to 1 if insurance should be requested|
|InsuranceValues||if a different value than the total of all the order items|
|InternalNotes||If you'd like to set the internal notes, you can use this field. If this is not set and you have order notes on the order, we'll set those.|
|OrderStatus||use awaiting_shipment, awaiting_payment or on_hold; awaiting_shipment is default|
|CarrierCode||if you'd like to hardcode a requested carrier ( available fields - download link). If you enter a carrier, you must also specify a service code|
|ServiceCode||if you'd like to hardcode a requested service code ( available fields - download link)|
|PackageCode||if you'd like to hardcode a requested package code|
|BillToParty||Identifies which party to bill. Possible values: "my_account", **"my_other_account", "recipient", "third_party". If not entered, we will not pass this field. If you enter BillToMyOtherAccount, we will automatically fill this out properly. If you enter a BillToAccount value, we will also fill this out properly.|
|BillToAccount or ShippingAccount||Account number of billToParty. If not entered, we will not pass this field.|
|BillToPostalCode||Postal Code of billToParty. If not entered, we will not pass this field. May be required if you are using third-party UPS.|
|BillToCountryCode||Country Code of billToParty. If not entered, we will not pass this field.|
|BillToMyOtherAccount||When using my_other_account billToParty value, the shippingProviderId value associated with the desired account. If not entered, we will not pass this field. If entered, we will set BillToParty appropriately.|
|NonMachinable||Enter 1 to indicate that the order is non-machinable|
|SaturdayDelivery||Enter 1 if you'd like to enable Saturday Delivery|
|Contains Alcohol||Enter 1 if you'd like to indicate that the order contains alcohol|
||Hardcode a specific store ID for this order so it will go to this store in ShipStation.|
|WarehouseID||Hardcode the Ship From location for this order.|
|PackageWeight||Set the package weight on the order.|
|PackageHeight||Set the package height on the order.|
|PackageWidth||Set the package width on the order.|
|PackageLength||Set the package length on the order.|
|CustomsContents||Set to merchandise by default. Other available options are documents, gift, returned_goods, or sample.|
|CustomsNonDelivery||By default, items that can’t be delivered will be returned to sender. Use this field to override with the value treat_as_abandoned.|
|TagID||Set a ShipStation tag ID to have the order tagged in ShipStation when submitted. This must be the ID and not the tag name. Currently the only way to find your ShipStation tag IDs within Order Desk is to enable the ShipStation Order Import integration and look at the Limit By Tag dropdown.|
|TagIDs||Set multiple ShipStation tag IDs, separated by commas, to have the order tagged in ShipStation when submitted.|
For help with the Bill To Details, please see the ShipStation API documentation at this link.
Custom Item Details
Order Desk can send certain custom values for order items to ShipStation.
Set these variations or item metadata fields on products if you want these sent to ShipStation with your orders:
|image||the url for the product image|
|WarehouseLocation||the warehouse location field|
|Adjustment||whether this is an adjustment product with no fulfillment needed: 1 or 0|
|FulfillmentSKU||the fulfillment SKU associated with this order item if the fulfillment provider requires an identifier other then the SKU|
|UPC||the UPC code|
|hts_code||Enter the HTS code for your order.|
|country_of_origin||Enter the country your order is originating from.|
Product Code Match and Skip
Product Code Match
The Product Code Match feature allows you to tell Order Desk when certain product SKUs need to be changed before orders are sent for fulfillment. Add one match per line with bundles separated by commas. For more information on how to set this up, see this guide.
Product Code Skip
To prevent certain products from being sent to ShipStation, add their SKUs to the Product Code Skip field, one SKU per line. For more information, please see this guide.
Gift Message Field
To send gift messages through to ShipStation, add the checkout data field name for your gift messages in the Gift Message Field box.
Picklist Message Field
To add a note on the picklist, fill in the checkout data field on your orders that you want sent to ShipStation in the Picklist Message Field. This will be added to the Customer Note field in ShipStation.
Inventory Location Match
The Inventory Location Match field lets you match the inventory location set on your inventory items. Only items with the same inventory location name that is set in this field will be submitted to ShipStation.
Shipment Check Tool
Shipments should come back into Order Desk automatically as orders are updated with tracking details in ShipStation. However, you may find on occasion that some orders fail to pull in their shipments. If this happens, you have two quick options to find the shipment.
First, you can click on the Check ShipStation For Shipment button in a single order to find the shipment.
Alternatively, if you have a larger number of orders that are missing their shipments, scroll down to the bottom of the ShipStation integration settings page and look at the Shipment Check Tool.
Select the folder your orders are in and click on the Check All Orders For Shipments button to search the entire folder for shipments.
Setting Customs Information for ShipStation
In ShipStation, Customs Declarations needs to be changed to Leave blank (enter manually).