project44

App · 19 actions

Track shipments across ocean, air, truckload, LTL, parcel and rail in project44: start tracking by bill of lading, container or tracking number, read events, ETAs, positions and exceptions, search and count shipments, manage attributes and stop locations, and start workflows when shipments move, change state or hit an exception.

Actions

ActionWhat it does
Count shipmentsCount the shipments that match a search, such as everything in transit by ocean or held in customs.
Create stop locationSave a pickup or delivery location, such as a warehouse, to your organization's address book.
Create truckload shipmentStart tracking a full truckload shipment with a carrier in your project44 network, from its pickup to its delivery.
Define attribute nameDefine a new attribute name shipments can carry, such as Customer.
Delete shipmentStop tracking a shipment and delete it from project44.
Delete truckload shipmentStop tracking a truckload shipment and delete it from project44.
Get shipmentGet a shipment with its identifiers, attributes, share link, stops and the legs between them.
Get shipment attributesGet the custom attributes set on a shipment.
Get shipment eventsGet a shipment's events (milestones such as departed, arrived and delivered) with actual, planned and estimated times, its states and its exceptions, without its positions.
Get shipment positionsGet where a shipment has been, as dated latitudes and longitudes.
Get stop locationGet a saved stop location with its address and coordinates.
Get tracking historyGet everything project44 knows about a shipment's journey: its events with actual and estimated times (ETAs), the states it has been in, its exceptions and its positions.
Get truckload shipmentGet a truckload shipment as it was created, with its carrier, stops and equipment, and its shipment id for the tracking steps.
List attribute namesList the attribute names your organization has defined for shipments.
List stop locationsList your organization's saved pickup and delivery locations.
Search shipmentsFind shipments by identifier, text, mode, current state, attribute or date, with each one's state, carrier, origin, destination, last position and exceptions.
Set shipment attributesSet custom attributes, such as a customer or a lane, on a shipment project44 tracks.
Track shipmentStart tracking an ocean, air, LTL, parcel or rail shipment by its bill of lading, container, booking, PRO, tracking number or other identifier.
Update stop locationChange a saved stop location's name, address, coordinates or your id for it.

Count shipments

Count the shipments that match a search, such as everything in transit by ocean or held in customs.

Inputs

Search textsearch_texttext
Finds shipments whose identifiers, carrier or places contain this text.
Identifier typeidentifier_typetext
What the identifier value is. Leave empty to match the value in any identifier.One of: BILL_OF_LADING (Bill of lading), BOOKING_NUMBER (Booking number), CONTAINER_ID (Container number), HOUSE_BILL_OF_LADING (House bill of lading), AIR_WAYBILL (Air waybill), HOUSE_AIR_WAYBILL (House air waybill), TRACKING_NUMBER (Tracking number), PRO (PRO number), PICKUP (Pickup number), PURCHASE_ORDER (Purchase order), and 10 more.
Identifier valueidentifier_valuetext
A bill of lading, container, PRO or other identifier to find.
Modetransportation_modetext
Only shipments of this mode.One of: TRUCKLOAD, LTL (LTL (less than truckload)), PARCEL, OCEAN, AIR, RAIL, BARGE.
Current statecurrent_statetext
Only shipments in this state now.One of: SCHEDULED, IN_TRANSIT (In transit), IN_TRANSIT_VESSEL (In transit on a vessel), IN_TRANSIT_AIRCRAFT (In transit on an aircraft), IN_TRANSIT_RAIL (In transit by rail), AT_STOP (At a stop), IDLE, CUSTOMS_HOLD (Held in customs), ACTION_REQUIRED (Action required), COMPLETED.
Attributeattribute_nametext
Only shipments with this attribute.
Attribute valueattribute_valuetext
Only shipments whose attribute has this value. Leave empty for any value.
Date to filter ondate_typetext
Which of the shipment's dates the From and To times are about.One of: CREATED_DATE_TIME (Created), LAST_MODIFIED_DATE_TIME (Last updated), COMPLETED_DATE_TIME (Completed). Default: LAST_MODIFIED_DATE_TIME.
Fromfrom_timedate and time
Only shipments whose chosen date is at or after this time.
Toto_timedate and time
Only shipments whose chosen date is at or before this time.

Outputs

totalnumber
How many shipments match
Example output
{
  "total": 42
}

Create stop location

Save a pickup or delivery location, such as a warehouse, to your organization's address book. Give the street address with its city and its state or postal code, or the latitude and longitude. project44 can't delete a stop location.

Inputs

NamenametextRequired
The location's name, such as Chicago warehouse.
Street addressaddresstext
The street and number.
Address line 2address_line_2text
A suite, unit or building, if any.
Citycitytext
The city.
Statestatetext
The state or province code, such as IL.
Postal codepostal_codetext
The ZIP or postal code.
Countrycountrytext
The two-letter country code, such as US. Defaults to US.
Latitudelatitudenumber
Where it is, with the longitude, if the address isn't enough.From -90 to 90.
Longitudelongitudenumber
Where it is, with the latitude.From -180 to 180.
Your location IDsupplied_idtext
Your own code for the location, such as its id in your TMS.

