API Reference

updateTrackedShipmentsMetadata

Updates the metadata of a tracked shipment.

Arguments

NameTypeDescription
trackedShipmentsMetadata[TrackedShipmentMetadataInput!]!The metadata attribute to be updated by the user.

TrackedShipmentMetadataInput Fields

NameTypeDescription
etaDateTimeThe updated estimated time of arrival provided by the user.
etdDateTimeThe updated estimated time of departure provided by the user.
jobNumberStringThe updated Job number provided by the user.
podLocodeThe updated Port of discharge (UN Locode) provided by the user.
polLocodeThe updated Port of load (UN Locode) provided by the user.
trackedShipmentIdObjectIdThe updated MongoDB tracked shipment ID.

Returns

NameDescription
BooleanWhether the update succeeded.

Example Code

Sample Mutation

mutation UpdateTrackedShipmentsMetadata($trackedShipmentsMetadata: [TrackedShipmentMetadataInput!]!) {
  updateTrackedShipmentsMetadata(trackedShipmentsMetadata: $trackedShipmentsMetadata)
}

Variables

{
  "trackedShipmentsMetadata": [
    {
      "eta": "2022-03-02T00:00:00.000Z",  
      "etd": "2022-01-03T00:00:00.000Z",
      "jobNumber": null,
      "pod": "CNNSA",
      "pol": "GBSOU",
      "trackedShipmentId": "621ca0a820912bbfa247733c"
    }
  ]
}

Response

{
  "data":{
    "updateTrackedShipmentsMetadata":true
  }
}