Shipment Event Updates
RECEIVE Event update
This is used to either create events in our SPOT system or to receive event information when events are updated on your shipment.
messageType: transport.eventUpdate
Sample files:
{
"messageHeader": {...},
"eventUpdate": {...}
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| messageHeader | MessageHeader | M | Message Header information. |
| eventUpdate | EventUpdate | M | Event Update information. |
EventUpdate
"...": {
"trackingId": "string",
"transportReferences": [{...}],
"references": [{...}],
"events": [{...}]
}For json references and events key "reference" or "event" must be provided as shown in code snippet and sample files.
Transport references should be provided as array.
| Property | Type | Mandatory | Description |
|---|---|---|---|
| trackingId | String | M | Shipment tracking ID (SPOT ID). |
| transportReferences | Array[TransportReference] | O | Array of transport references. |
| references | Array[TransportOrderReference] | O | Array of references. (Customer/Partner/...) |
| events | Array[Event] | M | Array of events. |
💡
Shipment event can be accessed using trackingId but also using customerReference providing it in references object, or using MBL provided in transportReferences.
TransportReference
"...": {
"referenceType": "string",
"value": "string"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| referenceType | String | M | Type of transport reference MAWB, HAWB, MBL, HBL, JOBFILE_UKW_POSITION. |
| value | String | M | Reference value. |