Returns tracked shipments.
Arguments
Name | Type | Description |
---|---|---|
limit | PositiveInt! | The maximal number of records to return. |
offset | NonNegativeInt! | The number of returned records to skip from the beginning of the record list. |
sort | [SortInput!] | Sets how the returned nodes are sorted. |
orderBy | [OrderByInput!] | Sets the order of the returned track shipment nodes. |
filterBy | [FilterByInput!] | Sets a tracked shipments filter that tests an input field value against a condition or another value. |
searchTerm | String | Specifies a search term. |
Returns
Name | Description |
---|---|
TrackedShipments! | The returned tracked shipments' data and metadata. |
TrackedShipments Fields
Name | Type | Description |
---|---|---|
data | [TrackedShipment] | The shipments' data. |
total | NonNegativeInt | The total number of shipments. |
totalFiltered | NonNegativeInt | The total number of filtered results. |
Example Code
Sample Query
query trackedShipments( $offset: NonNegativeInt!, $limit: PositiveInt!, $sort: [SortInput!], $orderBy: [OrderByInput!], $filterBy: [FilterByInput!], $searchTerm: String) {
trackedShipments(offset: $offset, limit: $limit, sort: $sort, orderBy: $orderBy, filterBy: $filterBy, searchTerm: $searchTerm) {
total
totalFiltered
count
data {
id
metadata{
bookingReference
businessData{
key
value
}
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
equipmentEventTypeCode
shipmentLocationTypeCode
emptyIndicatorCode
}
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 {
createdAt
delayReasonCode
vessels {
compared {
id
}
updated {
id
}
}
departureFromMilestone {
compared {
datetime
datetimeLocalized
utcOffset
}
updated {
datetime
datetimeLocalized
utcOffset
}
}
shipmentPhase
locode
delayReasonDescription
cause
port {
id
}
}
}
}
initialCarrierETA
}
createdAt
updatedAt
}
}
}
}
query Shipment($limit: PositiveInt!, $sort: [SortInput!], $filterBy: [FilterByInput!]) {
trackedShipments(limit: $limit, sort: $sort, filterBy: $filterBy) {
data {
shipment {
id
containerNumber
bol
carrierBookingReference
scac
status {
actualArrivalAt
actualDepartureAt
arrivingAt
currentEvent {
emptyIndicatorCode
equipmentEventTypeCode
eventType
port {
properties {
locode
}
}
shipmentEventTypeCode
shipmentLocationTypeCode
transportEventTypeCode
timestamps {
code
datetimeLocalized
}
vessel {
imo
}
}
delay {
podETA {
compared {
datetimeLocalized
}
updated {
datetimeLocalized
}
}
reasons {
delayReasonCode
}
}
estimatedArrivalAt
estimatedDepartureAt
events {
description
emptyIndicatorCode
equipmentEventTypeCode
eventType
shipmentEventTypeCode
shipmentLocationTypeCode
port {
properties {
locode
}
}
transportEventTypeCode
vessel {
imo
}
}
id
pod {
properties {
locode
}
}
pol {
properties {
locode
}
}
predicted {
code
datetimeLocalized
}
}
initialCarrierETALocalized
initialCarrierETDLocalized
response {
message
description
latestShipmentDataFetch
}
}
}
}
}
Variables
{
"offset": null,
"limit": null,
"sort": [
{
"field": null,
"order": null
}
],
"orderBy": [
{
"field": null,
"order": null
}
],
"filterBy": [
{
"field": null,
"or": [
{
"field": null,
"ranges": [
{
"boost": null,
"format": null,
"gt": null,
"gte": null,
"lt": null,
"lte": null,
"relation": null,
"time_zone": null
}
],
"values": null
}
],
"ranges": [
{
"boost": null,
"format": null,
"gt": null,
"gte": null,
"lt": null,
"lte": null,
"relation": null,
"time_zone": null
}
],
"values": null
}
],
"searchTerm": null
}
{
"limit": 2,
"sort": [
{
"order": "asc",
"field": "containerNumber"
}
]
}
Response
{
"data": {
"trackedShipments": {
"data": [
{
"shipment": {
"id": "65bbb8af214b7c15b09bca8d",
"containerNumber": null,
"bol": "MEDUUG614253",
"carrierBookingReference": null,
"scac": "SHKU",
"status": {
"actualArrivalAt": null,
"actualDepartureAt": null,
"arrivingAt": null,
"currentEvent": null,
"delay": {
"podETA": null,
"reasons": null
},
"estimatedArrivalAt": null,
"estimatedDepartureAt": null,
"events": [],
"id": null,
"pod": null,
"pol": null,
"predicted": {
"code": null,
"datetimeLocalized": null
}
},
"initialCarrierETALocalized": null,
"initialCarrierETDLocalized": null,
"response": {
"message": "BOL_OR_BOOKING_REF_INPUT_ERROR",
"description": "Data retrieval was unsuccessful due to bad input (BOL OR BOOKING REFERENCE)",
"latestShipmentDataFetch": "2024-02-01T15:29:12.829Z"
}
}
},
{
"shipment": {
"id": "656c5ffaf071700016a3d209",
"containerNumber": "ZIMU2957644",
"bol": "ZIMUHFA4321470",
"carrierBookingReference": null,
"scac": "ZIMU",
"status": {
"actualArrivalAt": "2023-12-07T10:52:00.000Z",
"actualDepartureAt": "2023-12-01T16:14:00.000Z",
"arrivingAt": null,
"currentEvent": {
"emptyIndicatorCode": "EMPTY",
"equipmentEventTypeCode": [
"DROP"
],
"eventType": [
"EQUIPMENT"
],
"port": {
"properties": {
"locode": "ITGOA"
}
},
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"transportEventTypeCode": [],
"timestamps": {
"code": "ACT",
"datetimeLocalized": "2023-12-12T16:40:00.000Z"
},
"vessel": null
},
"delay": {
"podETA": null,
"reasons": null
},
"estimatedArrivalAt": null,
"estimatedDepartureAt": null,
"events": [
{
"description": "Unknown",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": null,
"eventType": null,
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "ILHFA"
}
},
"transportEventTypeCode": null,
"vessel": null
},
{
"description": "Unknown",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": null,
"eventType": null,
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "ILHFA"
}
},
"transportEventTypeCode": null,
"vessel": null
},
{
"description": "Gate in at first POL",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"GTIN"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "ILHFA"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Loaded at first POL",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"LOAD"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "ILHFA"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": {
"imo": 9386718
}
},
{
"description": "Departure from first POL",
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "ILHFA"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": {
"imo": 9386718
}
},
{
"description": "Arrival at final POD",
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "ITGOA"
}
},
"transportEventTypeCode": [
"ARRI"
],
"vessel": {
"imo": 9386718
}
},
{
"description": "Discharge at final POD",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"DISC"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "ITGOA"
}
},
"transportEventTypeCode": [
"ARRI"
],
"vessel": {
"imo": 9386718
}
},
{
"description": "Gate out from final POD",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"GTOT"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "ITGOA"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Empty return to depot",
"emptyIndicatorCode": "EMPTY",
"equipmentEventTypeCode": [
"DROP"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "ITGOA"
}
},
"transportEventTypeCode": [],
"vessel": null
}
],
"id": null,
"pod": {
"properties": {
"locode": "ITGOA"
}
},
"pol": {
"properties": {
"locode": "ILHFA"
}
},
"predicted": {
"code": "ACT",
"datetimeLocalized": "2023-12-07T10:19:08.000Z"
}
},
"initialCarrierETALocalized": "2023-12-07T00:00:00.000Z",
"initialCarrierETDLocalized": null,
"response": {
"message": "DATA_AVAILABLE",
"description": "Data retrieval is successful, ensuring a seamless experience",
"latestShipmentDataFetch": "2023-12-13T04:01:52.420Z"
}
}
}
]
}
}
}
{
"data": {
"trackedShipments": {
"data": [
{
"shipment": {
"id": "6582fdc2ee09e2001221c9c1",
"containerNumber": "CAAU5433450",
"bol": "233129867",
"carrierBookingReference": null,
"scac": "MAEU",
"status": {
"actualArrivalAt": null,
"actualDepartureAt": "2023-12-10T19:49:00.000Z",
"arrivingAt": "2024-02-16T10:30:00.000Z",
"currentEvent": {
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"port": {
"properties": {
"locode": "MAPTM"
}
},
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "UNK",
"transportEventTypeCode": [
"DEPA"
],
"timestamps": {
"code": "ACT",
"datetimeLocalized": "2023-12-25T15:08:46.000Z"
},
"vessel": {
"imo": 9321524
}
},
"delay": {
"podETA": {
"compared": {
"datetimeLocalized": "2024-01-17T16:30:00.000Z"
},
"updated": {
"datetimeLocalized": "2024-02-17T04:00:00.000Z"
}
},
"reasons": [
{
"delayReasonCode": "RDF"
}
]
},
"estimatedArrivalAt": "2024-02-15T22:30:00.000Z",
"estimatedDepartureAt": null,
"events": [
{
"description": "Empty to shipper",
"emptyIndicatorCode": "EMPTY",
"equipmentEventTypeCode": [
"DROP"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "PREPOL",
"port": {
"properties": {
"locode": "DEBRV"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Gate in at first POL",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"GTIN"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "DEHAM"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Loaded at first POL",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"LOAD"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "DEHAM"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": null
},
{
"description": "Departure from first POL",
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "DEHAM"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": {
"imo": 9321524
}
},
{
"description": "Arrival at T/S port",
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "TSP",
"port": {
"properties": {
"locode": "AEJEA"
}
},
"transportEventTypeCode": [
"ARRI"
],
"vessel": {
"imo": 9321524
}
},
{
"description": "Departure from T/S port",
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "TSP",
"port": {
"properties": {
"locode": "AEJEA"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": {
"imo": 9303807
}
},
{
"description": "Arrival at final POD",
"emptyIndicatorCode": null,
"equipmentEventTypeCode": [],
"eventType": [
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "INNSA"
}
},
"transportEventTypeCode": [
"ARRI"
],
"vessel": {
"imo": 9303807
}
}
],
"id": null,
"pod": {
"properties": {
"locode": "INNSA"
}
},
"pol": {
"properties": {
"locode": "DEHAM"
}
},
"predicted": {
"code": "EST",
"datetimeLocalized": "2024-02-16T16:00:00.000Z"
}
},
"initialCarrierETALocalized": "2024-01-17T04:30:00.000Z",
"initialCarrierETDLocalized": null,
"response": {
"message": "DATA_AVAILABLE",
"description": "Data retrieval is successful, ensuring a seamless experience",
"latestShipmentDataFetch": "2024-02-01T15:15:46.636Z"
}
}
},
{
"shipment": {
"id": "655d98f47cb133001204997f",
"containerNumber": "CAAU5590022",
"bol": null,
"carrierBookingReference": null,
"scac": "MSCU",
"status": {
"actualArrivalAt": "2024-01-18T23:00:00.000Z",
"actualDepartureAt": "2023-12-12T06:00:00.000Z",
"arrivingAt": null,
"currentEvent": {
"emptyIndicatorCode": "EMPTY",
"equipmentEventTypeCode": [
"DROP"
],
"eventType": [
"EQUIPMENT"
],
"port": {
"properties": {
"locode": "HUBUD"
}
},
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POSTPOD",
"transportEventTypeCode": [],
"timestamps": {
"code": "ACT",
"datetimeLocalized": "2024-01-29T00:00:00.000Z"
},
"vessel": null
},
"delay": {
"podETA": {
"compared": {
"datetimeLocalized": null
},
"updated": {
"datetimeLocalized": "2024-01-19T00:00:00.000Z"
}
},
"reasons": [
{
"delayReasonCode": "FVD"
}
]
},
"estimatedArrivalAt": null,
"estimatedDepartureAt": null,
"events": [
{
"description": "Empty to shipper",
"emptyIndicatorCode": "EMPTY",
"equipmentEventTypeCode": [
"DROP"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "MXATM"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Gate in at first POL",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"GTIN"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "MXATM"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Loaded at first POL",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"LOAD"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POL",
"port": {
"properties": {
"locode": "MXATM"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": {
"imo": 9290543
}
},
{
"description": "Discharge at T/S port",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"DISC"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "TSP",
"port": {
"properties": {
"locode": "ITGIT"
}
},
"transportEventTypeCode": [
"ARRI"
],
"vessel": {
"imo": 9290543
}
},
{
"description": "Loaded at T/S port",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"LOAD"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "TSP",
"port": {
"properties": {
"locode": "ITGIT"
}
},
"transportEventTypeCode": [
"DEPA"
],
"vessel": {
"imo": 9357810
}
},
{
"description": "Discharge at final POD",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"DISC"
],
"eventType": [
"EQUIPMENT",
"TRANSPORT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "SIKOP"
}
},
"transportEventTypeCode": [
"ARRI"
],
"vessel": {
"imo": 9357810
}
},
{
"description": "Gate out from final POD",
"emptyIndicatorCode": "LADEN",
"equipmentEventTypeCode": [
"GTOT"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POD",
"port": {
"properties": {
"locode": "SIKOP"
}
},
"transportEventTypeCode": [],
"vessel": null
},
{
"description": "Empty return to depot",
"emptyIndicatorCode": "EMPTY",
"equipmentEventTypeCode": [
"DROP"
],
"eventType": [
"EQUIPMENT"
],
"shipmentEventTypeCode": null,
"shipmentLocationTypeCode": "POSTPOD",
"port": {
"properties": {
"locode": "HUBUD"
}
},
"transportEventTypeCode": [],
"vessel": null
}
],
"id": null,
"pod": {
"properties": {
"locode": "SIKOP"
}
},
"pol": {
"properties": {
"locode": "MXATM"
}
},
"predicted": {
"code": "ACT",
"datetimeLocalized": "2024-01-19T14:32:27.000Z"
}
},
"initialCarrierETALocalized": "2024-01-18T00:00:00.000Z",
"initialCarrierETDLocalized": null,
"response": {
"message": "DATA_AVAILABLE",
"description": "Data retrieval is successful, ensuring a seamless experience",
"latestShipmentDataFetch": "2024-02-01T14:39:56.778Z"
}
}
}
]
}
}
}