Outputs

stop_locationobject
The stop location
Example output
{
  "stop_location": {
    "address": {
      "addressLines": [
        "1200 W Fulton Market"
      ],
      "city": "Chicago",
      "country": "US",
      "postalCode": "60607",
      "state": "IL"
    },
    "addressSpecificity": "HOUSE_NUMBER",
    "coordinates": {
      "latitude": 41.8867,
      "longitude": -87.6596
    },
    "id": "f4b5c6d7-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
    "name": "Chicago warehouse",
    "suppliedId": "WH-CHI-01",
    "version": 1
  }
}

Create truckload shipment

Start tracking a full truckload shipment with a carrier in your project44 network, from its pickup to its delivery. A driver's phone number given as the equipment gets a text from project44 asking to share their location.

Inputs

Carrier identifier typecarrier_id_typetext
How the carrier is identified. Defaults to SCAC.One of: SCAC, DOT_NUMBER (US DOT number), MC_NUMBER (MC number), P44_EU (project44 EU carrier id), P44_GLOBAL (project44 global carrier id), SYSTEM (project44 system id), VAT (VAT number). Default: SCAC.
Carriercarrier_idtextRequired
The carrier's SCAC (or the identifier chosen).
Shipment identifier typeshipment_id_typetext
Bill of lading or order number. Defaults to bill of lading.One of: BILL_OF_LADING (Bill of lading), ORDER (Order number). Default: BILL_OF_LADING.
Bill of lading or order numbershipment_numbertextRequired
The shipment's number, unique for this carrier.
Pickup companyorigin_nametext
The company at the pickup.
Pickup street addressorigin_addresstext
The pickup's street and number.
Pickup cityorigin_citytextRequired
The pickup's city.
Pickup stateorigin_statetext
The pickup's state or province code, such as IL. Needed in the US, Canada and Mexico.
Pickup postal codeorigin_postal_codetextRequired
The pickup's ZIP or postal code.
Pickup countryorigin_countrytext
The two-letter country code, such as US. Defaults to US.
Pickup time zoneorigin_time_zonetext
The pickup's time zone, such as America/Chicago, which the pickup window is kept in. Defaults to UTC.
Pickup window openspickup_startdate and timeRequired
When the pickup appointment window opens.
Pickup window closespickup_enddate and timeRequired
When the pickup appointment window closes.
Delivery companydestination_nametext
The company at the delivery.
Delivery street addressdestination_addresstext
The delivery's street and number.
Delivery citydestination_citytextRequired
The delivery's city.
Delivery statedestination_statetext
The delivery's state or province code, such as IL. Needed in the US, Canada and Mexico.
Delivery postal codedestination_postal_codetextRequired
The delivery's ZIP or postal code.
Delivery countrydestination_countrytext
The two-letter country code, such as US. Defaults to US.
Delivery time zonedestination_time_zonetext
The delivery's time zone, such as America/Chicago, which the delivery window is kept in. Defaults to UTC.
Delivery window opensdelivery_startdate and timeRequired
When the delivery appointment window opens.
Delivery window closesdelivery_enddate and timeRequired
When the delivery appointment window closes.
Equipment typeequipment_typetext
What the equipment identifier is. Defaults to vehicle (truck) number.One of: MOBILE_PHONE_NUMBER (Driver's mobile phone number), VEHICLE_ID (Vehicle (truck) number), LICENSE_PLATE (License plate), SENSITECH_DEVICE_ID (Sensitech device id), TIVE_DEVICE_ID (Tive device id). Default: VEHICLE_ID.
Equipment identifierequipment_idtext
The truck number, license plate, driver's phone or device to track. Most carriers need one.
Attributesattributesobject
A value for any of your organization's attribute names, such as a customer or a lane. Names are defined in project44 first (see 'Define attribute name').

Outputs

info_messageslist
Warnings and notes from project44
shipmentobject
The truckload shipment
shipment_idtext
Its project44 shipment id, for the tracking steps (empty until project44 gives one)
truckload_shipment_idnumber
The truckload shipment's number, for the truckload steps
Example output
{
  "info_messages": [
    {
      "diagnostic": "",
      "message": "Tracking will start when the pickup window opens.",
      "severity": "INFO",
      "source": "SYSTEM"
    }
  ],
  "shipment": {
    "attributes": [],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "ABCD"
    },
    "equipmentIdentifiers": [
      {
        "type": "VEHICLE_ID",
        "value": "TRK-118"
      }
    ],
    "id": 2401881,
    "masterShipmentId": "758ff08b-2693-4308-bf22-b967623ffeea",
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "BOL-20260824-1"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2026-08-24T12:00:00",
          "localTimeZoneIdentifier": "America/Chicago",
          "startDateTime": "2026-08-24T08:00:00"
        },
        "location": {
          "address": {
            "addressLines": [
              "1200 W Fulton Market"
            ],
            "city": "Chicago",
            "country": "US",
            "postalCode": "60607",
            "state": "IL"
          },
          "contact": {
            "companyName": "Acme Foods"
          }
        },
        "stopNumber": 1,
        "stopType": "PICKUP"
      }
    ]
  },
  "shipment_id": "758ff08b-2693-4308-bf22-b967623ffeea",
  "truckload_shipment_id": 2401881
}

