Consignor transport EDI


Consignor is a logistics service provider which supports companies in the delivery of parcels to their customers via a large library of national and international carriers, which includes all stages of shipment and delivery.

This means you only need 1 EDI link from Cerm to the Consignor and Consignor handles the bidirectional communication with the carrier of your choice.

This topic describes the required configurations of the Cerm software to set up an interface with the Consignor on premisses application.

The Consignor software itself is capable of informing the customer by e-mail or SMS about the shipment and has an end-user multi-language portal to follow-up the shipments


To assure a successful implementation of a partner integration, it must be scheduled up front. Always contact your Cerm consultant and your contact person at the partner well in advance if you plan to implement an integration, since there must always be an agreement up front on the costs and support during the implementation.

In most cases an integration implementation requires:

  • a simultaneous intervention of a Cerm consultant and an engineer of the partner (remote or on site, depending on the situation)

  • purchasing and activation of licenses or software versions (at the Cerm side and/or at the partner side)

The installation and set-up of the Consignor software has to be done by your Consignor consultant (or yourself if you know how to do it). This is outside the scope of this topic!


Consignor has 2 systems to receive transport information and therefor different requirements:

  • Preferred solution: Receive transport information via web services (JSON format)
    • For Cerm: Minimum 7.23

    • For Consignor: Consignor web services

  • Receive transport information via hot folder solution:
    • For Cerm: minimum v7.15
    • For Consignor: Consignor on premises (the UI for the internal user in your printing company is available in English (no other languages are provided)

The preferred solution is the link via web services, since this has the most features, including the feedback. Also, when there will be new developments in the future regarding this link, they will be added to the webservices solution.


  • Define the correct EDI settings

  • Make sure that the composition of the pick slip ID does not contain the tag bst__bon, since this might result in multiple transport requirements while it only concerns 1 transport for Consignor.

  • You need to implement the use of Transport requirements since these are the basis for the EDI.

  • Ask your Cerm consultant to provide the Consignor Custom export file (see technical details on the export layout further in this topic) and add it to the Custom export layouts)

  • An XSLT should accompany the Custom export file, this should be installed at the Consignor side.

  • Create a new interface

    • For the web services solution

    • For the hot folder solution

  • Supplier(s) / Transport modes

    • If you, as a user, determine in Cerm the service of a certain carrier, for example Express 9AM of <carrier>, then

      • All carriers need to be defined as suppliers

        • With supplier property "Interfaces / EDI link" = newly created Consignor - Shipment Server interface

        • In case you (partly) perform the transport yourself, you should create your own printing company as a carrier as well. Consignor has an optional app which allows you to trace your own deliveries!

      • All services of each carrier need to be defined as transport modes in the parameter Info transport, exactly as they exist in the Consignor software:

        • For the Web services solution

        • For the hot folder solution

    • If Consignor determines the service of a certain carrier, via for example Shipping Rules,

      • it is possible to create 1 "fictive" supplier with supplier property "Interfaces / EDI link" = newly created Consignor - Shipment Server interface.  

      • No transport modes need to be defined since Consignor will determine the carrier and the service

  • Shipment addresses: there is no need for the destination shipment addresses to be known in Consignor, the full addresses are added to the XML/JSON request.

  • To provide a tracking URL for the customer:
    • How to compose an anonymous URL to Consignor Portal
    • If you want to have a direct link to the shipment tracking of the carrier, you need to compose the tracking URL depending on their URL & the unique shipment number
      For example:


  • For web services solution
  • For hot folder solution

Delete / Reset


  • When you try to export a transport requirement record for a second time (via EDI or hotfolder), a warning is shown to inform you that the transport requirement was already send before.
    You can proceed and if the status of the transport requirement is "Ready for shipment" AND the transport requirement does not have a shipment ID (edishpid), a second XML file (with a sequence number) is written.
    E.g. 200154_0001.xml for the first file and 200154_0002.xml for the second file.

  • In the column "Tracking URL": a button will open a tracking link that opens the Consignor tracking page for this transport.
    This tracking URL is also accessible in the Sales order module for the related sales orders

See also

Technical info