Example files for the Viya Gateway Tracking JSON format for communicating status events form carrier towards shipper.
Examples
Full: All available fields present in the JSON
{ "carrier": { "name": "United Parcel Services", "reference": "UPS" }, "milestones": [ { "trackingReference": { "handlingUnit": { "shipperAssigned": "123456789-colli1", "carrierAssigned": "1Z3546338832" }, "shipment": { "shipperAssigned": "123456789-ship1", "carrierAssigned": "1Z354633883Y" } }, "trackingUrl": "https://www.carrier.com/tracking?reference=1Z3546338832", "equipment": { "licencePlate": "LK-12-BB" }, "event": { "eventDateTime": "2024-09-24T16:15:00+02:00", "estimatedDateTimeOfArrival": "2024-09-25T14:30:00", "scannedBy": "J. Smith", "message": "Picked up", "type": { "code": "PickupCompleted", "description": "Pickup completed" }, "reason": { "code": "", "description": "" }, "location": { "companyName": "UPS New York Depot", "address": { "addressline1": "79 West Carson Street", "addressline2": "Dock 12", "addressline3": "BLOCK 13", "city": "New York", "postCode": "10002", "stateCode": "NY", "countryCode": "US", "gpsCoordinates": { "latitude": 40.7128, "longitude": -74.006 } }, "airportCode": "JFK", "seaportCode": "USNYC", "depotCode": "NY010" }, "documents": [ { "documentType": "PictureOfDamage", "content": "base64 content" } ] } }, { "trackingReference": { "handlingUnit": { "shipperAssigned": "123456789-colli2", "carrierAssigned": "1Z3546338833" }, "shipment": { "shipperAssigned": "123456789-ship1", "carrierAssigned": "1Z354633883Y" } }, "trackingUrl": "https://www.carrier.com/tracking?reference=1Z3546338832", "equipment": { "licencePlate": "LK-12-BB" }, "event": { "eventDateTime": "2024-09-24T16:15:22Z", "scannedBy": "B. Ferdinand", "message": "OUT FOR DELIVERY", "type": { "code": "DeliveryInProgress", "description": "Delivery process started" }, "reason": { "code": "OutForDelivery", "description": "Out for delivery" }, "location": { "companyName": "UPS New York Depot", "address": { "addressline1": "79 West Carson Street", "addressline2": "Dock 12", "addressline3": "Block 12", "city": "New York", "postCode": "10002", "stateCode": "NY", "countryCode": "US", "gpsCoordinates": { "latitude": 40.7128, "longitude": -74.006 } }, "airportCode": "JFK", "seaportCode": "USNYC", "depotCode": "NY010" }, "documents": { "document": { "documentType": "PictureOfDamage", "content": "base64 content" } } } } ]}Minimal: Only populate mandatory fields in the JSON for delivered shipment
{ "carrier": { "name": "Minimal road carrier", "reference": "MYROADREF" }, "milestones": [ { "trackingReference": { "shipment": { "shipperAssigned": "6100000001" } }, "event": { "eventDateTime": "2024-09-24T16:15:00+02:00", "type": { "code": "DeliveryCompleted" } } } ]}