Define attribute name

Define a new attribute name shipments can carry, such as Customer. Needs a client application with the Administrator box checked; project44 can't delete a name once defined.

Inputs

NamenametextRequired
The attribute's name, unique in your organization.

Outputs

info_messageslist
Notes from project44
nametext
The name defined
Example output
{
  "info_messages": [],
  "name": "Customer"
}

Delete shipment

Stop tracking a shipment and delete it from project44. Shipments another organization shares with you can't be deleted.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

Outputs

deletedtrue/false
True once project44 deleted it
shipment_idtext
The shipment deleted
Example output
{
  "deleted": true,
  "shipment_id": "758ff08b-2693-4308-bf22-b967623ffeea"
}

Delete truckload shipment

Stop tracking a truckload shipment and delete it from project44.

Inputs

Truckload shipment numbertruckload_shipment_idnumberRequired
The truckload shipment's project44 number, from 'Create truckload shipment', like 2401881.At least 1.

Outputs

deletedtrue/false
True once project44 deleted it
truckload_shipment_idnumber
The truckload shipment deleted
Example output
{
  "deleted": true,
  "truckload_shipment_id": 2401881
}

Get shipment

Get a shipment with its identifiers, attributes, share link, stops and the legs between them.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

Outputs

shipmentobject
The shipment, with its stops and route
Example output
{
  "shipment": {
    "attributes": [
      {
        "name": "Customer",
        "values": [
          "Acme Foods"
        ]
      }
    ],
    "createdDateTime": "2026-08-24T14:15:22Z",
    "id": "758ff08b-2693-4308-bf22-b967623ffeea",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "MAEU"
      }
    ],
    "lastModifiedDateTime": "2026-08-25T09:02:10Z",
    "routeInfo": {
      "routeSegments": [
        {
          "fromStopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "id": "9810cab9-ab32-3871-b392-768aba8ea330",
          "identifiers": [
            {
              "type": "VESSEL_IMO",
              "value": "9778791"
            }
          ],
          "toStopId": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "transportationMode": "OCEAN"
        }
      ],
      "stops": [
        {
          "id": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Ningbo",
              "country": "CN",
              "postalCode": "",
              "state": ""
            },
            "coordinates": {
              "latitude": 29.87,
              "longitude": 121.55
            },
            "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "CNNGB"
              }
            ],
            "name": "Ningbo",
            "timeZone": "Asia/Shanghai"
          },
          "type": "ORIGIN"
        },
        {
          "id": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Los Angeles",
              "country": "US",
              "postalCode": "",
              "state": "CA"
            },
            "coordinates": {
              "latitude": 33.74,
              "longitude": -118.26
            },
            "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "USLAX"
              }
            ],
            "name": "Los Angeles",
            "timeZone": "America/Los_Angeles"
          },
          "type": "DESTINATION"
        }
      ]
    },
    "shipmentShareLink": "https://movement.project44.com/share/062a51cc-0000-0000-ba16-734650344d4d"
  }
}

Get shipment attributes

Get the custom attributes set on a shipment.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

Outputs

attributeslist
The shipment's attributes
Example output
{
  "attributes": [
    {
      "attributeName": "Customer",
      "attributeValues": [
        "Acme Foods"
      ]
    }
  ]
}

Get shipment events

Get a shipment's events (milestones such as departed, arrived and delivered) with actual, planned and estimated times, its states and its exceptions, without its positions.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.
Include stops and routeinclude_routetrue/false
Also get the shipment's stops and the legs between them.Default: false.

Outputs

