💡 If you're already using the old Unleashed integration, you’ll need to disconnect and reconnect to switch to the new version. All existing product and customer properties are fully backwards compatible and will continue working.
Table of Contents
Step 1: Get your Unleashed API credentials
Log in to your Unleashed account.
Navigate to Settings → Unleashed API Access.
If necessary, click Generate API Key.
Copy the displayed API ID and API Key.
Step 2: Connect Unleashed to Ordermentum
In the Ordermentum app, head to Settings → Integrations → Unleashed.
Paste the previously copied API ID and API Key into the provided fields.
Click Connect.
Once connected, your customers and orders will begin syncing from Ordermentum to Unleashed.
Step 3: Set up properties in Ordermentum
To successfully sync orders, you must set up a few properties in Ordermentum. These are used to link products, customers, warehouses, freight, and more between the two systems.
Unleashed Warehouse
Property Tag:
unleashed_warehouseType: Dropdown
Required: Yes
Attached To: Orders, Customers
Description: Specifies which Unleashed warehouse to use.
Unleashed Customer Code
Property Tag:
unleashed_customer_codeType: Text
Required: Yes
Attached To: Orders, Customers, Invoices
Description: Must match the customer code in Unleashed.
Unleashed Freight Product Id
Property Tag:
unleashed_freight_product_idType: Text
Required: No
Attached To: Customers, Orders, Invoices
Description: Used if you charge freight. Should match the freight product code in Unleashed.
Unleashed Sales Group
Property Tag:
unleashed_order_sales_groupType: Dropdown
Required: No
Attached To: Orders, Customers
Description: Optional sales grouping from Unleashed.
Unleashed Sales Person
Property Tag:
unleashed_sales_personType: Dropdown
Required: No
Attached To: Orders, Customers, Invoices
Description: Must match the salesperson’s email address in Unleashed.
Unleashed Delivery Method
Property Tag:
unleashed_delivery_methodType: Dropdown
Required: No
Attached To: Orders, Customers
Description: Optional. Matches delivery method in Unleashed.
These properties are fully backwards compatible and will work whether you're using the new or old version of the integration. and will work whether you're using the new or old version of the integration.
Step 4: Configure integration settings
Open the Settings tab of the Unleashed integration to configure optional defaults and sync behaviour.
Screenshot: Settings tab of the Unleashed integration
Freight Product Code
Used if a customer does not have the unleashed_freight_product_id property.
If the specified product code doesn’t exist in Unleashed, Ordermentum will create a product with that code.
If nothing is configured, the fallback product code OM_FREIGHT will be used.
Default Warehouse
Used if a customer does not have the unleashed_warehouse property.
Orders will be synced to this warehouse unless otherwise specified.
Sync Order Number to Unleashed
When enabled, the Sales Order Number in Unleashed will match the Ordermentum order number.
If disabled, Unleashed will generate its own order numbers.
Sync Order Date
When enabled, the Unleashed Order Date will match the Required Date from Ordermentum.
If the Required Date is "TBA," the order creation date will be used instead.
This setting is optional and not needed by most users.
Sales Order Status
Set the initial status for new orders in Unleashed. Available options:
Placed
Parked
Completed
Backordered
Choose the status that best fits your workflow.
Frequently Asked Questions
What does the integration sync — and what doesn’t it sync?
Syncs:
| Does Not Sync:
|
Will Ordermentum Overwrite Changes Made in Unleashed?
No. Once a sales order has been manually updated in Unleashed (for example, a change to its status), Ordermentum stops syncing changes to that order. Instead, an error will appear in the integration logs stating:
"Existing Order not in valid Status for Modification"
This prevents Ordermentum from overwriting any manual updates made in Unleashed.
How Does Ordermentum Handle Changes to Existing Orders?
When an order is updated in Ordermentum and resynced to Unleashed, the process is as follows:
The original sales order in Unleashed is removed.
A new sales order is created to ensure consistent information across both systems.
Handling Deleted Orders:
If the OM_DELETE warehouse exists in Unleashed, the original order is moved there before being recreated. The customer reference in Unleashed will include “DELETED” to indicate the change.
If the OM_DELETE warehouse does not exist, the order status will be set to DELETED and “DELETED” will be appended to the customer reference.
How Does Customer Matching Work?
Customers in Ordermentum are matched with Unleashed using the unleashed_customer_code property. Previously, this mapping was cached without visibility, which could lead to potential sync issues if the code was incorrect. Now, the cached customer mapping is visible in the Customer Fields tab of the integration screen, allowing you to review and correct any mismatches as needed.
What Email Address Does Ordermentum Use When Creating Customers in Unleashed?
In the new integration, Ordermentum uses the billing email address from the customer’s billing contact. This email is visible and editable by the supplier in Ordermentum.
Important: If the billing email is not set, the customer creation process in Unleashed may fail. We recommend ensuring that all customers have a valid billing email configured.
Additional Help:
If you have further questions that are not covered in this FAQ, please don’t hesitate to contact our support team.