EdiStatusUpdates < Cargooffice

Tags: view all tags
---++ EDI Status Updates

%TOC%
---+++ About

Order statuses can be changed via EDI (see: [[ShipmentStatus][About shipment status and actions]])<br /> Standard file formats can be used as described earlier in this [[EdiHowto][chapter]], below are some examples, one for TTM one for CSV and one for XML format.

Other formatted files can probably be parsed using the EdiConfigurator. Alternatively we can create a dedicated parser for you. In that case contact us via our [[BugtrackingDocumentation][Feedback and Report system]].

---+++ 1. TTM formatted status update

TTM formatted files containing status updates must be sent to a special email address:

<verbatim>
EDI+{CN}+ttm@cargooffice.com</verbatim>

You must provide the *orderID* and the new *status*.

*Note:* In stead of *orderID* you can also use *shipmentID* or *trackingNbr* (see sample below).

Example file:

<verbatim>
<!-- start order
orderID : 123456789
status : +2009-10-21 14:20 delivered
--> 
<!-- start order
shipmentID : 234567890
status : +2009-10-21 14:25 delivered
--> 
<!-- start order
trackingNbr : 1234.345678901
status : +2009-10-21 14:30 delivered
--></verbatim>

---++++ Special field orgShipmentID

To replace the shipmentID by a new shipmentID you may add field *orgShipmentID*.<br />
This is commonly used to change the shipmentIDs so that they correspond to the carriers local TMS system.<br />
In the example below *orgShipmentID* will be replaced by *shipmentID* and orgShipmentID will no longer exist.
<verbatim>
<!-- start order
orgShipmentID : 234567890
shipmentID : 987654321
status : +2009-10-21 14:25 order accepted
--> </verbatim>

---+++ 2. CSV formatted status update

CSV formatted files containing status updates must be sent to a special email address:

<verbatim>
EDI+{CN}+csv@cargooffice.com</verbatim>

Example file:

<verbatim>
orderID,status
123456789,+2009-10-21 14:20 delivered
234567890,+2009-10-21 14:25 delivered
..... etc...</verbatim>

---+++ 3. XML formatted status update

XML formatted files containing status updates must be sent to a special email address:

<verbatim>
EDI+{CN}+xml@cargooffice.com</verbatim>

Example file:

<verbatim>
<orderData>
  <orders>
    <order>
      <CN>12021</CN>
      <shipments>
        <shipment>
          <shipmentID>700753</shipmentID>
          <status>+2012-02-21 15:20 afgeleverd</status>
        </shipment>
        <shipment>
          <shipmentID>700754.00</shipmentID>
          <status>+2012-02-21 15:25 delivered</status>
        </shipment>	
        <shipment>
          <shipmentID>700754.01</shipmentID>
          <status>+2012-02-21 15:25 delayed</status>
        </shipment>			
      </shipments>
    </order>
  </orders>
</orderData></verbatim>



---+++ 4. Other formats

Other formatted files can probably be parsed using the EdiConfigurator. Alternatively we can create a dedicated parser for you. In that case contact us via our [[BugtrackingDocumentation][Feedback and Report system]].



---+++ 5. Notes
   * <a href="EdiDatatransfer" target="_self">See here</a> for a description of data transfer methods including the construction of the mentioned 'special email addresses'.
   * + before the status means the new status is added to earlier statuses, this is standard procedure so please always add this + sign unless you want to delete all earlier statusses of this orderID.
   * the timestamp before the actual status must be formatted like this: yyyy-mm-dd hh:mm
   * the sender's email address will be checked against known drivers and charters (Backoffice -&gt; Dispatch -&gt; Drivers). If there is no driver, charter or carrier with the sender's email address then the status update will be rejected and the sender will receive an error message.
-- Main.RutgerRutgers - 22 Oct 2009
Topic revision: r15 - 2018-01-17 - HenkRoelofs