eventslist
Its events, done and expected
exceptionslist
Its exceptions
shipmentobject
The shipment
stateslist
The states it has been in
Example output
{
  "events": [
    {
      "dateTime": "2026-08-26T03:10:00Z",
      "description": "Vessel departed the port of loading.",
      "estimateDateTime": "",
      "id": "a76f6a37-5485-47eb-9220-882b92029cee",
      "plannedDateTime": "2026-08-26T00:00:00Z",
      "plannedEndDateTime": "",
      "receivedDateTime": "2026-08-26T03:12:41Z",
      "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330",
      "stopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
      "type": "DEPARTURE_FROM_STOP"
    }
  ],
  "exceptions": [
    {
      "category": "RUNNING_LATE",
      "definitionId": "36fdbaf6-8ac7-49c0-92db-b7c12527f452",
      "namespace": "P44_DETECTED",
      "reason": "CONTAINER_ROLLED",
      "status": "ACTIVE",
      "transportationMode": "OCEAN"
    }
  ],
  "shipment": {
    "attributes": [
      {
        "name": "Customer",
        "values": [
          "Acme Foods"
        ]
      }
    ],
    "createdDateTime": "2026-08-24T14:15:22Z",
    "id": "758ff08b-2693-4308-bf22-b967623ffeea",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "MAEU"
      }
    ],
    "lastModifiedDateTime": "2026-08-25T09:02:10Z",
    "routeInfo": {
      "routeSegments": [
        {
          "fromStopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "id": "9810cab9-ab32-3871-b392-768aba8ea330",
          "identifiers": [
            {
              "type": "VESSEL_IMO",
              "value": "9778791"
            }
          ],
          "toStopId": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "transportationMode": "OCEAN"
        }
      ],
      "stops": [
        {
          "id": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Ningbo",
              "country": "CN",
              "postalCode": "",
              "state": ""
            },
            "coordinates": {
              "latitude": 29.87,
              "longitude": 121.55
            },
            "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "CNNGB"
              }
            ],
            "name": "Ningbo",
            "timeZone": "Asia/Shanghai"
          },
          "type": "ORIGIN"
        },
        {
          "id": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Los Angeles",
              "country": "US",
              "postalCode": "",
              "state": "CA"
            },
            "coordinates": {
              "latitude": 33.74,
              "longitude": -118.26
            },
            "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "USLAX"
              }
            ],
            "name": "Los Angeles",
            "timeZone": "America/Los_Angeles"
          },
          "type": "DESTINATION"
        }
      ]
    },
    "shipmentShareLink": "https://movement.project44.com/share/062a51cc-0000-0000-ba16-734650344d4d"
  },
  "states": [
    {
      "endDateTime": "",
      "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330",
      "startDateTime": "2026-08-26T03:10:00Z",
      "stopId": "",
      "type": "IN_TRANSIT_VESSEL"
    }
  ]
}

Get shipment positions

Get where a shipment has been, as dated latitudes and longitudes.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.
Include stops and routeinclude_routetrue/false
Also get the shipment's stops and the legs between them.Default: false.

Outputs

positionslist
Where it has been, oldest first
shipmentobject
The shipment
Example output
{
  "positions": [
    {
      "dateTime": "2026-08-27T12:00:00Z",
      "latitude": 30.12,
      "longitude": 135.4,
      "receivedDateTime": "2026-08-27T12:04:00Z",
      "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330"
    }
  ],
  "shipment": {
    "attributes": [
      {
        "name": "Customer",
        "values": [
          "Acme Foods"
        ]
      }
    ],
    "createdDateTime": "2026-08-24T14:15:22Z",
    "id": "758ff08b-2693-4308-bf22-b967623ffeea",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "MAEU"
      }
    ],
    "lastModifiedDateTime": "2026-08-25T09:02:10Z",
    "routeInfo": {
      "routeSegments": [
        {
          "fromStopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "id": "9810cab9-ab32-3871-b392-768aba8ea330",
          "identifiers": [
            {
              "type": "VESSEL_IMO",
              "value": "9778791"
            }
          ],
          "toStopId": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "transportationMode": "OCEAN"
        }
      ],
      "stops": [
        {
          "id": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Ningbo",
              "country": "CN",
              "postalCode": "",
              "state": ""
            },
            "coordinates": {
              "latitude": 29.87,
              "longitude": 121.55
            },
            "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "CNNGB"
              }
            ],
            "name": "Ningbo",
            "timeZone": "Asia/Shanghai"
          },
          "type": "ORIGIN"
        },
        {
          "id": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Los Angeles",
              "country": "US",
              "postalCode": "",
              "state": "CA"
            },
            "coordinates": {
              "latitude": 33.74,
              "longitude": -118.26
            },
            "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "USLAX"
              }
            ],
            "name": "Los Angeles",
            "timeZone": "America/Los_Angeles"
          },
          "type": "DESTINATION"
        }
      ]
    },
    "shipmentShareLink": "https://movement.project44.com/share/062a51cc-0000-0000-ba16-734650344d4d"
  }
}

Get stop location

Get a saved stop location with its address and coordinates.

Inputs

Stop locationstop_location_idtextRequired
The stop location. Pick one, or give its project44 id.

Outputs

stop_locationobject
The stop location
Example output
{
  "stop_location": {
    "address": {
      "addressLines": [
        "1200 W Fulton Market"
      ],
      "city": "Chicago",
      "country": "US",
      "postalCode": "60607",
      "state": "IL"
    },
    "addressSpecificity": "HOUSE_NUMBER",
    "coordinates": {
      "latitude": 41.8867,
      "longitude": -87.6596
    },
    "id": "f4b5c6d7-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
    "name": "Chicago warehouse",
    "suppliedId": "WH-CHI-01",
    "version": 1
  }
}

