FAQ

iCOS Live

How do Consignly and iCOS Live Integrate?


In Consignly, there’s a concept of Clients (that your holding goods for), Carriers (that you’re using to transport the goods to your client’s customer), and Consignees (the people you’re delivering your client’s goods to). The iCOS integration for Consignly works by monitoring carriers and clients that you’ve configured for integration to iCOS. When an outbound consignment has a carrier and client combination that matches what you’ve configured in the iCOS integration setup, then when the consignment moves into a ‘ready for dispatch’ status in Consignly, it will automatically push that information through to your iCOS account. A couple of notes with the integration:

  • The integration is triggered by moving the outwards consignment to a ‘ready to dispatch’ status. If a carrier isn’t assigned when it moves into that status, then the integration won’t trigger.
  • iCOS only supports creates, not updates.This means if you change the consignment details after the integration has triggered, those updates won’t flow through to iCOS
  • Upon moving to ‘ready to dispatch’ the integration process is triggered immediately from Consignly’s end, however it can take a few minutes for the messaging to move through the system and get processed by iCOS – so it won’t appear instantaneously.
  • Then, in terms of data flow back the other way, once you’ve completed a job in iCOS that has been pushed from Consignly, that information will get provided back to Consignly.
  • At the moment we’re monitoring for delivery complete events, with optional POD information.
  • If a delivery is completed, Consignly will tell you who completed it, who signed for it, and store a copy of the signature in the Consignment POD tab.
  • At the same time the consignment will automatically move into the Complete status.




What's the Setup Process?


iCOS setup

To get started, you’ll need to contact iCOS via support@icoslive.com and:

  1. Request that the integration for Consignly be turned on
  2. Provide them information about who you are so they know which iCOS account to activate
  3. Request the carrier code for your account (this will be a number that looks something like 121771)
  4. Request the EDI Recipient code for your iCOS installation (this might look something like DYN)
Consignly Setup Once you have the requested information from iCOS you can start the setup in consignly. To begin login, in the side menu select Organisation > Apps > iCOS LIVE Setup.
  • The subscription name is a friendly name entered by you to identify the iCOS installation (as some clients operate more than one iCOS account this screen allows you to name different configurations to make it easy to understand what’s what)
  • The carrier code will be the number provided by iCOS
  • The EDI recipient will be a code provided by iCOS
  • The iCOS Commodity is a text value that will go out on all goods lines sent through to iCOS. Some iCOS customers use commodity to help with their freight rating.
    • A limitation of this integration is that there can only be a single commodity value that applies to all goods detail lines
    • This can be left blank
  • Next you choose which carriers you want Consignly to monitor for integration.
    • You may have more than one carrier configured in an integration
  • Lastly, you tell Consignly which clients you want to monitor.
And as part of that you must tell the configuration what the corresponding Account Number in iCOS is – so that Consignly can send it to the right account.
In the example iCOS screen below, the account number is the number circled at the bottom-right.
  • Again, you may monitor more than one client for each configuration.
  • Clicking CREATE INTEGRATION will set up the integration appropriately.





Xero Integration

How do I Setup the Xero Accouting Integration?


  1. Login to Consignly and find the the Apps menu which accessible from the Settings Menu on the left-hand menu bar.
2. Select Xero from the Apps list. 3. Click Connect to Xero 4. Enter your Xero Account Login Details and Log in. 5. Review the data that will be used in the connection. Click allow access to proceed. 6. Select a sales account and enter a message to appear on the invoice line. Transactions are batched together in consignly as a Schedule. This schedule will be attached to the Xero Invoice as a PDF. This message can help to let the customer know the transactions can be found in the attached schedule. 7. For each of your organisation partners select an associated contact in Xero. 8. Complete Setup