Status Update Webhook
Content Response Parameters
| Parameter | Description | Type | Length |
|---|---|---|---|
| content | string | 50 | |
| reference | Object | ||
| ourReference | System reference for the shipment | string | 50 |
| yourReference | Tracking reference for the shipment | string | 50 |
| serviceType | Service used for delivery | string | 50 |
| trackingUrl | URL to track the shipment | string | 255 |
| relatedItems | List of items related with the shipment (PODs, other documents, etc.) | Object | |
| type | Related item type | string | |
| value | Related item value | string | |
| carrierReferences | List of tracking reference(s) provided by the carrier for a dispatched warehouse order | Object | |
| reference | Tracking reference for the shipment | string | |
| carrierName | Name of the carrier of the freight | string | |
| TrackingUrl | URL to track the shipment | string | 255 |
| events | List of all the statuses the document has been through | Object | |
| event | Object | ||
| eventDateTime | Date when the event happened | datetime | |
| groupingLevel1Code | Matches the worm status on public tracking result, see: www.mainfreight.com/track | string | 50 |
| groupingLevel2Code | Matches the hero status on the public tracking result, see: www.mainfreight.com/track | string | 50 |
| code |
Event status' system name. This is an immutable value A full list of response codes can be found here |
string | 50 |
| displayName | Event status' description | string | 50 |
| location | Status location | Object | 50 |
| isEstimate | Event is estimated when True. Estimated are future events | Bool | |
| sequence | Represents which order the events happened. In this case, will be 0 as tracking webhook uses the references method which only returns the latest event. | int |