Get tracking history

Get everything project44 knows about a shipment's journey: its events with actual and estimated times (ETAs), the states it has been in, its exceptions and its positions.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

Outputs

eventslist
Its events, done and expected
exceptionslist
Its exceptions
positionslist
Where it has been
shipmentobject
The shipment
stateslist
The states it has been in
Example output
{
  "events": [
    {
      "dateTime": "2026-08-26T03:10:00Z",
      "description": "Vessel departed the port of loading.",
      "estimateDateTime": "",
      "id": "a76f6a37-5485-47eb-9220-882b92029cee",
      "plannedDateTime": "2026-08-26T00:00:00Z",
      "plannedEndDateTime": "",
      "receivedDateTime": "2026-08-26T03:12:41Z",
      "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330",
      "stopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
      "type": "DEPARTURE_FROM_STOP"
    }
  ],
  "exceptions": [
    {
      "category": "RUNNING_LATE",
      "definitionId": "36fdbaf6-8ac7-49c0-92db-b7c12527f452",
      "namespace": "P44_DETECTED",
      "reason": "CONTAINER_ROLLED",
      "status": "ACTIVE",
      "transportationMode": "OCEAN"
    }
  ],
  "positions": [
    {
      "dateTime": "2026-08-27T12:00:00Z",
      "latitude": 30.12,
      "longitude": 135.4,
      "receivedDateTime": "2026-08-27T12:04:00Z",
      "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330"
    }
  ],
  "shipment": {
    "attributes": [
      {
        "name": "Customer",
        "values": [
          "Acme Foods"
        ]
      }
    ],
    "createdDateTime": "2026-08-24T14:15:22Z",
    "id": "758ff08b-2693-4308-bf22-b967623ffeea",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "MAEU"
      }
    ],
    "lastModifiedDateTime": "2026-08-25T09:02:10Z",
    "routeInfo": {
      "routeSegments": [
        {
          "fromStopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "id": "9810cab9-ab32-3871-b392-768aba8ea330",
          "identifiers": [
            {
              "type": "VESSEL_IMO",
              "value": "9778791"
            }
          ],
          "toStopId": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "transportationMode": "OCEAN"
        }
      ],
      "stops": [
        {
          "id": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Ningbo",
              "country": "CN",
              "postalCode": "",
              "state": ""
            },
            "coordinates": {
              "latitude": 29.87,
              "longitude": 121.55
            },
            "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "CNNGB"
              }
            ],
            "name": "Ningbo",
            "timeZone": "Asia/Shanghai"
          },
          "type": "ORIGIN"
        },
        {
          "id": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Los Angeles",
              "country": "US",
              "postalCode": "",
              "state": "CA"
            },
            "coordinates": {
              "latitude": 33.74,
              "longitude": -118.26
            },
            "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "USLAX"
              }
            ],
            "name": "Los Angeles",
            "timeZone": "America/Los_Angeles"
          },
          "type": "DESTINATION"
        }
      ]
    },
    "shipmentShareLink": "https://movement.project44.com/share/062a51cc-0000-0000-ba16-734650344d4d"
  },
  "states": [
    {
      "endDateTime": "",
      "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330",
      "startDateTime": "2026-08-26T03:10:00Z",
      "stopId": "",
      "type": "IN_TRANSIT_VESSEL"
    }
  ]
}

Get truckload shipment

Get a truckload shipment as it was created, with its carrier, stops and equipment, and its shipment id for the tracking steps.

Inputs

Truckload shipment numbertruckload_shipment_idnumberRequired
The truckload shipment's project44 number, from 'Create truckload shipment', like 2401881.At least 1.

Outputs

shipmentobject
The truckload shipment
shipment_idtext
Its project44 shipment id, for the tracking steps (empty until project44 gives one)
truckload_shipment_idnumber
The truckload shipment's number, for the truckload steps
Example output
{
  "shipment": {
    "attributes": [],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "ABCD"
    },
    "equipmentIdentifiers": [
      {
        "type": "VEHICLE_ID",
        "value": "TRK-118"
      }
    ],
    "id": 2401881,
    "masterShipmentId": "758ff08b-2693-4308-bf22-b967623ffeea",
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "BOL-20260824-1"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2026-08-24T12:00:00",
          "localTimeZoneIdentifier": "America/Chicago",
          "startDateTime": "2026-08-24T08:00:00"
        },
        "location": {
          "address": {
            "addressLines": [
              "1200 W Fulton Market"
            ],
            "city": "Chicago",
            "country": "US",
            "postalCode": "60607",
            "state": "IL"
          },
          "contact": {
            "companyName": "Acme Foods"
          }
        },
        "stopNumber": 1,
        "stopType": "PICKUP"
      }
    ]
  },
  "shipment_id": "758ff08b-2693-4308-bf22-b967623ffeea",
  "truckload_shipment_id": 2401881
}

