Connecting to M2X allows Consignly users to automatically export Inwards and Outwards consignments to M2X.
To establish a connection, add the app into Consignly.
Consignly requires an M2X Client ID and M2X Client Secret in order to connect. You can request a these keys by contacting M2X directly.
After you have authorised with M2X, you will be able to configure your connection.
Enter your M2X Client ID and M2X Client Secret to connect Consignly to M2X
Once the connection is established, you will have the opportunity to go into the Configuration tab to configure your connection.
The M2X integration requires service codes to be defined for both inwards and outwards consignments, so enter these in the Consignment Settings card.
The consignment settings card in the M2X integration configuration
The Export Triggers card allows you to define which statuses cause an automatic export of consignment data from Consignly to M2X.
Checking a box in this card will mean that qualifying consignments will export to when the consignment moves into this status.
There are different trigger options for Inwards vs Outwards consignment.
In this example, Consignly will trigger an export when an Inwards consignment moves into a Ready to Receive status and an Outwards consignment moves into a Ready to Dispatch status
In order to qualify the consignment for export, the carrier on the consignment must match one checked in this configuration list.
Check all the carriers you wish to enable the export for. There is an option for No carrier assigned which will trigger if the carrier on the consignment is not set.
An example of Carrier activation and configuration in Consignly.
What is exported to M2X?
When a consignment is triggered to export to M2X, it will:
- Attempt to find a customer in M2X with the Integration Id that matches the Client Partner's Customer Code from Consignly
- Attempt to match a product in M2X using the Integration Id that matches the Commodity value on the product from Consignly. If Commodity is empty then it will attempt to match on the Product Code from Consignly.
- Attempt to find a customer address in M2X where the Integration Id matches a unique address identifier from Consignly. If an address can't be found, Consignly will create it automatically.
- Attempt to match a depot address in M2X where the Integration Id matches a unique address identifier from Consignly. If an address can't be found, Consignly will create it automatically.
On the Connection tab, webhook information is available. This webhook information can be supplied to M2X directly in order for them to configure sending status updates and POD's to Consignly.
A webhook username will be supplied, and a password can be generated to pass onto M2X.
The endpoint section shows a unique endpoint URL to your M2X integration in Consignly. Provide this information to M2X along with the username and password data (be sure to send this securely) and M2X will send status updates to Consignly as consignments are updated in M2X.
What is received from M2X?
When the webhooks feature is enabled by M2X, Consignly will receive updates on consignments from M2X.
If a consignment is started in M2X, or is completed and accepted, this will trigger status updates automatically on the consignment in Consignly.
When a POD is captured by M2X, this will be passed along to Consignly, and will be surfaced up in the POD tab of any outwards consignments.