| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
User identifier of company sending status message (assigned by receiving company) |
string |
None. |
| ShipmentNumber |
Unique shipment number in senders system |
string |
None. |
| Reference |
Reference number for this order provided by receiver (ShipmentNumber if PLTMS) |
string |
None. |
| SenderID |
Identifier of company sending this message (Senders CompanyID if PLTMS) |
string |
None. |
| ReceiverID |
Identifier of company receiving this message (Receivers CompanyID if PLTMS) |
string |
None. |
| EventCode |
The type of event: ORDERACK = order/alert acknowledged and confirmed accepted DISPATCHED = courier has been dispatched to pickup PICKEDUP = order has been picked-up/collected OFD = shipment is out for delivery DELIVERED = shipment delivered QDTORIG = original quoted delivery time established QDTCHANGE = quoted delivery time changed |
string |
None. |
| EventDateTime |
The actual date/time UTC that the event occured (null means that event did not occur yet) |
string |
None. |
| Latitude |
If available, the current latitude of the shipment reported in this event |
decimal number |
None. |
| Longitude |
If available, the current longitude of the shipment reported in this event |
decimal number |
None. |
| SignatureText |
The textual represetation of the pickup or delivery signature |
string |
None. |
| Pieces |
Total pieces |
integer |
None. |
| Weight |
Total weight |
decimal number |
None. |
| WeightUOM |
Weight UOM (LB, KG) |
string |
None. |
| Length |
Length |
integer |
None. |
| Width |
Width |
integer |
None. |
| Height |
Height |
integer |
None. |
| SizeUOM |
Size UOM (IN,CM) |
string |
None. |
| Distance |
Distance between pickup and delivery |
integer |
None. |
| DistanceUOM |
Distance unit (MI,KM) |
string |
None. |
| PickupWaitingTime |
Amount of waiting time minutes at pickup |
integer |
None. |
| PickupAttemptCount |
Number of pickup attempts |
integer |
None. |
| DeliveryWaitingTime |
Amount of waiting time minutes at delivery |
integer |
None. |
| DeliveryAttemptCount |
Number of delivery attempt |
integer |
None. |
| QuotedDeliveryDateTime |
The original quoted delivery date/time |
string |
None. |
| UpdatedDeliveryDateTime |
The updated quoted delivery date/time |
string |
None. |
| Images |
Contains images associated with this shipment status including photos and signature |
Collection of ImageItem |
None. |
| AcknowledgeUserName |
Name of user that acknowledged the order |
string |
None. |