Look up a shipment by reference
GET
/v2/shipments
carrierCode + carrierBookingReference (carrier booking number), orbillOfLadingNumber (Bill of Lading number), orequipmentReference (container number).carrierCode is required with carrierBookingReference, since a carrier booking number is only unique within a carrier. A container number can be reused across shipments, so pair equipmentReference with carrierBookingReference or billOfLadingNumber to disambiguate.Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v2/shipments?carrierCode=HLCU&carrierBookingReference=95954888&billOfLadingNumber=HLCUBSC2606CBSF8&equipmentReference=HAMU4486106'Response Response Example
200 - Standard event update (full snapshot)
{
"transmissionHeader": {
"transmissionID": "TXN-1783526651038",
"transmissionDateTime": "2026-07-29T00:00:00Z",
"triggerType": "MANUAL_TRIGGER",
"triggeredByEvent": null,
"senderID": "FREIGHTLENS",
"receiverID": "CLIENT",
"schemaVersion": "1.2"
},
"shipmentTracking": {
"bookingReference": "29402735",
"carrierBookingReference": "95954888",
"billOfLadingNumber": "HLCUBSC2606CBSF8",
"carrierCode": "HLCU",
"carrierName": "Hapag-Lloyd",
"vesselName": "ULSAN EXPRESS",
"voyageNumber": "631W",
"portOfLoading": {
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC",
"facilityCode": "HGMQ",
"facilityCodeListProvider": "BIC"
},
"portOfDischarge": {
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT",
"facilityCode": "CMIT",
"facilityCodeListProvider": "SMDG"
},
"placeOfReceipt": {
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"placeOfDelivery": {
"locationName": "CAN THO",
"unLocationCode": "VNVCA"
},
"serviceType": "PORT_TO_DOOR",
"etd": "2026-07-28T12:15:00Z",
"eta": "2026-10-01T01:00:00Z",
"references": {
"customer_name": "",
"string_ref1": "",
"string_ref2": "",
"string_ref3": "",
"string_ref4": "",
"string_ref5": "",
"string_ref6": "",
"string_ref7": "",
"string_ref8": "",
"cargo_ready_dt": null,
"si_cutoff_dt": null,
"vgm_cutoff_dt": null,
"booking_dt": "2026-07-15T16:36:27Z",
"date_ref1": null,
"date_ref2": null,
"date_ref3": null,
"date_ref4": null
},
"shipmentEvents": [
{
"eventID": "9714eff8-9043-44f0-a6dc-14327f12e532",
"eventType": "SHIPMENT",
"documentID": "29402735",
"eventDateTime": "2026-07-15T16:36:27Z",
"documentTypeCode": "BKG",
"documentReferences": [
{
"documentReferenceType": "BKG",
"documentReferenceValue": "29402735"
}
],
"eventClassifierCode": "ACT",
"eventCreatedDateTime": "2026-07-15T16:36:27Z",
"shipmentEventTypeCode": "CONF"
},
{
"eventID": "017fbbf7-1b7f-4024-8c35-26d66139e97e",
"eventType": "SHIPMENT",
"documentID": "HLCUBSC2606CBSF8",
"eventDateTime": "2026-07-22T16:12:26Z",
"documentTypeCode": "TRD",
"documentReferences": [
{
"documentReferenceType": "BKG",
"documentReferenceValue": "29402735"
}
],
"eventClassifierCode": "ACT",
"eventCreatedDateTime": "2026-07-22T16:12:26Z",
"shipmentEventTypeCode": "ISSU"
}
],
"transportEvents": [
{
"eventID": "a77e8aff-613a-4534-8233-025bd983412d",
"eventType": "TRANSPORT",
"eventDateTime": "2026-07-28T12:15:00Z",
"transportCall": {
"vessel": {
"vesselName": "ULSAN EXPRESS",
"vesselIMONumber": "9613020"
},
"location": {
"address": {
"name": "APM TERMINALS"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"facilityCode": "HGMQ",
"unLocationCode": "USNYC",
"modeOfTransport": "VESSEL",
"facilityTypeCode": "POTE",
"exportVoyageNumber": "631W",
"facilityCodeListProvider": "BIC",
"transportCallSequenceNumber": 1
},
"documentReferences": [
{
"documentReferenceType": "BKG",
"documentReferenceValue": "29402735"
}
],
"eventClassifierCode": "ACT",
"eventCreatedDateTime": "2026-07-28T18:03:43Z",
"transportEventTypeCode": "DEPA"
},
{
"eventID": "5d06372d-1f66-48f9-882c-45802b9a9225",
"eventType": "TRANSPORT",
"eventDateTime": "2026-10-01T01:00:00Z",
"transportCall": {
"vessel": {
"vesselName": "ULSAN EXPRESS",
"vesselIMONumber": "9613020"
},
"location": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"facilityCode": "CMIT",
"unLocationCode": "VNVUT",
"modeOfTransport": "VESSEL",
"facilityTypeCode": "POTE",
"importVoyageNumber": "631W",
"facilityCodeListProvider": "SMDG",
"transportCallSequenceNumber": 2
},
"documentReferences": [
{
"documentReferenceType": "BKG",
"documentReferenceValue": "29402735"
}
],
"eventClassifierCode": "PLN",
"eventCreatedDateTime": "2026-07-24T22:20:07Z",
"transportEventTypeCode": "ARRI"
}
],
"containers": [
{
"containerNumber": "HAMU4486106",
"isoType": "45GP",
"references": {
"customer_name": "",
"string_ref1": "",
"string_ref2": "",
"string_ref3": "",
"string_ref4": "",
"string_ref5": "",
"string_ref6": "",
"string_ref7": "",
"string_ref8": "",
"stuffing_dt": null,
"free_time_exp_dt": null,
"date_ref1": null,
"date_ref2": null,
"date_ref3": null,
"date_ref4": null,
"date_ref5": null,
"date_ref6": null
},
"latestEvent": {
"eventID": "9d68e872-5eed-4430-8f89-960d266164d0",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-10-03T17:00:00Z",
"eventLocation": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"transportCall": {
"location": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"facilityCode": "CMIT",
"unLocationCode": "VNVUT",
"modeOfTransport": "BARGE",
"facilityTypeCode": "POTE",
"facilityCodeListProvider": "SMDG",
"transportCallSequenceNumber": 2
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "PLN",
"eventCreatedDateTime": "2026-07-22T11:42:03Z",
"equipmentEventTypeCode": "GTOT"
},
"eventHistory": [
{
"eventID": "766297e9-7f1b-4f66-926c-d60b3f43f8dc",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-07-22T16:05:00Z",
"eventLocation": {
"address": {
"name": "STTURN - NEW YORK, NY"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"transportCall": {
"location": {
"address": {
"name": "STTURN - NEW YORK, NY"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"unLocationCode": "USNYC",
"modeOfTransport": "TRUCK",
"facilityTypeCode": "DEPO",
"transportCallSequenceNumber": 0
},
"emptyIndicatorCode": "EMPTY",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "ACT",
"eventCreatedDateTime": "2026-07-22T11:42:30Z",
"equipmentEventTypeCode": "GTOT"
},
{
"eventID": "706a646b-eac0-4ad9-b4d5-68bf7748b818",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-07-22T18:30:00Z",
"eventLocation": {
"address": {
"name": "APM TERMINALS"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"transportCall": {
"location": {
"address": {
"name": "APM TERMINALS"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"facilityCode": "HGMQ",
"unLocationCode": "USNYC",
"modeOfTransport": "TRUCK",
"facilityTypeCode": "POTE",
"facilityCodeListProvider": "BIC",
"transportCallSequenceNumber": 1
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "ACT",
"eventCreatedDateTime": "2026-07-22T18:35:20Z",
"equipmentEventTypeCode": "GTIN"
},
{
"eventID": "35058e3c-213c-4688-9de0-7e30d64b880a",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-07-27T20:39:00Z",
"eventLocation": {
"address": {
"name": "APM TERMINALS"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"transportCall": {
"vessel": {
"vesselName": "ULSAN EXPRESS",
"vesselIMONumber": "9613020"
},
"location": {
"address": {
"name": "APM TERMINALS"
},
"locationName": "NEW YORK, NY",
"unLocationCode": "USNYC"
},
"facilityCode": "HGMQ",
"unLocationCode": "USNYC",
"modeOfTransport": "VESSEL",
"facilityTypeCode": "POTE",
"exportVoyageNumber": "631W",
"facilityCodeListProvider": "BIC",
"transportCallSequenceNumber": 1
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "ACT",
"eventCreatedDateTime": "2026-07-27T20:44:39Z",
"equipmentEventTypeCode": "LOAD"
},
{
"eventID": "d6dd9e45-76bd-408d-ab41-41833ae1050b",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-10-01T07:00:00Z",
"eventLocation": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"transportCall": {
"vessel": {
"vesselName": "ULSAN EXPRESS",
"vesselIMONumber": "9613020"
},
"location": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"facilityCode": "CMIT",
"unLocationCode": "VNVUT",
"modeOfTransport": "VESSEL",
"facilityTypeCode": "POTE",
"importVoyageNumber": "631W",
"facilityCodeListProvider": "SMDG",
"transportCallSequenceNumber": 2
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "PLN",
"eventCreatedDateTime": "2026-07-22T11:42:03Z",
"equipmentEventTypeCode": "DISC"
},
{
"eventID": "9d68e872-5eed-4430-8f89-960d266164d0",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-10-03T17:00:00Z",
"eventLocation": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"transportCall": {
"location": {
"address": {
"name": "CMIT (CAIMEP INTERNATION TERMINAL)"
},
"locationName": "VUNG TAU",
"unLocationCode": "VNVUT"
},
"facilityCode": "CMIT",
"unLocationCode": "VNVUT",
"modeOfTransport": "BARGE",
"facilityTypeCode": "POTE",
"facilityCodeListProvider": "SMDG",
"transportCallSequenceNumber": 2
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "PLN",
"eventCreatedDateTime": "2026-07-22T11:42:03Z",
"equipmentEventTypeCode": "GTOT"
},
{
"eventID": "dd68b098-f695-4ad7-9f8b-c2272c73c994",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-10-04T17:00:00Z",
"eventLocation": {
"locationName": "CAN THO",
"unLocationCode": "VNVCA"
},
"transportCall": {
"location": {
"locationName": "CAN THO",
"unLocationCode": "VNVCA"
},
"unLocationCode": "VNVCA",
"modeOfTransport": "BARGE",
"facilityTypeCode": "INTE",
"transportCallSequenceNumber": 3
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "PLN",
"eventCreatedDateTime": "2026-07-22T11:42:03Z",
"equipmentEventTypeCode": "GTIN"
},
{
"eventID": "837a822f-fd26-49c4-8745-e66f955d144f",
"eventType": "EQUIPMENT",
"eventDateTime": "2026-10-04T17:00:00Z",
"eventLocation": {
"locationName": "CAN THO",
"unLocationCode": "VNVCA"
},
"transportCall": {
"location": {
"locationName": "CAN THO",
"unLocationCode": "VNVCA"
},
"unLocationCode": "VNVCA",
"modeOfTransport": "TRUCK",
"facilityTypeCode": "INTE",
"transportCallSequenceNumber": 3
},
"emptyIndicatorCode": "LADEN",
"equipmentReference": "HAMU4486106",
"eventClassifierCode": "PLN",
"eventCreatedDateTime": "2026-07-22T11:42:03Z",
"equipmentEventTypeCode": "GTOT"
}
]
}
]
}
}Modified at 2026-09-03 20:23:39