TransVirtual Standard Status Update Import (XML V1.0)
Status Update Import
Supplying your Statuses in this format provides easy and detail format for integration. This can be accepted in FTP or Email. Advise your integration contact of your preferred method.
<Statuses>
<StatusEvent>
<ConsignmentNumber>ABC123456</ConsignmentNumber>
<UniqueId>ABC123456</UniqueId>
<StatusDateTime>02/06/2020 08:34</StatusDateTime>
<ExportDate>02/06/2020 08:34</ExportDate>
<Status>Delivered</Status>
<DriverNotes>Some Driver Notes</DriverNotes>
<StatusUserName>Michael</StatusUserName>
<PickupRelated>N</PickupRelated>
<AgentName>Freds Deliveries</AgentName>
<AgentCode>F1001</AgentCode>
</StatusEvent>
</Statuses>
Notes
| XML Element | Manatory (Y/N) | Notes |
| <Statuses> | Y | Defines the start of the Manifest of Scan's |
| <StatusEvent> | Y | Defines the start of the Scan event |
| <ConsignmentNumber> | Y* | Defines the Consignment Number the Scan information is for |
| <UniqueID> | N* | Defines the UniqueID the Scan information is for |
| <StatusDateTime> | Y | The date and time of the status change. Format should be UTC Time** dd/MM/yyyy HH:mm, if not please advise the integration specialist of your format. |
| <ExportDate> | N | The date and time of the export. Format should be UTC Time** dd/MM/yyyy HH:mm, if not please advise the integration specialist of your format. |
| <Status> | Y | All Status will be listed below in their own Table |
| <DriverNotes> | N | These could be the driver rejected or LAI/ATL notes |
| <StatusUserName> | N | This could be the drivers name or a system name or who triggered this status event. |
| <PickupRelated> | N | Value - Y/N | Defines if the reason for this event is in regards to a pickup |
| <AgentName> | N | The matching agent name |
| <AgentCode> | N | The matching agent code |
List of Statuses;
| Status Name | Notes |
Standard Operation Statuses | |
| Assigned | Consignment Assigned to Driver/Agent |
| Pickup Received | A consignment has been created that requires a pickup |
| On Delivery | This consignment is on board for delivery |
| In Transit | This consignment is in transit to a depot |
| Hold | This consignment has been held |
| Driver Pickup Ack | Driver has acknowledged a pickup assigned to them on a device |
| Delivered | This consignment has been delivered |
Mobile - Pickup Completed | The pickup leg of this consignment has been completed |
| Administration Complete | Administration has completed this job |
| Account Hold | The customer assigned to this consignment has their account on hold |
Pending On Delivery | The consignment has been allocated to a driver but the driver has not yet left the depot |
Pending Driver Pickup Ack | A pickup has been allocated to a driver, but has not been acknowledged yet. |
Pending Delivered Sent | Used when pre-allocated to a driver |
Pending Assigned Waiting | Used when pre-allocated to a driver |
Pending Assigned | Used when pre-allocated to a driver |
Mobile - Location Drop | Used when delivering to a site that has Location Drops |
In Depot | Consignment has arrived in a depot |
| Pickup/Delivery Issue Status | |
| Pickup Futile Completed | This is a futile pickup, sender does not want to send item(s) |
Mobile - Unsafe to Leave | The location does not feel safe to leave the items |
Mobile - Unable to Access (Traffic/Queue) | The delivery location is not accessable |
| Mobile - Signed on Paper | Arrived at delivery location and had to collect a signature on paper |
Mobile - Short Delivered | Delivery was short |
Mobile - Return Depot | Driver returned consignment to depot |
Mobile - Rejected | Receiver rejected the delivery |
Mobile - Pickup ETA 30mins | Driver is 30mins from Pickup Location |
Mobile - Pickup ETA 15mins | Driver is 15mins from Pickup Location |
Mobile - Out of Time | Drive ran out of time to delivery items. |
Mobile - No Parking | No parking available to unload items |
Mobile - Location Closed | The receiving location was closed |
Mobile - Left as Instructed/Short | A LAI/ATL was performed but not all items |
Mobile - Left as Instructed | A LAI/ATL was performed |
Mobile - Futile Pickup | Could not perform the pickup |
Mobile - Delivery ETA 30mins | Driver is 30mins from Delivery Location |
Mobile - Delivery ETA 15mins | Driver is 15mins from Delivery Location |
Mobile - Declined Reattempt | On a delivery reattempt the receiver declined the consignment |
Mobile - Check Address | The address supplied does not match the Pickup/Delivery address |
Mobile - Booking Required | A booking is required to complete this delivery/pickup |
Related Articles
Proof of Delivery EDI Import
Proof of Delivery EDI Import In TransVirtual there is the ability to create EDI (Electronic Data Interchange) Import rules that allow you to upload PODs and attach them to a consignment. This process would typically be used where an outside system is ...Consignment EDI Import
Consignment EDI Import In TransVirtual there is the ability to create EDI (Electronic Data Interchange) Import rules that allow you to create consignments without the need to use the consignment creation page in the TransVirtual Web Portal. This is ...TransVirtual Standard XML Import V1.0
XML Import Sending XML consignment data to TransVirtual using the following format is the most efficient and cost effective option. <Consignments> <Consignment> <ConsignmentNumber>ABDEM90241Aasdasdas</ConsignmentNumber> ...Scan EDI Import
In TransVirtual there is the ability to setup Scan EDI (Electronic Data Interchange) Import rules that can import scan data relating to consignments. These imports can be setup to receive information via FTP, Email, etc. This article will run through ...Import Types with Examples
In TransVirtual there is the ability to import different kinds of lists into different pages or sections of TransVirtual. These imports are achieved by uploading a list of data in csv format - the purpose of the import process is to allow you to be ...