> 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/tools-and-productivity/unleashed-integration.md).

# Unleashed Integration

Order Desk can connect to your [**Unleashed**](https://www.unleashedsoftware.com/) 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.

### Setup

To enable the integration, click on **Manage Integrations** in the left sidebar. Under the **Productivity** tab, find and enable the Unleashed integration.

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/685adcdecea5a37c853b2416/file-nmDIOUvOrI.png)

Alternatively, search for **Unleashed** from the available integration search.

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/685add2ba1bc4f411ab3b2d2/file-0oeYTn55Oh.png)

Once enabled, enter your **API ID** and **API Key** on the next page and click **Connect**:

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/685add93cea5a37c853b2419/file-y0Gk4mCRox.png)

**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:

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/690df7631fc20b0e46080a67/file-ktib7ye04x.png)

#### 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**](/start-here/getting-started-series/quick-start-overview.md#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.

#### Default Warehouse

Select the Unleashed warehouse where you want Order Desk to send all orders by default. This can be overridden on an order-by-order basis.

#### Inventory Management Settings

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/690df925a289885bbf49fcc1/file-rXe5GEBDkZ.png)

#### 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**](/guided-walkthroughs/products-and-inventory/how-to-work-with-inventory-quantities.md#send-counts-tofrom-order-desk) guide.

#### Warehouse Filter

Choose the Unleashed warehouse that you want Order Desk to pull stock levels from. Stock from other warehouses will be ignored.

#### 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

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/685ae02b0556c413de30ea85/file-eVlt9cGykg.png)

For information on how to use the product settings in this integration, see the [**Fulfillment Integration Product Settings**](/integration-setup-guides/fulfillment-services/fulfillment-integration-product-settings.md) 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.                                                                                                                      |
| warehouse           | **Optional** Pass the name of the warehouse you want the order to be sent to. By default, we use the [Default Warehouse](#default-warehouse) selected on the integration settings page. |

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.

#### 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**](/guided-walkthroughs/products-and-inventory/how-to-work-with-inventory-details.md#store-extra-item-details-in-order-desk) guide.


---

# 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/tools-and-productivity/unleashed-integration.md?ask=<question>&goal=<endgoal>
```

`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.