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
}
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
}
}
}
}
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
}
Response
{
"data": {
"trackedShipments": {
"total": 1,
"totalFiltered": 1,
"count": 1,
"data": [
{
"id": "638ee868e7eb2f52d4c320c8",
"shipment": {
"id": "63635275b50f1300122973bf",
"carrierBookingReference": "HLCUTA12211APVV5"
"containerNumber": "FANU3197029",
"bol": null,
"scac": "HLCU",
"carrier": {
"code": "HLCU",
"shortName": "Hapag Lloyd",
"longName": "Hapag-Lloyd",
"codeAliases": [
"HLCU",
"HLXU",
"HPGC",
"HLUS"
]
},
"container": {
"id": "636352752474d85bac377aaa",
"number": "FANU3197029",
"isoCode": "45G1"
},
"status": {
"id": "639715b220f3e30012058bc4",
"events": [
{
"description": "Empty to shipper",
"voyage": null,
"utcOffset": "-0500",
"timestamps": {
"datetime": "2022-11-30T21:49:00.000Z",
"code": "ACT"
},
"eventType": [
"EQUIPMENT"
],
"equipmentEventTypeCode": [
"DROP"
],
"transportEventTypeCode": [],
"port": {
"id": "5358fc78b68ca120a07dbcf3",
"type": "Feature"
}
},
{
"description": "Gate in at first POL",
"voyage": null,
"utcOffset": "-0500",
"timestamps": {
"datetime": "2022-12-01T19:21:00.000Z",
"code": "ACT"
},
"eventType": [
"EQUIPMENT"
],
"equipmentEventTypeCode": [
"GTIN"
],
"transportEventTypeCode": [],
"port": {
"id": "5358fc78b68ca120a07dbcf3",
"type": "Feature"
}
},
...
],
"estimatedArrivalAt": "2023-01-15T00:30:00.000Z",
"actualArrivalAt": null,
"estimatedDepartureAt": null,
"actualDepartureAt": "2022-12-01T19:21:00.000Z",
"currentEvent": {
"description": "Departure from first POL",
"voyage": "2244",
"utcOffset": "-0500",
"eventType": [
"TRANSPORT"
],
"equipmentEventTypeCode": [],
"transportEventTypeCode": [
"DEPA"
]
},
"milestones": [
{
"type": "POL",
"utcOffset": "-0500",
"arrival": {
"voyage": "2244"
},
"departure": {
"voyage": "2244"
},
"port": {
"id": "5358fc78b68ca120a07dbcf3",
"type": "Feature",
"properties": {
"name": "New York",
"areaType": "Port",
"country": "UnitedStates",
"locode": "USNYC",
"secondaryLocodes": [
"USEWR",
"USBAY",
"USPEB",
"USNWK",
"USPNJ"
]
}
}
},
{
"type": "POD",
"utcOffset": "+0530",
"arrival": {
"voyage": "2244"
},
"departure": null,
"port": {
"id": "562cc82a8c0e57be50751ec1",
"type": "Feature",
"properties": {
"name": "Jawaharlal Nehru - Nhava Sheva",
"areaType": "Port",
"country": "India",
"locode": "INNSA",
"secondaryLocodes": null
}
}
}
],
"predicted": {
"datetime": "2023-01-15T12:30:00.000Z",
"code": "EST",
"diffFromCarrierDays": 0
},
"voyageStatus": null,
"arrivingAt": "2023-01-15T12:30:00.000Z",
"pod": {
"id": "562cc82a8c0e57be50751ec1",
"type": "Feature",
"properties": {
"name": "Jawaharlal Nehru - Nhava Sheva",
"areaType": "Port",
"country": "India",
"locode": "INNSA",
"secondaryLocodes": null
}
},
"pol": {
"id": "5358fc78b68ca120a07dbcf3",
"type": "Feature"
},
"postPod": null
},
"initialCarrierETA": "2022-11-24T00:00:00.000Z"
},
"createdAt": "2022-12-06T06:59:52.838Z",
"updatedAt": "2022-12-12T16:40:15.395Z",
"metadata": {
"businessData": null
}
}
]
}
}
}