A MachShip connection can now be established in Consignly.
Integrating with MachShip enables you to dispatch consignments using either a preferred carrier or automatically select the most cost-effective option. Once a consignment is created, MachShip adds the tracking URL, carrier name, and carrier reference to the record. Labels generated for each package are attached as notes and can be printed directly from the Consignly portal or accessed externally via API.
Getting Started
To establish a connection, Add the App into Consignly.
You will be prompted to provide your MachShip Api Key to create a connection.
Creating a Connection to MachShip from Consignly
Connection
Once the connection is established, you will have the opportunity to go into the Connection Detail to configure your connection to MachShip.
MachShip Connection
The MachShip Connection card contains information about the connection: the Consignly User, the Date Created, and the MachShip Api Key.
MachShip Connection details
Company Settings
The Company Settings card contains the MachShip Company.
Company Settings for a MachShip connection
Configuration
Consignment Settings
Map a Consignly Reference field to 2x MachShip Customer Reference fields.
Define Po Box Keywords in the consignment settings card. These are keywords which, when present in an address, will be recognised as being a PO Box.
Consignment Settings for a MachShip connection
Warehouses
The Warehouse Mapping card defines which Warehouses are enabled for the connection.
To enable a warehouse for the connection, select the checkbox next to the warehouse.
Once selected, map the Consignly Warehouse to its corresponding MachShip Location.
Mapping a Consignly Warehouse to its corresponding MachShip Location
Client Partners
Configure Client Partners enabled for the connection.
Select the Client Partner, the Warehouses, and MachShip Company the partner is enabled for.
A Client Partner configuration for a MachShip connection
Carrier Partners
Configure Carrier Partners enabled for the connection.
Select the Carrier Partner, the Warehouses, and MachShip Company the partner is enabled for.
If the Carrier Partner can deliver to a PO box, you may select that the partner 'Is default for PO box'.
Editing the Carrier Partner configuration for a MachShip connection
Package Types
Define which Package Types are supported for the connection.
May your Consignly Package Type to its corresponding MachShip Item Type.
Package Types configured for a MachShip connection
Unit Types
Define which Unit Types are supported for the connection.
May your Consignly Unit Type to its corresponding MachShip Item Type.
Unit Types configured for a MachShip connection
Actions
Configure an action to trigger an export to MachShip.
There are two types of actions which can be configured. These are the actions that will occur in MachShip on export from Consignly. These actions are:
- Create Consignment.
- Create Pending Consignment.
Edit Action
To enable the action, select the Enable action checkbox.
The Enable Action Checkbox for a MachShip connection
Next, select the Client Partners enabled for the action.
Each selected client partner must have a Consignment Status defined. This is the consignment status that will trigger export to MachShip.
Defining Client Partners and Consignment Statuses for a MachShip export action
Select the Carrier Partners enabled for the action.
This will restrict exports to occur for consignments with the selected carriers.
Alternatively, you may select the 'Consignments without a carrier' checkbox. This will trigger an export to MachShip for consignments without a defined carrier partner.
Defining Carrier Partners for a MachShip export action
Select Save Changes to save the Action configuration.
Exporting to MachShip
Pushing an export to MachShip is dependant on the action configuration.
The export will automatically take place when the consignment is moved to the appropriate status.
Within a consignment, the Connections tab will show all connection apps for that consignment. If a MachShip connection is active, and the consignment fields meet the required configuration, MachShip will appear in the list of connected apps.
A successful export to MachShip will be displayed in this list with an 'Export Success' badge.
A successful export from Consignly to MachShip