List attribute names

List the attribute names your organization has defined for shipments.

Inputs

None.

Outputs

attribute_definitionslist
The attribute names
Example output
{
  "attribute_definitions": [
    {
      "name": "Customer"
    },
    {
      "name": "Lane"
    }
  ]
}

List stop locations

List your organization's saved pickup and delivery locations. Gets one page; to see more, run it again with the next page number.

Inputs

Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 25.From 1 to 100.

Outputs

has_moretrue/false
Whether there's a next page
page_numbernumber
The page this is
page_sizenumber
How many a page holds
stop_locationslist
The stop locations on this page
totalnumber
How many there are in all
Example output
{
  "has_more": false,
  "page_number": 1,
  "page_size": 25,
  "stop_locations": [
    {
      "address": {
        "addressLines": [
          "1200 W Fulton Market"
        ],
        "city": "Chicago",
        "country": "US",
        "postalCode": "60607",
        "state": "IL"
      },
      "addressSpecificity": "HOUSE_NUMBER",
      "coordinates": {
        "latitude": 41.8867,
        "longitude": -87.6596
      },
      "id": "f4b5c6d7-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
      "name": "Chicago warehouse",
      "suppliedId": "WH-CHI-01",
      "version": 1
    }
  ],
  "total": 1
}

Search shipments

Find shipments by identifier, text, mode, current state, attribute or date, with each one's state, carrier, origin, destination, last position and exceptions. Gets one page; to see more, run it again with the next page number.

Inputs

Search textsearch_texttext
Finds shipments whose identifiers, carrier or places contain this text.
Identifier typeidentifier_typetext
What the identifier value is. Leave empty to match the value in any identifier.One of: BILL_OF_LADING (Bill of lading), BOOKING_NUMBER (Booking number), CONTAINER_ID (Container number), HOUSE_BILL_OF_LADING (House bill of lading), AIR_WAYBILL (Air waybill), HOUSE_AIR_WAYBILL (House air waybill), TRACKING_NUMBER (Tracking number), PRO (PRO number), PICKUP (Pickup number), PURCHASE_ORDER (Purchase order), and 10 more.
Identifier valueidentifier_valuetext
A bill of lading, container, PRO or other identifier to find.
Modetransportation_modetext
Only shipments of this mode.One of: TRUCKLOAD, LTL (LTL (less than truckload)), PARCEL, OCEAN, AIR, RAIL, BARGE.
Current statecurrent_statetext
Only shipments in this state now.One of: SCHEDULED, IN_TRANSIT (In transit), IN_TRANSIT_VESSEL (In transit on a vessel), IN_TRANSIT_AIRCRAFT (In transit on an aircraft), IN_TRANSIT_RAIL (In transit by rail), AT_STOP (At a stop), IDLE, CUSTOMS_HOLD (Held in customs), ACTION_REQUIRED (Action required), COMPLETED.
Attributeattribute_nametext
Only shipments with this attribute.
Attribute valueattribute_valuetext
Only shipments whose attribute has this value. Leave empty for any value.
Date to filter ondate_typetext
Which of the shipment's dates the From and To times are about.One of: CREATED_DATE_TIME (Created), LAST_MODIFIED_DATE_TIME (Last updated), COMPLETED_DATE_TIME (Completed). Default: LAST_MODIFIED_DATE_TIME.
Fromfrom_timedate and time
Only shipments whose chosen date is at or after this time.
Toto_timedate and time
Only shipments whose chosen date is at or before this time.
Sort bysort_bytext
The order to list them in.One of: UPDATED_DATETIME:DESC (Last updated, newest first), CREATED_DATETIME:DESC (Created, newest first), CREATED_DATETIME:ASC (Created, oldest first), ACT_OR_EST_DELIVERY_DATETIME:ASC (Delivery (actual or estimated), soonest first), ACT_OR_EST_DELIVERY_DATETIME:DESC (Delivery (actual or estimated), latest first), PLANNED_DELIVERY_DATETIME:ASC (Planned delivery, soonest first). Default: UPDATED_DATETIME:DESC.
Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 1,000. Defaults to 25.From 1 to 1000.

Outputs

