A trace only orchestration can be initiated to start retreiving information about the container without an appointment being requested. With the orchestration being active, it can be updated to start searching for an appointment.
Request:
POST /v1/orchestrations
{
"order": [
{
"trade_type": "I",
"unit": {
"unit_nbr": "ABCD1234567"
},
"locations": [
{
"port_cd": "PORT"
}
]
}
]
}Response:
{
"data": [
{
"success": true,
"unit_nbr": "ABCD1234567",
"messages": [
{
"message_cd": "10007",
"message_txt": "Missing Guarantee Through Date",
"message_severity_cd": "2"
},
{
"message_cd": "10000",
"message_txt": "Orchestration created successfully",
"message_severity_cd": "I"
}
]
}
]
}"Missing Guarantee Through Date": this warning can be ignored if the integrator is not intending to pay fees through the orchestration.
The orchestration request was created successfully. After a few seconds, the first notifiction is available:
{
"orchestration_request": {
"container_nbr": "ABCD1234567",
"trade_type": "I",
"notification_type": [],
"sections_updated": [
"orchestration_status"
]
},
"orchestration_status": {
"status": "ACTIVE",
"submitted_dttm": "2025-01-27T20:03:50.1470000",
"initiated_dttm": "2025-01-27T20:04:01.7900000",
"ended_dttm": null,
"messages": [
{
"message_cd": "10007",
"message_txt": "Missing Guarantee Through Date",
"message_severity_cd": "W"
},
{
"message_cd": "10015",
"message_txt": "Non-matching Bill of Lading",
"message_severity_cd": "W"
}
]
},
"unit_status": {
...
}
}A new warning shows up "Non-matching bill of lading". This means the integrator did not provide a BOL matching SprintPass Pro's database. To create an appoitment, some terminals require a gate code to be provided upfront. The gate code needs to match some digits of the BOL.
The 'pin_nbr' field should be filled with values according to the following table:
| Terminal code | Pin number requirements |
|---|---|
| ITS | last 5 digits of the BOL |
| TTI | last 4 digits of the BOL |
| ETSLAX | last 4 digits of the BOL |
Request:
At this point, the integrator needs to know the bill of lading in order to provide the pin number. Assuming this container's BOL is BOL12345 and the terminal requires a 4-digit gate code, the following request will create a full confirmed first available reservation.
PATCH /v1/orchestrations/trade-type/I/unit-nbr/ABCD1234567/locatoins/O
{
"reservation_details": {
"pin_nbr": "2345",
"reservation_preferences": {
"trylaterdates": "N",
"preference_datetimes": []
},
"trucker_info": {
"trucker_scac": "SCAC",
"lic_plate_nbr": "AA12345",
"lic_plate_state_cd": "CC",
"driver_fname": "J",
"driver_lname": "Doe"
}
}
}The usual notification sequence is:
{
"orchestration_request": {
"container_nbr": "ABCD1234567",
"trade_type": "I",
"notification_type": [
"Appointment"
],
"sections_updated": [
"orchestration_status",
"locations",
"activity"
]
},
"orchestration_status": {
"status": "ACTIVE",
"submitted_dttm": "2025-01-27T18:36:27.4470000",
"initiated_dttm": "2025-01-27T18:36:32.0270000",
"ended_dttm": null,
"messages": [
{
"message_cd": "10007",
"message_txt": "Missing Guarantee Through Date",
"message_severity_cd": "W"
},
{
"message_cd": "10015",
"message_txt": "Non-matching Bill of Lading",
"message_severity_cd": "W"
}
]
},
"unit_status": {
"unitinfo": {
"unit_cat": "CONTAINER",
"unit_nbr": "ABCD1234567",
"unittypeiso_cd": "40GP",
"unitsztype_cd": "40GP",
"ownerline_scac": "ABCD",
"ownerline_cd": "ABC",
"tare_wgt": null,
"tarewgt_unit": null,
"lastpretrip_dttm": null
},
"unitstatusinfo": {
"status_cd": "Y",
"status_desc": "IN YARD",
"unituse_cd": "I",
"unituse_desc": "IMPORT"
},
"locations": [
{
"port_cd": "PORT",
"port_nm": "Example port",
"facility_cd": "FCLT",
"facility_nm": "Example terminal",
"locationtype_cd": "O",
"guarantee_through_date": null,
"reservation_preferences": null,
"seq_nbr": "1",
"locationstatus_cd": "ACT",
"locationinfo": {
"arrivalinfo": {
"carriertype_cd": "VC",
"carriertype_desc": "VESSEL",
"vesselinfo": {
"vessel_cd": "12345678",
"voyage_nbr": "111A",
"vesseltype_cd": "Z",
"estarrival_dt": "",
"actarrival_dt": ""
},
"carrier_cd": "111A",
"appointment_info": null
},
"departureinfo": {
"carriertype_cd": "MC",
"carriertype_desc": "Motor Carrier",
"carrier_cd": null,
"appointment_info": {
"reservation_id": "e9501e62-378e-4fea-b629-8c2bb97df32d",
"reservation_status": "CONFIRMED",
"dual_status": null,
"ticket_nbr": "FCLT-1234-12345",
"gate_code": "",
"trucker_info": {
"trucker_scac": "SCAC",
"rfid_nbr": "",
"plate_nbr": "AA12345",
"company_nm": null
},
"driverinfo": {
"first_nm": "J",
"last_nm": "D"
},
"slot_info": {
"visit_dt": "2025-01-28",
"visitstart_tm": "15:00",
"visitend_tm": "16:00"
},
"units": [
{
"move": "IP",
"dual_type": null,
"unit_nbr": "MPRU0000190",
"unit_category": "CONTAINER",
"line_scac": "CDMU",
"sztype_iso": "40GP",
"sztype_cd": "40GP",
"yard_spot": "A1",
"seal_nbrs": [],
"spcl_instructions": [
{
"instructions": ""
}
]
}
]
}
},
"cargoinfo": {
"bol_nbr": "",
"reefer_flg": "N",
"temp_min": null,
"mintemp_uom": null,
"temp_max": "",
"maxtemp_uom": null,
"hazmat_flg": "N",
"imoclass_cd": null,
"od_flg": "Y",
"seal_nbr": null,
"bcocompany_name": null,
"userline_scac": null
},
"currentconditioninfo": {
"damaged_flg": null,
"yard_loc": "A1",
"block_nbr": null,
"supply_temp": null,
"return_temp": null,
"set_temp": null,
"fullempty_cd": "FULL",
"gross_wgt": null,
"grosswgt_unit": null,
"actual_wgt": null,
"actualwgt_unit": null,
"chassis_nbr": null
}
}
}
],
"holdinfo": [],
"fee_receipts": null,
"lfdinfo": {
"good_through_date": "2025-02-03",
"last_free_day": "2025-02-03"
},
"activity": [
{
"seq_nbr": "1",
"event_cd": "CNMAN",
"event_desc": "Container Manifested",
"event_dttm": "2025-01-26T16:10:00.0000000",
"facility_cd": "ETSLAX",
"facility_nm": "Everport Terminal Services - Los Angeles"
},
{
"seq_nbr": "2",
"event_cd": "DISCH",
"event_desc": "Discharged",
"event_dttm": null,
"facility_cd": null,
"facility_nm": null
},
{
"seq_nbr": "3",
"event_cd": "LFDAY",
"event_desc": "Last Free Day",
"event_dttm": "2025-02-03T23:59:00.0000000",
"facility_cd": "ETSLAX",
"facility_nm": "Everport Terminal Services - Los Angeles"
},
{
"seq_nbr": "4",
"event_cd": "PLAVI",
"event_desc": "Ready for pick up",
"event_dttm": "2025-01-26T16:10:00.0000000",
"facility_cd": "ETSLAX",
"facility_nm": "Everport Terminal Services - Los Angeles"
},
{
"seq_nbr": "5",
"event_cd": "APNMT",
"event_desc": "Pregate",
"event_dttm": "2025-01-28T15:00:00.0000000",
"facility_cd": "ETSLAX",
"facility_nm": "Everport Terminal Services - Los Angeles"
},
{
"seq_nbr": "6",
"event_cd": "DPTRM",
"event_desc": "Departed Terminal",
"event_dttm": null,
"facility_cd": null,
"facility_nm": null
},
{
"seq_nbr": "9",
"event_cd": "ARCUS",
"event_desc": "Arrived at customer",
"event_dttm": null,
"facility_cd": null,
"facility_nm": null
},
{
"seq_nbr": "10",
"event_cd": "EMTOT",
"event_desc": "Empty released by customer",
"event_dttm": null,
"facility_cd": null,
"facility_nm": null
},
{
"seq_nbr": "11",
"event_cd": "EMTRC",
"event_desc": "Empty Received",
"event_dttm": null,
"facility_cd": null,
"facility_nm": null
}
]
}
}