Self-Managed Unleashed Integration

Table of Contents

• Overview
• Prerequisites
• Limitations
• Cost
• How to create a Self-Managed Unleashed Integration
• Disconnecting an existing Self-Managed Unleashed Integration
• Editing an existing Self-Managed Unleased Integration
• Managing Self-Managed Integrations

Overview

Self-Managed Integrations allow you to create integrations from within your CartonCloud account.

To use the Self-Managed Unleashed Integration, a Sales Order in Placed status and Sales Shipment must exist in Unleashed. CartonCloud will create the corresponding Sales Order and, once dispatched, mark the Sales Shipment as fulfilled with carrier tracking numbers (if configured).

You can configure the integration yourself or you can have your customer set the integration up from their CartonCloud login. See How to enable Customers to create their own Self-Managed Integrations. 

Prerequisites

• This is a paid integration, please ensure you read the included costs below. 

• Your customer must have an Unleashed account.

• You will need your customer’s Unleashed API ID and Private Key. Alternatively, you can enable the permission for your Customer to create their own Unleashed Integration. See here for more information.  

• The product code in Unleashed must match the product codes in CartonCloud.

• The Customer in CartonCloud must have access to the Warehouse the orders are being mapped to from Unleashed.

• If you are a Customer user, you must ensure your CartonCloud account owner has given you permission in your account to create your own Self-Managed Integrations. Please reach out to your account owner for this access. 

Limitations 

• Changes to Unleashed orders (e.g. item quantity changes) will not be made in CartonCloud. Once CartonCloud has the order from Unleashed, the order will not be updated if the order is changed within Unleashed. 

• Orders created via the Unleashed integration cannot be split.

• Fulfilments requires Warehouse Fulfilments to be enabled in CartonCloud. 

• Deleting a Sales Order or Sales Shipment in Unleashed does not notify CartonCloud.

• Dates and datetimes are not converted between time zones.

• Mapping of requested batch numbers is not supported.

• Customer Reference mapping is currently unavailable.

• Pickup orders are not currently supported. If this is important to your workflow, please reach out to the Service Desk team to discuss a possible workaround. 

Cost 

We offer volume-based discounts—reach out to our support team here to discuss pricing options.

How to create a Self-Managed Unleashed Integration 

• Navigate to the Integrations page by typing in Integrations in the Search for Anything bar or More>Self-Managed Integrations.

• If an Admin user, select the customer you wish to create the integration for.

• Select Unleashed from the Self-Managed Integrations menu selection. 

• Click Configure.

• The configuration box will now appear, follow the below steps to configure the integration.
  
  

(1) Initial Configuration

• Fill in the Name field

• Click Next.
  

(2) Authentication

• You will now need to connect CartonCloud to the correct Unleashed account.

• Enter the Unleashed API ID and API Key. You can find these in Unleashed under Integration → Unleashed API Access.

•  Click Next.
  

(3) Order Creation

• Here you will need to set up configurations to enable order creation from Unleashed to CartonCloud.

  • Include Comments: with this enabled. Comments from Unleashed Sales Order and Shipment will be passed through to CartonCloud Packing instructions.

• The CartonCloud Customer Reference field is automatically populated using Unleashed’s Order Number and Shipment Number, in the following format: {order number} | {shipment number}. 

• You will now need to map which Unleashed orders will go to which CartonCloud warehouse. The below describes the different options you have to map the Unleashed orders to CartonCloud:

  • Default Warehouse: Select a CartonCloud warehouse to use for Unleashed Sales Shipment that doesn't have a matching Warehouse mapping

    If you choose to set a default warehouse all orders will go to this warehouse unless you add Warehouse Mappings. You can also choose to ignore the default warehouse and only apply the warehouse mappings. This means only orders with specific references specified in the warehouse  mapping will come across to CartonCloud.

• Warehouse Mappings: For each Unleashed Sales Shipments, select which CartonCloud warehouse matching Sales Shipments should be created in, or leave blank to use the selected Default Warehouse. 

 

• Sample Sales Shipment: Use the Sample Sales Shipment selection to choose a recent Unleashed sales shipment. The fields from that shipment, including the sample value, are then available to map on the next page. Leave the value as None if you do not wish to map specific field overrides and just want to use the default integration mappings.
  
  On the same page, Related Source Objects lets you include extra Unleashed data in those mappings. Tick Customer to include fields from the Unleashed Customer linked to the sample shipment. Leave it unticked if you only need fields from the sales shipment itself.

  

•  Click Next.
  

(3) Field Overrides (Optional) 

• This page is optional. Click Next to continue with the default mapping only.

 

• The page has two tabs.

  • Order - Add mappings that set values on the CartonCloud Sale Order. If there is an API Sale/Outbound Order field you wish to override that is not listed, please let our support team know so we can consider adding it.

  • Items - Add mappings that set field values on each item of the Outbound Order.

• Source fields marked with * use the value from that line. Other source fields use the order-level value on every line. Customer fields are order-level, so they repeat on every line when used on the Items tab.

• For each mapping, choose an Override type:

  • Map from source field: copy an Unleashed field into the CartonCloud field.
  • Fixed value: send the same fixed value on every order.
  • Advanced source mapping: optionally extract part of the Unleashed value, and optionally replace specific Unleashed values with different CartonCloud values.

 

• If Unleashed stops sending a mapped field, or the field is moved, that mapping will no longer apply.

• Click Next.

(4) Fulfillment

• When enabled, Unleashed Sales Shipments will be marked as complete when the Sale Order is dispatched in CartonCloud.  If fulfilment information is updated after the order is dispatched, CartonCloud will update the Unleashed tracking details. 

•  Click Finish.

Disconnecting an existing Self-Managed Unleashed Integration 

If you need to cancel and disconnect the integration you will need to:

• Navigate to the Integrations page.

• Select the relevant Customer. 

• Click Unleashed.

• Select the three-dot configuration icon and select Delete Integration.

• This will remove the integration and stop the billing of the integration to your account. 

Editing an existing Self-Managed Unleashed Integration 

To edit an existing Self-Managed Unleashed Integration:

• Navigate to the Integrations page.

• Select the relevant Customer.

• Click Unleashed.

• Select Reconfigure.

Managing Self-Managed Integrations

Because Self-Managed Integrations are a paid feature, it is important you are able to manage and keep track of the number of active integrations your customers have. This is useful if you wish to pass on the cost to your customer and reconcile your invoices. 

If a Customer has a live integration they will have a green dot icon against their name. It will also display the number of active integrations for that customer below their name.