page_numbernumber
The page this is
page_sizenumber
How many a page holds
shipmentslist
The shipments on this page
totalnumber
How many shipments match in all
Example output
{
  "page_number": 1,
  "page_size": 25,
  "shipments": [
    {
      "activeSegmentMode": "OCEAN",
      "allShipmentIdentifiers": [
        {
          "type": "BILL_OF_LADING",
          "value": "MAEU123456789"
        },
        {
          "type": "CARRIER_SCAC",
          "value": "MAEU"
        }
      ],
      "carrier": "Maersk",
      "completedDateTime": "",
      "createdDateTime": "2026-08-24T14:15:22Z",
      "currentState": "IN_TRANSIT_VESSEL",
      "customAttributes": [
        {
          "name": "Customer",
          "values": [
            "Acme Foods"
          ]
        }
      ],
      "destinationLocation": {
        "address": {
          "addressLines": [],
          "city": "Los Angeles",
          "country": "US",
          "postalCode": "",
          "state": "CA"
        },
        "coordinates": {
          "latitude": 33.74,
          "longitude": -118.26
        },
        "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
        "identifiers": [
          {
            "type": "PORT_UN_LOCODE",
            "value": "USLAX"
          }
        ],
        "name": "Los Angeles",
        "timeZone": "America/Los_Angeles"
      },
      "exceptions": [
        {
          "category": "RUNNING_LATE",
          "definitionId": "36fdbaf6-8ac7-49c0-92db-b7c12527f452",
          "namespace": "P44_DETECTED",
          "reason": "CONTAINER_ROLLED",
          "status": "ACTIVE",
          "transportationMode": "OCEAN"
        }
      ],
      "lastKnownPosition": {
        "dateTime": "2026-08-27T12:00:00Z",
        "latitude": 30.12,
        "longitude": 135.4,
        "receivedDateTime": "2026-08-27T12:04:00Z",
        "routeSegmentId": "9810cab9-ab32-3871-b392-768aba8ea330"
      },
      "latestTrackingStatusEvent": {
        "dateTime": "2026-08-24T14:20:00Z",
        "type": "TRACKING_START"
      },
      "originLocation": {
        "address": {
          "addressLines": [],
          "city": "Ningbo",
          "country": "CN",
          "postalCode": "",
          "state": ""
        },
        "coordinates": {
          "latitude": 29.87,
          "longitude": 121.55
        },
        "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
        "identifiers": [
          {
            "type": "PORT_UN_LOCODE",
            "value": "CNNGB"
          }
        ],
        "name": "Ningbo",
        "timeZone": "Asia/Shanghai"
      },
      "primaryShipmentIdentifier": {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      "shipmentId": "758ff08b-2693-4308-bf22-b967623ffeea",
      "updatedDateTime": "2026-08-27T12:04:00Z"
    }
  ],
  "total": 1
}

Set shipment attributes

Set custom attributes, such as a customer or a lane, on a shipment project44 tracks. A value given replaces the attribute's value; other attributes stay.

Inputs

Shipment IDshipment_idtextRequired
The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.
AttributesattributesobjectRequired
A value for any of your organization's attribute names, such as a customer or a lane. Names are defined in project44 first (see 'Define attribute name').

Outputs

shipmentobject
The shipment as project44 has it
shipment_idtext
The shipment's project44 id
Example output
{
  "shipment": {
    "attributes": [
      {
        "name": "Customer",
        "values": [
          "Acme Foods"
        ]
      }
    ],
    "createdDateTime": "2026-08-24T14:15:22Z",
    "id": "758ff08b-2693-4308-bf22-b967623ffeea",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "MAEU"
      }
    ],
    "lastModifiedDateTime": "2026-08-25T09:02:10Z",
    "routeInfo": {
      "routeSegments": [
        {
          "fromStopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "id": "9810cab9-ab32-3871-b392-768aba8ea330",
          "identifiers": [
            {
              "type": "VESSEL_IMO",
              "value": "9778791"
            }
          ],
          "toStopId": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "transportationMode": "OCEAN"
        }
      ],
      "stops": [
        {
          "id": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Ningbo",
              "country": "CN",
              "postalCode": "",
              "state": ""
            },
            "coordinates": {
              "latitude": 29.87,
              "longitude": 121.55
            },
            "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "CNNGB"
              }
            ],
            "name": "Ningbo",
            "timeZone": "Asia/Shanghai"
          },
          "type": "ORIGIN"
        },
        {
          "id": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Los Angeles",
              "country": "US",
              "postalCode": "",
              "state": "CA"
            },
            "coordinates": {
              "latitude": 33.74,
              "longitude": -118.26
            },
            "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "USLAX"
              }
            ],
            "name": "Los Angeles",
            "timeZone": "America/Los_Angeles"
          },
          "type": "DESTINATION"
        }
      ]
    },
    "shipmentShareLink": "https://movement.project44.com/share/062a51cc-0000-0000-ba16-734650344d4d"
  },
  "shipment_id": "758ff08b-2693-4308-bf22-b967623ffeea"
}

Track shipment

Start tracking an ocean, air, LTL, parcel or rail shipment by its bill of lading, container, booking, PRO, tracking number or other identifier. Gives the shipment's project44 id and a link to follow it. Given identifiers project44 already tracks, it adds to that shipment.

Inputs

