# project44

> 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.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/project44

## Actions

### Count shipments

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

**Inputs**

- Search text (`search_text`, text): Finds shipments whose identifiers, carrier or places contain this text.
- Identifier type (`identifier_type`, text): 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 value (`identifier_value`, text): A bill of lading, container, PRO or other identifier to find.
- Mode (`transportation_mode`, text): Only shipments of this mode. One of: `TRUCKLOAD`, `LTL` (LTL (less than truckload)), `PARCEL`, `OCEAN`, `AIR`, `RAIL`, `BARGE`.
- Current state (`current_state`, text): 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`.
- Attribute (`attribute_name`, text): Only shipments with this attribute.
- Attribute value (`attribute_value`, text): Only shipments whose attribute has this value. Leave empty for any value.
- Date to filter on (`date_type`, text): 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`.
- From (`from_time`, date and time): Only shipments whose chosen date is at or after this time.
- To (`to_time`, date and time): Only shipments whose chosen date is at or before this time.

**Outputs**

- `total` (number): How many shipments match

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The location's name, such as Chicago warehouse.
- Street address (`address`, text): The street and number.
- Address line 2 (`address_line_2`, text): A suite, unit or building, if any.
- City (`city`, text): The city.
- State (`state`, text): The state or province code, such as IL.
- Postal code (`postal_code`, text): The ZIP or postal code.
- Country (`country`, text): The two-letter country code, such as US. Defaults to US.
- Latitude (`latitude`, number): Where it is, with the longitude, if the address isn't enough. From -90 to 90.
- Longitude (`longitude`, number): Where it is, with the latitude. From -180 to 180.
- Your location ID (`supplied_id`, text): Your own code for the location, such as its id in your TMS.

**Outputs**

- `stop_location` (object): The stop location

**Example output**

```json
{
  "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 type (`carrier_id_type`, text): 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`.
