Shippo Integration
Shippo allows you to compare couriers and find the best shipping rates. You can use the integration to request rates, then create and print labels directly from your orders in Order Desk. You can also import orders from your carts and send them to Shippo for fulfillment. As orders are fulfilled, tracking details will automatically flow back to Order Desk and update your carts.
IN THIS GUIDE
Setup
To connect to Shippo, click on the Manage Integrations link in the left sidebar and under the Shipping tab find and enable the Shippo integration:
Alternatively, search for Shippo from the available integration search and click Enable:
Once enabled, select your provider from the dropdown, enter your Shippo API key, then click Connect:
Please note that Order Desk isn’t able to help find or reset your credentials, as they can only be provided by Shippo.
Settings
After you have connected the integration, you can apply any necessary details or preferences to the settings.
After Import, Move To
Select the folder you want orders to be moved into after they are successfully sent to Shippo.
You can use one of the default folders already in your store or create your own. Read the Working with Folders guide for more information.
TIP
If an order is sent to Shippo, we’ll check for shipments individually for that order every 3 hours.
After Shipment, Move To
Select the folder orders should be moved to when Shippo sends tracking details back to Order Desk about them.
Default Unit
Choose the unit of measurement for package dimensions and weights (options are LBS/IN or KG/CM)
Default Dimensions
Select the default dimensions for your packaging.
Label Type
Choose the label format that should be used by default. Options include PNG, PDF, and ZPL, depending on your preferred label dimensions and printer type.
Print Preference
Choose whether you want labels to Print Immediately or Not Print Automatically. This is helpful if you want to create labels but delay printing them.
Default Shipper Information
Set your default return address in the Default Shipper Information section. This address will be used for all orders.
Customs Details
Use this section to fill out the necessary Customs Details for international packages. This includes:
Customs Signer
The name of someone from your store who is responsible for the accuracy of the information on the customs form. Set the name of the person in your organization who is responsible for this.
Customs Contents
The Customs Contents of the package to declare the type of product(s) being shipped overseas. Examples include Merchandise, Documents, Gift, Returned Goods and Sample.
Non Delivery Option
This determines what action is taken if the package is undeliverable. You can choose whether to Return or Abandon.
Product Settings
For more information on what these product settings in the Shippo integration are for and how to use them, read the Fulfillment Integration Product Settings guide.
Shippo Label Creator
When the Shippo integration is enabled, a label creator will display beneath the product details on every order.
You can use this section to further adjust your package dimensions, fetch rates, and then purchase your intended labels:
TIP
The Is Residential checkbox refers to the shipping address. Enabling this tells Shippo the order is being shipped to a residential address.
Voiding a Label
Deleting a shipment from Order Desk will not automatically void a Shippo label that has already been created.
If you need to void a label, click on the Tracking Number in the order to pull up the shipment details. Then click on the void button in the shipment details:
Validating Addresses with Shippo
When Shippo is enabled on a store, the shipping address section on every order will have a validation option:
Click the gray Not Validated by Shippo badge and Order Desk will have Shippo check the address and provide information if it isn't valid or if it is missing an important detail.
The badge will display one of three statuses:
- Not Validated by Shippo
- Validated by Shippo
- Validation Failed by Shippo
Order Level Details
If you're sending orders to Shippo for fulfillment, the following fields can be added as checkout data or order metadata to be passed through to Shippo on an order by order basis.
If you are unfamiliar with checkout data, see the How to Work with Checkout Data guide.
| Field Name | Field Description |
|---|---|
| order_status | If unset, Order Desk will send a default value of PAID. Valid values for this field include: UNKNOWN , AWAITPAY , PAID , REFUNDED , CANCELLED, PARTIALLY_FULFILLED, and SHIPPED. |
| currency | If unset, the default currency used is USD . You can set a different currency if needed. This tells Shippo the currency code for the prices on the order. |
Shippo Rules Reference
In addition to the general set of rule events and actions in Order Desk, Shippo includes a number of rule events and actions that are specific to the integration. These aren’t found directly on the integration page. Instead, you’ll need to use the Rule Builder to access them.
If you're new to using rules in Order Desk, we recommend starting with our How to Work With Rules guide.
Rule Events
To find Shippo-specific events, type shippo into the Event dropdown menu in the Rule Builder.
| Event | Description |
|---|---|
| Shippo Label Created | Triggered when a shipping label is successfully created from Shippo. |
| Order Scheduled to Shippo | Triggered immediately after an order is scheduled to be sent to Shippo. |
| Before Order Submitted to Shippo | Triggered just before an order is sent to Shippo. Useful for making last-minute updates. |
| After Order Submitted to Shippo | Triggered after an order has been successfully submitted to Shippo. |
| Order Not Submitted to Shippo Because of General Error | Triggered when a general error prevents the order from being submitted. |
| Order Not Submitted to Shippo Because of Invalid SKU | Triggered when one or more SKUs are not valid in Shippo. |
| Order Not Submitted to Shippo Because No Products Available | Triggered when no valid products were found on the order. |
Rule Actions
Shippo also supports specific rule actions that you can apply to your orders. These can be found in the Actions dropdown by searching for shippo:
| Action | Description |
|---|---|
| Create Shippo Label | Attempts to automatically purchase a label from Shippo. |
| Submit Order to Shippo | Sends an order from Order Desk to Shippo. |