Identifier typeidentifier_typetextRequired
What the identifier is.One of: BILL_OF_LADING (Bill of lading (ocean, LTL, rail)), BOOKING_NUMBER (Booking number (ocean)), CONTAINER_ID (Container number (ocean, rail)), HOUSE_BILL_OF_LADING (House bill of lading (ocean door to door)), AIR_WAYBILL (Air waybill (air)), HOUSE_AIR_WAYBILL (House air waybill (air)), TRACKING_NUMBER (Tracking number (parcel)), REFERENCE_NUMBER (Reference number (parcel)), PRO (PRO number (LTL)), PICKUP (Pickup number (LTL)), and 6 more.
Identifieridentifier_valuetextRequired
The bill of lading, container number and so on.
Carrier SCACcarrier_scactext
The carrier's four-letter SCAC, such as MAEU for Maersk. Ocean and house air waybill tracking need it; it helps project44 find any shipment faster.
Carrier account groupaccount_grouptext
For LTL and parcel: the code of the carrier account group in project44 to track through. Leave empty for the default.
Other identifiersother_identifiersobject
More identifiers for the same shipment, each type with its value, such as CONTAINER_ID: MSCU1234567 or BOOKING_NUMBER: 254318795.
Attributesattributesobject
A value for any of your organization's attribute names, such as a customer or a lane. Names are defined in project44 first (see 'Define attribute name').

Outputs

shipmentobject
The shipment as project44 has it
shipment_idtext
The shipment's project44 id
Example output
{
  "shipment": {
    "attributes": [
      {
        "name": "Customer",
        "values": [
          "Acme Foods"
        ]
      }
    ],
    "createdDateTime": "2026-08-24T14:15:22Z",
    "id": "758ff08b-2693-4308-bf22-b967623ffeea",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MAEU123456789"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "MAEU"
      }
    ],
    "lastModifiedDateTime": "2026-08-25T09:02:10Z",
    "routeInfo": {
      "routeSegments": [
        {
          "fromStopId": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "id": "9810cab9-ab32-3871-b392-768aba8ea330",
          "identifiers": [
            {
              "type": "VESSEL_IMO",
              "value": "9778791"
            }
          ],
          "toStopId": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "transportationMode": "OCEAN"
        }
      ],
      "stops": [
        {
          "id": "0dcaf574-1183-45b2-ae9c-5529531af9c6",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Ningbo",
              "country": "CN",
              "postalCode": "",
              "state": ""
            },
            "coordinates": {
              "latitude": 29.87,
              "longitude": 121.55
            },
            "id": "8669f02f-27b0-4b40-9a2f-38eddb4348ab",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "CNNGB"
              }
            ],
            "name": "Ningbo",
            "timeZone": "Asia/Shanghai"
          },
          "type": "ORIGIN"
        },
        {
          "id": "6ab2c9dd-574c-4994-a14d-262a6313ab5d",
          "location": {
            "address": {
              "addressLines": [],
              "city": "Los Angeles",
              "country": "US",
              "postalCode": "",
              "state": "CA"
            },
            "coordinates": {
              "latitude": 33.74,
              "longitude": -118.26
            },
            "id": "72ec8d0b-3a29-4f5d-b116-ba8dcc83a124",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "USLAX"
              }
            ],
            "name": "Los Angeles",
            "timeZone": "America/Los_Angeles"
          },
          "type": "DESTINATION"
        }
      ]
    },
    "shipmentShareLink": "https://movement.project44.com/share/062a51cc-0000-0000-ba16-734650344d4d"
  },
  "shipment_id": "758ff08b-2693-4308-bf22-b967623ffeea"
}

Update stop location

Change a saved stop location's name, address, coordinates or your id for it. Fields left empty keep their value.

Inputs

Stop locationstop_location_idtextRequired
The stop location. Pick one, or give its project44 id.
Namenametext
The location's name, such as Chicago warehouse. Leave empty to keep it.
Street addressaddresstext
The street and number. Leave empty to keep it.
Address line 2address_line_2text
A suite, unit or building, if any.
Citycitytext
The city. Leave empty to keep it.
Statestatetext
The state or province code, such as IL. Leave empty to keep it.
Postal codepostal_codetext
The ZIP or postal code. Leave empty to keep it.
Countrycountrytext
The two-letter country code, such as US. Leave empty to keep it.
Latitudelatitudenumber
Where it is, with the longitude, if the address isn't enough.From -90 to 90.
Longitudelongitudenumber
Where it is, with the latitude.From -180 to 180.
Your location IDsupplied_idtext
Your own code for the location, such as its id in your TMS.

Outputs

stop_locationobject
The stop location
Example output
{
  "stop_location": {
    "address": {
      "addressLines": [
        "1200 W Fulton Market"
      ],
      "city": "Chicago",
      "country": "US",
      "postalCode": "60607",
      "state": "IL"
    },
    "addressSpecificity": "HOUSE_NUMBER",
    "coordinates": {
      "latitude": 41.8867,
      "longitude": -87.6596
    },
    "id": "f4b5c6d7-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
    "name": "Chicago warehouse",
    "suppliedId": "WH-CHI-01",
    "version": 1
  }
}

On this page