Unleashed Integration
Order Desk can connect to your Unleashed account and send order and shipment information there. Shipment details can also be retrieved into Order Desk from Unleashed and sent back to your cart(s), if your store is set up for it.
This guide explains how to set up the integration, as well as what custom fields can be used when sending orders and order items to Unleashed.
IN THIS GUIDE
Setup
To enable the integration, click on Manage Integrations in the left sidebar. Under the Productivity tab, find and enable the Unleashed integration.
Alternatively, search for Unleashed from the available integration search.
Once enabled, enter your API ID and API Key on the next page and click Connect:
NOTE
Order Desk isn't able to help find or reset your credentials, as they can only be provided by Unleashed.
Integration Settings
After you’ve connected Unleashed to Order Desk, you can customize how orders move through your store using the following settings:
After Import, Move To
Select the folder where orders should be moved after they’ve been sent to Unleashed.
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.
After Shipment, Move To
Select the folder where orders should be moved after a shipment is added to the order by Unleashed.
If Canceled, Move To
Select the folder where orders should be moved if they're canceled in Unleashed.
Sync Tracking Numbers
Choose how tracking numbers should sync between Order Desk and Unleashed. There are three options:
- To Unleashed – Select this if you’re sending completed orders to Unleashed from Order Desk. We’ll include tracking details (if present) when submitting the order.
- From Unleashed – Choose this if you want Order Desk to pull shipment updates from Unleashed. In this case, Order Desk won’t send shipment info when submitting orders. Instead, we’ll wait for shipment updates to come from Unleashed.
- Disabled – Use this if you don’t need to send or receive any shipment data.
Inventory Management Settings
Sync Inventory
Enable if you want us to regularly download your stock counts from Unleashed into Order Desk.
For more information, see the How to Work with Inventory Counts guide.
Sync Update Interval
If Sync Inventory is enabled, you can use this to choose how often you want Order Desk to check Unleashed for inventory updates.
Product Settings
For information on how to use the product settings in this integration, see the Fulfillment Integration Product Settings guide.
Custom Order and Item Details
You can add extra details to your orders or order items to control what gets sent to Unleashed.
Order Level Details
The following fields can be added as checkout data or order metadata to be passed through to Unleashed on an order-by-order basis:
| Field Name | Field Description |
|---|---|
| guid | Optional We'll automatically generate this, but you can override it with a custom value of your own. |
| currency | Optional Currency code to use for the order. |
| customer_guid | Optional Customer GUID for the order. Alternatively, you can use the customer_code field. |
| customer_code | Optional Customer Code for the order. Alternatively, you can use the customer_guid field. |
| DeliveryInstruction | Optional Add delivery instructions to the order. |
| ExchangeRate | Optional Include if needed for foreign currencies. |
| OrderStatus | Optional Set the order status. We send orders as Completed by default. You can use this field to override that behavior. |
| TaxCode | Optional Set the tax code for the order here. You can pass a TaxRate field as an alternative. |
| TaxRate | Optional Set the tax rate for the order here. This can be used in place of a TaxCode field. |
| RequiredDate | Optional Pass the required date for the order here, if needed. |
If you are unfamiliar with checkout data, see the How to Work with Checkout Data guide.
Item Level Details
The following can be set as item metadata or variations on the items in your orders.
| Field Name | Field Description |
|---|---|
| LineType | Optional Defaults to Null unless specified. |
| LineTax | Optional Tax amount for the line item. Defaults to 0.00 if not set. |
| DiscountRate | Required Discount rate for the item. If absent, a value of 0 will be passed to Unleashed instead. |
If you are unfamiliar with how to add item metadata or variations to your items in Order Desk, see the How to Work with Inventory Details guide.