Arguments

Name	Type	Description
ids	[ObjectId!]!	The shipment Unique Windward assigned ID.

Returns

Name	Description
TrackedShipment!	The returned tracked shipment data and metadata.

TrackedShipment Fields

Name	Type	Description
createdAt	DateTime!	Shipment tracking start timestamp.
id	ObjectId!	The shipment Unique Windward assigned ID.
metadata	TrackedShipmentMetadata	Additional metadata updated by the user.
shipment	Shipment	The shipment data.
updatedAt	DateTime!	Shipment last update timestamp.

Example Code

Sample Query

query trackedShipmentsByIds( $ids: [ObjectId!]!) {
 trackedShipmentsByIds( ids: $ids) {
  
     shipment {
       id
       carrierBookingReference
       containerNumber
       bol
       scac
       carrier {
         code
         shortName
         longName
         codeAliases
       }
       container {
         id
         number
         isoCode
       }
       status {
         id
         events {
           description
           voyage
           utcOffset
           timestamps {
             datetime
             code
           }
           eventType
           equipmentEventTypeCode
           transportEventTypeCode
           port {
             id
             type
           }
         }
         estimatedArrivalAt
         actualArrivalAt
         estimatedDepartureAt
         actualDepartureAt
         currentEvent {
           description
           voyage
           utcOffset
           eventType
           equipmentEventTypeCode
           transportEventTypeCode
         }
         milestones {
           type
           utcOffset
           arrival {
             voyage
           }
           departure {
             voyage
           }
           port {
             id
             type
             properties {
               name
               areaType
               country
               locode
               secondaryLocodes
             }
           }
         }
         predicted {
           datetime
           code
           diffFromCarrierDays
         }
         voyageStatus
         arrivingAt
         pod {
           id
           type
           properties {
             name
             areaType
             country
             locode
             secondaryLocodes
           }
         }
         pol {
           id
           type
         }
         postPod {
           id
           type
         }
         delay {
           reasons {
             delayReasonCode
             vessels {
               compared {
                 id
               }
               updated {
                 id
               }
             }
             departureFromMilestone {
               compared {
                 datetime
                 datetimeLocalized
                 utcOffset
               }
               updated {
                 datetime
                 datetimeLocalized
                 utcOffset
               }
             }
             shipmentPhase
             locode
             delayReasonDescription
             cause
             port {
               id
             }
           }
         }
       }
       initialCarrierETA
     }
     createdAt
     updatedAt
  metadata {
    businessData {
      key
      value
    }
    etd
  }
}
   }
 }
}

Variables

{
  "ids": [
    "671faec9e48c9b3e300eddc2"
  ]
}

Response

{
  "data": {
    "trackedShipmentsByIds": [
      {
        "shipment": {
          "id": "671faec95c72176ef1cba796",
          "carrierBookingReference": "HLCUDE12112BFHX0",
          "containerNumber": null,
          "bol": null,
          "scac": "HLCU",
          "carrier": {
            "code": "HLCU",
            "shortName": "Hapag Lloyd",
            "longName": "Hapag-Lloyd",
            "codeAliases": [
              "HLCU",
              "HLXU",
              "HPGC",
              "HLUS"
            ]
          },
          "container": null,
          "status": {
            "id": null,
            "events": [],
            "estimatedArrivalAt": null,
            "actualArrivalAt": null,
            "estimatedDepartureAt": null,
            "actualDepartureAt": null,
            "currentEvent": null,
            "milestones": [],
            "predicted": {
              "datetime": null,
              "code": null,
              "diffFromCarrierDays": null
            },
            "voyageStatus": null,
            "arrivingAt": null,
            "pod": null,
            "pol": null,
            "postPod": null,
            "delay": null
          },
          "initialCarrierETA": null
        },
        "createdAt": "2024-10-28T15:33:29.643Z",
        "updatedAt": "2024-10-28T15:33:29.643Z",
        "metadata": {
          "businessData": [
            {
              "key": "shipper",
              "value": "shipper_a"
            },
            {
              "key": "username",
              "value": "user_a"
            },
            {
              "key": "department",
              "value": "export"
            }
          ],
          "etd": null
        }
      }
    ]
  }
}