- Carrier (`carrier_id`, text, required): The carrier's SCAC (or the identifier chosen).
- Shipment identifier type (`shipment_id_type`, text): 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 number (`shipment_number`, text, required): The shipment's number, unique for this carrier.
- Pickup company (`origin_name`, text): The company at the pickup.
- Pickup street address (`origin_address`, text): The pickup's street and number.
- Pickup city (`origin_city`, text, required): The pickup's city.
- Pickup state (`origin_state`, text): The pickup's state or province code, such as IL. Needed in the US, Canada and Mexico.
- Pickup postal code (`origin_postal_code`, text, required): The pickup's ZIP or postal code.
- Pickup country (`origin_country`, text): The two-letter country code, such as US. Defaults to US.
- Pickup time zone (`origin_time_zone`, text): The pickup's time zone, such as America/Chicago, which the pickup window is kept in. Defaults to UTC.
- Pickup window opens (`pickup_start`, date and time, required): When the pickup appointment window opens.
- Pickup window closes (`pickup_end`, date and time, required): When the pickup appointment window closes.
- Delivery company (`destination_name`, text): The company at the delivery.
- Delivery street address (`destination_address`, text): The delivery's street and number.
- Delivery city (`destination_city`, text, required): The delivery's city.
- Delivery state (`destination_state`, text): The delivery's state or province code, such as IL. Needed in the US, Canada and Mexico.
- Delivery postal code (`destination_postal_code`, text, required): The delivery's ZIP or postal code.
- Delivery country (`destination_country`, text): The two-letter country code, such as US. Defaults to US.
- Delivery time zone (`destination_time_zone`, text): The delivery's time zone, such as America/Chicago, which the delivery window is kept in. Defaults to UTC.
- Delivery window opens (`delivery_start`, date and time, required): When the delivery appointment window opens.
- Delivery window closes (`delivery_end`, date and time, required): When the delivery appointment window closes.
- Equipment type (`equipment_type`, text): 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 identifier (`equipment_id`, text): The truck number, license plate, driver's phone or device to track. Most carriers need one.
- Attributes (`attributes`, object): 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_messages` (list): Warnings and notes from project44
- `shipment` (object): The truckload shipment
- `shipment_id` (text): Its project44 shipment id, for the tracking steps (empty until project44 gives one)
- `truckload_shipment_id` (number): The truckload shipment's number, for the truckload steps

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The attribute's name, unique in your organization.

**Outputs**

- `info_messages` (list): Notes from project44
- `name` (text): The name defined

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

**Outputs**

- `deleted` (true/false): True once project44 deleted it
- `shipment_id` (text): The shipment deleted

**Example output**

```json
{
  "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 number (`truckload_shipment_id`, number, required): The truckload shipment's project44 number, from 'Create truckload shipment', like 2401881. At least 1.

**Outputs**

- `deleted` (true/false): True once project44 deleted it
- `truckload_shipment_id` (number): The truckload shipment deleted

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

**Outputs**

- `shipment` (object): The shipment, with its stops and route

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

**Outputs**

- `attributes` (list): The shipment's attributes

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.
- Include stops and route (`include_route`, true/false): Also get the shipment's stops and the legs between them. Default: `false`.

**Outputs**

- `events` (list): Its events, done and expected
- `exceptions` (list): Its exceptions
- `shipment` (object): The shipment
- `states` (list): The states it has been in

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.
- Include stops and route (`include_route`, true/false): Also get the shipment's stops and the legs between them. Default: `false`.

**Outputs**

- `positions` (list): Where it has been, oldest first
- `shipment` (object): The shipment

**Example output**

```json
{
  "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 location (`stop_location_id`, text, required): The stop location. Pick one, or give its project44 id.

**Outputs**

- `stop_location` (object): The stop location

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.

**Outputs**

- `events` (list): Its events, done and expected
- `exceptions` (list): Its exceptions
- `positions` (list): Where it has been
- `shipment` (object): The shipment
- `states` (list): The states it has been in

**Example output**

```json
{
  "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 number (`truckload_shipment_id`, number, required): The truckload shipment's project44 number, from 'Create truckload shipment', like 2401881. At least 1.

**Outputs**

- `shipment` (object): The truckload shipment
- `shipment_id` (text): Its project44 shipment id, for the tracking steps (empty until project44 gives one)
- `truckload_shipment_id` (number): The truckload shipment's number, for the truckload steps

**Example output**

```json
{
  "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_definitions` (list): The attribute names

**Example output**

```json
{
  "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**

- Page (`page_number`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`page_size`, number): How many to get, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `has_more` (true/false): Whether there's a next page
- `page_number` (number): The page this is
- `page_size` (number): How many a page holds
- `stop_locations` (list): The stop locations on this page
- `total` (number): How many there are in all

**Example output**

```json
{
  "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 text (`search_text`, text): Finds shipments whose identifiers, carrier or places contain this text.
- Identifier type (`identifier_type`, text): 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 value (`identifier_value`, text): A bill of lading, container, PRO or other identifier to find.
- Mode (`transportation_mode`, text): Only shipments of this mode. One of: `TRUCKLOAD`, `LTL` (LTL (less than truckload)), `PARCEL`, `OCEAN`, `AIR`, `RAIL`, `BARGE`.
- Current state (`current_state`, text): 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`.
- Attribute (`attribute_name`, text): Only shipments with this attribute.
- Attribute value (`attribute_value`, text): Only shipments whose attribute has this value. Leave empty for any value.
- Date to filter on (`date_type`, text): 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`.
- From (`from_time`, date and time): Only shipments whose chosen date is at or after this time.
- To (`to_time`, date and time): Only shipments whose chosen date is at or before this time.
- Sort by (`sort_by`, text): 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`.
- Page (`page_number`, number): Which page to get, starting at 1. Defaults to the first. At least 1.
- Page size (`page_size`, number): How many to get, 1 to 1,000. Defaults to 25. From 1 to 1000.

**Outputs**

- `page_number` (number): The page this is
- `page_size` (number): How many a page holds
- `shipments` (list): The shipments on this page
- `total` (number): How many shipments match in all

**Example output**

```json
{
  "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 ID (`shipment_id`, text, required): The shipment's project44 id, from 'Track shipment', 'Search shipments' or a trigger, like 758ff08b-2693-4308-bf22-b967623ffeea.
- Attributes (`attributes`, object, required): 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**

- `shipment` (object): The shipment as project44 has it
- `shipment_id` (text): The shipment's project44 id

**Example output**

```json
{
  "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 type (`identifier_type`, text, required): 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.
- Identifier (`identifier_value`, text, required): The bill of lading, container number and so on.
- Carrier SCAC (`carrier_scac`, text): 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 group (`account_group`, text): For LTL and parcel: the code of the carrier account group in project44 to track through. Leave empty for the default.
- Other identifiers (`other_identifiers`, object): More identifiers for the same shipment, each type with its value, such as CONTAINER_ID: MSCU1234567 or BOOKING_NUMBER: 254318795.
- Attributes (`attributes`, object): 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**

- `shipment` (object): The shipment as project44 has it
- `shipment_id` (text): The shipment's project44 id

**Example output**

```json
{
  "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 location (`stop_location_id`, text, required): The stop location. Pick one, or give its project44 id.
- Name (`name`, text): The location's name, such as Chicago warehouse. Leave empty to keep it.
- Street address (`address`, text): The street and number. Leave empty to keep it.
- Address line 2 (`address_line_2`, text): A suite, unit or building, if any.
- City (`city`, text): The city. Leave empty to keep it.
- State (`state`, text): The state or province code, such as IL. Leave empty to keep it.
- Postal code (`postal_code`, text): The ZIP or postal code. Leave empty to keep it.
- Country (`country`, text): The two-letter country code, such as US. Leave empty to keep it.
- Latitude (`latitude`, number): Where it is, with the longitude, if the address isn't enough. From -90 to 90.
- Longitude (`longitude`, number): Where it is, with the latitude. From -180 to 180.
- Your location ID (`supplied_id`, text): Your own code for the location, such as its id in your TMS.

**Outputs**

- `stop_location` (object): The stop location

**Example output**

```json
{
  "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
  }
}
```
