View Shipment Tracking

Introduction

This API document is a draft

To view the tracking details of a shipment we need to know its shipment/tracking number and delivery post code.

GET shipments/{uniqueId}

Example Requests

GET /shipments/3fa85f64-5717-4562-b3fc-2c963f66afa6

Example Responses

HTTP 200

{ 
  "shipmentNumber": "string", 
  "lastStatus": { 
    "signatoryFileName": "string", 
    "location": "string", 
    "signatory": "string", 
    "geoLocationLongitude": 0, 
    "geoLocationLatitude": 0, 
    "carrierDepotId": 0, 
    "user": "string", 
    "trackingNumber": "string", 
    "description": "string", 
    "status": "string", 
    "occurredOn": "2023-01-06T11:46:18.031Z" 
  }, 
  "trackingHistory": [ 
    { 
      "signatoryFileName": "string", 
      "location": "string", 
      "signatory": "string", 
      "geoLocationLongitude": 0, 
      "geoLocationLatitude": 0, 
      "carrierDepotId": 0, 
      "user": "string", 
      "trackingNumber": "string", 
      "description": "string", 
      "status": "string", 
      "occurredOn": "2023-01-06T11:46:18.031Z" 
    } 
  ] 
}

HTTP 400, 404

{ 
  "type": "string", 
  "title": "string", 
  "status": 0, 
  "detail": "string", 
  "instance": "string", 
  "additionalProp1": "string", 
  "additionalProp2": "string", 
  "additionalProp3": "string" 
}