Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

project44 REST API (4.0.0)

Version 4.0.0 of project44's API. If you're not familiar with project44, we recommend checking out our guides first: https://developers.project44.com/guides/shippers and https://developers.project44.com/guides/carriers.

Download OpenAPI description
api-docs.json
api-docs.yaml
Overview
License © 2024 project44 - Terms of Use
Languages
Servers
NA - Endpoint for project44 tenants created in the NA region
https://na12.api.project44.com/
EU - Endpoint for project44 tenants created in the EU region
https://eu12.api.project44.com/
Sandbox - Endpoint for project44 tenants created in the sandbox environment
https://na12.api.sandbox.p-44.com/

OAuth 2.0: Client Applications

API used for registering and managing OAuth 2.0 client applications. See the "Authentication" section above for more information. To authorize API requests to project44 for an API integration, first your client application must be registered with project44, which will issue your application a client id and secret. These credentials can then be used to generate bearer tokens, which can be included on all other API requests to authorize your client application. The client application is authorized through the project44 user management UI as a machine user with username "app-{client_id}@client-applications.project44.com".

An admin user (with Movement user role "Customer Admin") must use HTTP Basic Authentication with this API to manage client applications. Basic Authentication is deprecated for all other APIs, besides token generation, in favor of passing the access token generated via OAuth 2.0.

Operations

OAuth 2.0: Token Generation

API for OAuth 2.0 token generation. See the "Authentication" section above for more information. Once your client application is registered, you can use the token generation endpoint to authenticate with your application's client id and secret in exchange for a bearer token to be included on all other API requests to authenticate as that client application. The client application is authorized through the project44 user management UI as a machine user with username "app-{client_id}@client-applications.project44.com".

To generate an access token, you may authenticate your client application by providing its client id and secret either in the body of the request or in the form of HTTP Basic Authentication (but you may not use both ways in the same request).

Operations

Shipment: Tracking

...

Operations

Shipment Search

...

Operations

Filter Suggestions

...

Operations

Shipment Attributes

...

Operations

Shipment: Loads

...

Operations

Order Visibility

...

Operations

LTL: Quotes

...

Operations

LTL: Dispatch

...

Operations

LTL: Image Retrieval

...

Operations

LTL: Electronic BOL

API used for creating Electronic BOL

Operations

VLTL: Quotes

...

Operations

VLTL: Dispatch

...

Operations

TL: Available Vehicles

...

Operations

TL: Connected Capacity

...

Operations

Asset Tracking

...

Operations

Multi-Modal: Image Retrieval

...

Operations

Multi-Modal: Rating

API used for multi-modal Rating.

Operations

Multi-Modal: Booking

API used for multi-modal Booking.

Operations

Multi-Modal: Packaging

API used for managing packages for shipment planning.

Operations

Multi-Modal: Document

...

Operations

Webhook

...

Operations

Shipment Webhook Data

Operations to describe the payload expected from project44 when integrated with a webhook for shipments.

Operations

Inventory Order and Load Webhook Data

Operations to describe the payload expected from project44 when integrated with a webhook for orders and loads.

Operations

Capacity Provider Metadata

...

Operations

Capacity Provider Contact Management

...

Operations

Capacity Provider Account Management

...

Operations

Capacity Provider Account Group Management

...

Operations

LTL: Push Tracking

...

Operations

LTL: Push Imaging

...

Operations

TL: Capacity Provider Push

...

Operations

Parcel: Push Tracking

...

Operations

Universal Push: Truckload

...

Operations

Push Updates

...

Operations

Analytics: Port Intelligence

...

Operations

Stop Location Management

...

Operations

Postal Address Validation

...

Operations

Appointments

Create, reschedule, cancel, fetch appointments in Yard Management Systems(YMS)

Operations

Capacity

Get capacity for a YMS site within the specified time range

Operations

Milestones

Update yard milestones for a shipment

Operations

Reason Codes

Retrieve all reason codes for the specified YMS site

Operations

Site Codes

Retrieve all sites for the specified YMS tenant

Operations

Slots

Get available slots for a shipment in Yard Management Systems(YMS)

Operations

Invitations

...

Operations

Ocean: Point-to-Point Schedules

...

Operations

LTL: Tracking

...

Operations

TL: Tracking

...

Operations

start tracking a truckload shipment

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

curl -i -X POST \
  'https://na12.api.project44.com/api/v3/tl/shipments?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "enableIntelligentMatching": true,
      "fallBackToDefaultAccountGroup": true,
      "webhookEndpointConfigName": "string"
    },
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "contents": [
      {
        "minTemperatureThreshold": 0.1,
        "maxTemperatureThreshold": 0.1,
        "temperatureSetPoint": 0.1
      }
    ],
    "equipmentIdentifiers": [
      {
        "shouldDelete": true,
        "type": "MOBILE_PHONE_NUMBER",
        "value": "string"
      }
    ],
    "equipmentIdentifierChanges": [
      {
        "type": "MOBILE_PHONE_NUMBER",
        "timestamp": "2019-08-24T14:15:22Z",
        "value": "string"
      }
    ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [
      {
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "pointOfInterestName": "string",
        "pointOfInterestType": "GENERAL",
        "pointOfInterestDescription": "string",
        "pointOfInterestId": "string",
        "shouldDelete": true
      }
    ],
    "route": {
      "plannedRouteId": "string"
    },
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      },
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ],
    "sensors": [
      {
        "identifier": {
          "type": "TEMPERATURE",
          "value": "string"
        },
        "min": 0.1,
        "max": 0.1,
        "target": 0.1
      }
    ],
    "shippingDetails": {
      "hazmatDetails": {
        "hazardClasses": [
          "string"
        ]
      },
      "multipleDrivers": true,
      "truckDetails": {
        "truckDimensions": {
          "height": 0,
          "length": 0,
          "unitOfMeasure": "IN",
          "width": 0
        },
        "truckType": "AUTO_CARRIER",
        "weight": 0,
        "weightUnitOfMeasure": "LB"
      }
    },
    "shipmentDetails": {
      "lineItems": [
        {
          "commodityCode": "string",
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          },
          "description": "string",
          "deliveryStopNumber": 0,
          "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
          "handlingUnitQuantity": 0,
          "handlingUnitPackageType": "PLT",
          "itemIdentifiers": [
            {
              "type": "PURCHASE_ORDER",
              "value": "string"
            }
          ],
          "itemQuantity": 0,
          "itemPackageType": "BAG",
          "involvedParties": [
            {
              "addressInfo": {
                "addressLines": [
                  null
                ],
                "addressLabel": "string",
                "city": "string",
                "country": "US",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "postalCode": "string",
                "state": "string"
              },
              "contactInfo": {
                "companyName": "string",
                "email": "user@example.com",
                "familyName": "string",
                "givenName": "string",
                "mobilePhoneNumber": "string",
                "phoneNumber": "string"
              },
              "identifyingCodes": {
                "codeListProvider": "WAVE",
                "codeListName": "DID",
                "partyCode": "string"
              },
              "locationIdentifiers": [
                {}
              ],
              "partyType": "SHIPPER",
              "vatNumber": "string"
            }
          ],
          "monetaryValue": {
            "amount": 0,
            "currency": "USD"
          },
          "pickupStopNumber": 0,
          "subLineItems": [
            {
              "commodityCode": "string",
              "contact": {
                "companyName": "string",
                "contactName": "string",
                "email": "string",
                "faxNumber": "string",
                "faxNumberCountryCode": "string",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "string",
                "phoneNumber2": "string",
                "phoneNumber2CountryCode": "string"
              },
              "description": "string",
              "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
              "itemIdentifiers": [
                {}
              ],
              "itemQuantity": 0,
              "itemPackageType": "BAG",
              "involvedParties": [
                {
                  "locationIdentifiers": []
                }
              ],
              "monetaryValue": {
                "amount": 0,
                "currency": "USD"
              },
              "totalWeight": {
                "weight": 0,
                "weightUnit": "LB"
              }
            }
          ],
          "totalWeight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [
      "RISK_MANAGEMENT"
    ],
    "trackingDetails": [
      {
        "equipmentIdentifier": {
          "shouldDelete": true,
          "type": "MOBILE_PHONE_NUMBER",
          "value": "string"
        },
        "equipmentIdentifierSource": "CUSTOMER",
        "trackingType": "MOBILE_PHONE"
      }
    ]
  }'

Responses

Created

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(TruckloadShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  }
}

Get Truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being queried.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X GET \
  'https://na12.api.project44.com/api/v3/tl/shipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

Response
{
  "apiConfiguration": {
    "enableIntelligentMatching": true,
    "fallBackToDefaultAccountGroup": true,
    "webhookEndpointConfigName": "string"
  },
  "attributes": [
    { … }
  ],
  "carrierIdentifier": {
    "type": "SCAC",
    "value": "string"
  },
  "capacityProviderAccountGroup": {
    "accounts": [ … ],
    "code": "string"
  },
  "contents": [
    { … }
  ],
  "equipmentIdentifiers": [
    { … }
  ],
  "equipmentIdentifierChanges": [
    { … }
  ],
  "id": 0,
  "idleDuration": 0,
  "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
  "pointsOfInterest": [
    { … }
  ],
  "route": {
    "plannedRouteId": "string"
  },
  "shipmentIdentifiers": [
    { … }
  ],
  "shipmentStops": [
    { … },
    { … }
  ],
  "sensors": [
    { … }
  ],
  "shippingDetails": {
    "hazmatDetails": { … },
    "multipleDrivers": true,
    "truckDetails": { … }
  },
  "shipmentDetails": {
    "lineItems": [ … ]
  },
  "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
  "scope": [
    "RISK_MANAGEMENT"
  ],
  "trackingDetails": [
    { … }
  ]
}

Update a truckload shipment

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being updated.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

curl -i -X PUT \
  'https://na12.api.project44.com/api/v3/tl/shipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "enableIntelligentMatching": true,
      "fallBackToDefaultAccountGroup": true,
      "webhookEndpointConfigName": "string"
    },
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "contents": [
      {
        "minTemperatureThreshold": 0.1,
        "maxTemperatureThreshold": 0.1,
        "temperatureSetPoint": 0.1
      }
    ],
    "equipmentIdentifiers": [
      {
        "shouldDelete": true,
        "type": "MOBILE_PHONE_NUMBER",
        "value": "string"
      }
    ],
    "equipmentIdentifierChanges": [
      {
        "type": "MOBILE_PHONE_NUMBER",
        "timestamp": "2019-08-24T14:15:22Z",
        "value": "string"
      }
    ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [
      {
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "pointOfInterestName": "string",
        "pointOfInterestType": "GENERAL",
        "pointOfInterestDescription": "string",
        "pointOfInterestId": "string",
        "shouldDelete": true
      }
    ],
    "route": {
      "plannedRouteId": "string"
    },
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      },
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ],
    "sensors": [
      {
        "identifier": {
          "type": "TEMPERATURE",
          "value": "string"
        },
        "min": 0.1,
        "max": 0.1,
        "target": 0.1
      }
    ],
    "shippingDetails": {
      "hazmatDetails": {
        "hazardClasses": [
          "string"
        ]
      },
      "multipleDrivers": true,
      "truckDetails": {
        "truckDimensions": {
          "height": 0,
          "length": 0,
          "unitOfMeasure": "IN",
          "width": 0
        },
        "truckType": "AUTO_CARRIER",
        "weight": 0,
        "weightUnitOfMeasure": "LB"
      }
    },
    "shipmentDetails": {
      "lineItems": [
        {
          "commodityCode": "string",
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          },
          "description": "string",
          "deliveryStopNumber": 0,
          "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
          "handlingUnitQuantity": 0,
          "handlingUnitPackageType": "PLT",
          "itemIdentifiers": [
            {
              "type": "PURCHASE_ORDER",
              "value": "string"
            }
          ],
          "itemQuantity": 0,
          "itemPackageType": "BAG",
          "involvedParties": [
            {
              "addressInfo": {
                "addressLines": [
                  null
                ],
                "addressLabel": "string",
                "city": "string",
                "country": "US",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "postalCode": "string",
                "state": "string"
              },
              "contactInfo": {
                "companyName": "string",
                "email": "user@example.com",
                "familyName": "string",
                "givenName": "string",
                "mobilePhoneNumber": "string",
                "phoneNumber": "string"
              },
              "identifyingCodes": {
                "codeListProvider": "WAVE",
                "codeListName": "DID",
                "partyCode": "string"
              },
              "locationIdentifiers": [
                {}
              ],
              "partyType": "SHIPPER",
              "vatNumber": "string"
            }
          ],
          "monetaryValue": {
            "amount": 0,
            "currency": "USD"
          },
          "pickupStopNumber": 0,
          "subLineItems": [
            {
              "commodityCode": "string",
              "contact": {
                "companyName": "string",
                "contactName": "string",
                "email": "string",
                "faxNumber": "string",
                "faxNumberCountryCode": "string",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "string",
                "phoneNumber2": "string",
                "phoneNumber2CountryCode": "string"
              },
              "description": "string",
              "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
              "itemIdentifiers": [
                {}
              ],
              "itemQuantity": 0,
              "itemPackageType": "BAG",
              "involvedParties": [
                {
                  "locationIdentifiers": []
                }
              ],
              "monetaryValue": {
                "amount": 0,
                "currency": "USD"
              },
              "totalWeight": {
                "weight": 0,
                "weightUnit": "LB"
              }
            }
          ],
          "totalWeight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [
      "RISK_MANAGEMENT"
    ],
    "trackingDetails": [
      {
        "equipmentIdentifier": {
          "shouldDelete": true,
          "type": "MOBILE_PHONE_NUMBER",
          "value": "string"
        },
        "equipmentIdentifierSource": "CUSTOMER",
        "trackingType": "MOBILE_PHONE"
      }
    ]
  }'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(TruckloadShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  }
}

Delete truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being deleted.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X DELETE \
  'https://na12.api.project44.com/api/v3/tl/shipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Create action for existing truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment to which this action applies.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
codestring

${TruckloadShipmentAction.apiModel.code.value}

Value"CANCEL"
curl -i -X POST \
  'https://na12.api.project44.com/api/v3/tl/shipments/{id}/actions?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "CANCEL"
  }'

Responses

Created

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentActionConfirmation.apiModel.infoMessages.value}

Response
{
  "infoMessages": [
    { … }
  ]
}

Request ad hoc equipment approval from the tracking provider

Request

Path
idinteger(int64)required

The project44-generated id for the shipment.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X POST \
  'https://na12.api.project44.com/api/v3/tl/shipments/{id}/equipmentapprovals/requests?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Get status of truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being queried.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
includeStatusHistoryboolean

Whether shipment status history ('statusUpdates') should be included in the response.

Default false
includeSensorHistoryboolean

Whether shipment sensor history ('sensorHistory') should be included in the response.

Default false
includeMapUrlboolean

Whether a publicly accessible URL to the shipment details page should be included in the response.

Default false
curl -i -X GET \
  'https://na12.api.project44.com/api/v3/tl/shipments/{id}/statuses?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&includeMapUrl=false&includeSensorHistory=false&includeStatusHistory=false&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentStatus.apiModel.infoMessages.value}

latestStatusUpdateobject(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

latestStopStatusesArray of objects(TruckloadShipmentStopStatus)

${TruckloadShipmentStatus.apiModel.latestStopStatuses.value}

mapUrlstring

${TruckloadShipmentStatus.apiModel.mapUrl.value}

notificationRuleobject(TruckloadShipmentNotificationRule)

Contains fields describing properties of rule that triggered a push notification

pointOfInterestStatusArray of objects(TruckloadShipmentPointOfInterestStatus)

${TruckloadShipmentStatus.apiModel.pointOfInterestStatus.value}

shipmentobject(TruckloadShipment)
statusUpdatesArray of objects(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

sensorHistoriesArray of objects(TruckloadShipmentSensorHistory)

${TruckloadShipmentStatus.apiModel.sensorHistories.value}

Response
{
  "infoMessages": [
    { … }
  ],
  "latestStatusUpdate": {
    "address": { … },
    "geoCoordinates": { … },
    "statusCode": "DISPATCHED",
    "statusReason": { … },
    "stopNumber": 0,
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "latestStopStatuses": [
    { … }
  ],
  "mapUrl": "string",
  "notificationRule": {
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.value}": "DEPRECATED_SHIPMENT_LATE",
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.ruleInfo}": { … }
  },
  "pointOfInterestStatus": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  },
  "statusUpdates": [
    { … }
  ],
  "sensorHistories": [
    { … }
  ]
}

Get status of a truckload shipment by shipment identifier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
shipmentQueryobject(TruckloadShipmentQuery)required
shipmentQuery.​carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

shipmentQuery.​shipmentIdentifierobject(TruckloadShipmentIdentifier)

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

includeStatusHistoryboolean

Whether shipment status history ('statusUpdates') should be included in the response.

Default false
includeSensorHistoryboolean

Whether shipment sensor history ('sensorHistory') should be included in the response.

Default false
includeMapUrlboolean

Whether a publicly accessible URL to the shipment details page should be included in the response.

Default false
curl -i -X GET \
  'https://na12.api.project44.com/api/v3/tl/shipments/statuses?accountNonExpired=true&accountNonLocked=true&carrierIdentifier=%5Bobject%20Object%5D&credentialsNonExpired=true&enabled=true&id=0&includeMapUrl=false&includeSensorHistory=false&includeStatusHistory=false&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&shipmentIdentifier=%5Bobject%20Object%5D&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentStatus.apiModel.infoMessages.value}

latestStatusUpdateobject(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

latestStopStatusesArray of objects(TruckloadShipmentStopStatus)

${TruckloadShipmentStatus.apiModel.latestStopStatuses.value}

mapUrlstring

${TruckloadShipmentStatus.apiModel.mapUrl.value}

notificationRuleobject(TruckloadShipmentNotificationRule)

Contains fields describing properties of rule that triggered a push notification

pointOfInterestStatusArray of objects(TruckloadShipmentPointOfInterestStatus)

${TruckloadShipmentStatus.apiModel.pointOfInterestStatus.value}

shipmentobject(TruckloadShipment)
statusUpdatesArray of objects(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

sensorHistoriesArray of objects(TruckloadShipmentSensorHistory)

${TruckloadShipmentStatus.apiModel.sensorHistories.value}

Response
{
  "infoMessages": [
    { … }
  ],
  "latestStatusUpdate": {
    "address": { … },
    "geoCoordinates": { … },
    "statusCode": "DISPATCHED",
    "statusReason": { … },
    "stopNumber": 0,
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "latestStopStatuses": [
    { … }
  ],
  "mapUrl": "string",
  "notificationRule": {
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.value}": "DEPRECATED_SHIPMENT_LATE",
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.ruleInfo}": { … }
  },
  "pointOfInterestStatus": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  },
  "statusUpdates": [
    { … }
  ],
  "sensorHistories": [
    { … }
  ]
}

Get available shipment tracking methods for a carrier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
trackingMethodQueryobject(TruckloadShipmentTrackingMethodQuery)required
trackingMethodQuery.​carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

curl -i -X GET \
  'https://na12.api.project44.com/api/v3/tl/shipments/trackingmethods?accountNonExpired=true&accountNonLocked=true&carrierIdentifier=%5Bobject%20Object%5D&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
trackingMethodsArray of objects(TruckloadShipmentTrackingMethod)

${TruckloadShipmentTrackingMethods.apiModel.trackingMethods.value}

Response
{
  "trackingMethods": [
    { … }
  ]
}

Get list of assets for a given carrier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
capacityProviderIdentifierValuestringrequired

The identifier of the capacity provider for which assets are requested

capacityProviderIdentifierTypestring(enum)(CapacityProviderIdentifierType)required

The type of identifier provided.

Enum"SCAC""DOT_NUMBER""MC_NUMBER""P44_EU""SYSTEM""P44_GLOBAL""VAT"
pageinteger(int32)[ 1 .. 1000 ]

Determines the range of results that are returned. Minimum: 1, Maximum: 1000, Default: 1

Default 1
sizeinteger(int32)[ 1 .. 1000 ]

The page size, or maximum number of results which may be returned at once. Minimum: 1, Maximum: 1000, Default: 100

Default 100
curl -i -X GET \
  'https://na12.api.project44.com/api/v4/tl/assets?accountNonExpired=true&accountNonLocked=true&capacityProviderIdentifierType=SCAC&capacityProviderIdentifierValue=string&credentialsNonExpired=true&enabled=true&id=0&locale=string&page=1&registrationDate=2019-08-24T14%3A15%3A22Z&size=100&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
paginationInfoobject(PaginationInfo)

Pagination information about a collection of resources.

resultsArray of objects(TruckloadEquipmentIdentifier)

List of resources contained on this page.

Response
application/json
{
  "paginationInfo": {
    "pageSize": 0,
    "pageNumber": 0,
    "total": 0
  },
  "results": [
    { … }
  ]
}

Validate equipment identifiers

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
queryobject(TruckloadEquipmentValidationQuery)required

A request object for equipment validation with this capacity provider

curl -i -X GET \
  'https://na12.api.project44.com/api/v4/tl/equipment/validate?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
existsboolean

${TruckloadEquipmentValidation.apiModel.exists.value}

ownershipStatusstring

${TruckloadEquipmentValidation.apiModel.ownershipStatus.value}

Enum"CONNECTED""NOT_CONNECTED""INDETERMINATE""UNKNOWN"
validboolean

${TruckloadEquipmentValidation.apiModel.valid.value}

Response
{
  "exists": true,
  "ownershipStatus": "CONNECTED",
  "valid": true
}

Update a truckload shipment by shipment identifier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

curl -i -X PUT \
  'https://na12.api.project44.com/api/v4/tl/shipments?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "enableIntelligentMatching": true,
      "fallBackToDefaultAccountGroup": true,
      "webhookEndpointConfigName": "string"
    },
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "contents": [
      {
        "minTemperatureThreshold": 0.1,
        "maxTemperatureThreshold": 0.1,
        "temperatureSetPoint": 0.1
      }
    ],
    "equipmentIdentifiers": [
      {
        "shouldDelete": true,
        "type": "MOBILE_PHONE_NUMBER",
        "value": "string"
      }
    ],
    "equipmentIdentifierChanges": [
      {
        "type": "MOBILE_PHONE_NUMBER",
        "timestamp": "2019-08-24T14:15:22Z",
        "value": "string"
      }
    ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [
      {
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "pointOfInterestName": "string",
        "pointOfInterestType": "GENERAL",
        "pointOfInterestDescription": "string",
        "pointOfInterestId": "string",
        "shouldDelete": true
      }
    ],
    "route": {
      "plannedRouteId": "string"
    },
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      },
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ],
    "sensors": [
      {
        "identifier": {
          "type": "TEMPERATURE",
          "value": "string"
        },
        "min": 0.1,
        "max": 0.1,
        "target": 0.1
      }
    ],
    "shippingDetails": {
      "hazmatDetails": {
        "hazardClasses": [
          "string"
        ]
      },
      "multipleDrivers": true,
      "truckDetails": {
        "truckDimensions": {
          "height": 0,
          "length": 0,
          "unitOfMeasure": "IN",
          "width": 0
        },
        "truckType": "AUTO_CARRIER",
        "weight": 0,
        "weightUnitOfMeasure": "LB"
      }
    },
    "shipmentDetails": {
      "lineItems": [
        {
          "commodityCode": "string",
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          },
          "description": "string",
          "deliveryStopNumber": 0,
          "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
          "handlingUnitQuantity": 0,
          "handlingUnitPackageType": "PLT",
          "itemIdentifiers": [
            {
              "type": "PURCHASE_ORDER",
              "value": "string"
            }
          ],
          "itemQuantity": 0,
          "itemPackageType": "BAG",
          "involvedParties": [
            {
              "addressInfo": {
                "addressLines": [
                  null
                ],
                "addressLabel": "string",
                "city": "string",
                "country": "US",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "postalCode": "string",
                "state": "string"
              },
              "contactInfo": {
                "companyName": "string",
                "email": "user@example.com",
                "familyName": "string",
                "givenName": "string",
                "mobilePhoneNumber": "string",
                "phoneNumber": "string"
              },
              "identifyingCodes": {
                "codeListProvider": "WAVE",
                "codeListName": "DID",
                "partyCode": "string"
              },
              "locationIdentifiers": [
                {}
              ],
              "partyType": "SHIPPER",
              "vatNumber": "string"
            }
          ],
          "monetaryValue": {
            "amount": 0,
            "currency": "USD"
          },
          "pickupStopNumber": 0,
          "subLineItems": [
            {
              "commodityCode": "string",
              "contact": {
                "companyName": "string",
                "contactName": "string",
                "email": "string",
                "faxNumber": "string",
                "faxNumberCountryCode": "string",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "string",
                "phoneNumber2": "string",
                "phoneNumber2CountryCode": "string"
              },
              "description": "string",
              "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
              "itemIdentifiers": [
                {}
              ],
              "itemQuantity": 0,
              "itemPackageType": "BAG",
              "involvedParties": [
                {
                  "locationIdentifiers": []
                }
              ],
              "monetaryValue": {
                "amount": 0,
                "currency": "USD"
              },
              "totalWeight": {
                "weight": 0,
                "weightUnit": "LB"
              }
            }
          ],
          "totalWeight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [
      "RISK_MANAGEMENT"
    ],
    "trackingDetails": [
      {
        "equipmentIdentifier": {
          "shouldDelete": true,
          "type": "MOBILE_PHONE_NUMBER",
          "value": "string"
        },
        "equipmentIdentifierSource": "CUSTOMER",
        "trackingType": "MOBILE_PHONE"
      }
    ]
  }'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(TruckloadShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  }
}

start tracking a truckload shipment

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

curl -i -X POST \
  'https://na12.api.project44.com/api/v4/tl/shipments?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "enableIntelligentMatching": true,
      "fallBackToDefaultAccountGroup": true,
      "webhookEndpointConfigName": "string"
    },
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "contents": [
      {
        "minTemperatureThreshold": 0.1,
        "maxTemperatureThreshold": 0.1,
        "temperatureSetPoint": 0.1
      }
    ],
    "equipmentIdentifiers": [
      {
        "shouldDelete": true,
        "type": "MOBILE_PHONE_NUMBER",
        "value": "string"
      }
    ],
    "equipmentIdentifierChanges": [
      {
        "type": "MOBILE_PHONE_NUMBER",
        "timestamp": "2019-08-24T14:15:22Z",
        "value": "string"
      }
    ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [
      {
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "pointOfInterestName": "string",
        "pointOfInterestType": "GENERAL",
        "pointOfInterestDescription": "string",
        "pointOfInterestId": "string",
        "shouldDelete": true
      }
    ],
    "route": {
      "plannedRouteId": "string"
    },
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      },
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ],
    "sensors": [
      {
        "identifier": {
          "type": "TEMPERATURE",
          "value": "string"
        },
        "min": 0.1,
        "max": 0.1,
        "target": 0.1
      }
    ],
    "shippingDetails": {
      "hazmatDetails": {
        "hazardClasses": [
          "string"
        ]
      },
      "multipleDrivers": true,
      "truckDetails": {
        "truckDimensions": {
          "height": 0,
          "length": 0,
          "unitOfMeasure": "IN",
          "width": 0
        },
        "truckType": "AUTO_CARRIER",
        "weight": 0,
        "weightUnitOfMeasure": "LB"
      }
    },
    "shipmentDetails": {
      "lineItems": [
        {
          "commodityCode": "string",
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          },
          "description": "string",
          "deliveryStopNumber": 0,
          "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
          "handlingUnitQuantity": 0,
          "handlingUnitPackageType": "PLT",
          "itemIdentifiers": [
            {
              "type": "PURCHASE_ORDER",
              "value": "string"
            }
          ],
          "itemQuantity": 0,
          "itemPackageType": "BAG",
          "involvedParties": [
            {
              "addressInfo": {
                "addressLines": [
                  null
                ],
                "addressLabel": "string",
                "city": "string",
                "country": "US",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "postalCode": "string",
                "state": "string"
              },
              "contactInfo": {
                "companyName": "string",
                "email": "user@example.com",
                "familyName": "string",
                "givenName": "string",
                "mobilePhoneNumber": "string",
                "phoneNumber": "string"
              },
              "identifyingCodes": {
                "codeListProvider": "WAVE",
                "codeListName": "DID",
                "partyCode": "string"
              },
              "locationIdentifiers": [
                {}
              ],
              "partyType": "SHIPPER",
              "vatNumber": "string"
            }
          ],
          "monetaryValue": {
            "amount": 0,
            "currency": "USD"
          },
          "pickupStopNumber": 0,
          "subLineItems": [
            {
              "commodityCode": "string",
              "contact": {
                "companyName": "string",
                "contactName": "string",
                "email": "string",
                "faxNumber": "string",
                "faxNumberCountryCode": "string",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "string",
                "phoneNumber2": "string",
                "phoneNumber2CountryCode": "string"
              },
              "description": "string",
              "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
              "itemIdentifiers": [
                {}
              ],
              "itemQuantity": 0,
              "itemPackageType": "BAG",
              "involvedParties": [
                {
                  "locationIdentifiers": []
                }
              ],
              "monetaryValue": {
                "amount": 0,
                "currency": "USD"
              },
              "totalWeight": {
                "weight": 0,
                "weightUnit": "LB"
              }
            }
          ],
          "totalWeight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [
      "RISK_MANAGEMENT"
    ],
    "trackingDetails": [
      {
        "equipmentIdentifier": {
          "shouldDelete": true,
          "type": "MOBILE_PHONE_NUMBER",
          "value": "string"
        },
        "equipmentIdentifierSource": "CUSTOMER",
        "trackingType": "MOBILE_PHONE"
      }
    ]
  }'

Responses

Created

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(TruckloadShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  }
}

Delete truckload shipment by shipment identifier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
shipmentQueryobject(TruckloadShipmentQuery)required
shipmentQuery.​carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

shipmentQuery.​shipmentIdentifierobject(TruckloadShipmentIdentifier)

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

curl -i -X DELETE \
  'https://na12.api.project44.com/api/v4/tl/shipments?accountNonExpired=true&accountNonLocked=true&carrierIdentifier=%5Bobject%20Object%5D&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&shipmentIdentifier=%5Bobject%20Object%5D&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Get Truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being queried.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X GET \
  'https://na12.api.project44.com/api/v4/tl/shipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

Response
{
  "apiConfiguration": {
    "enableIntelligentMatching": true,
    "fallBackToDefaultAccountGroup": true,
    "webhookEndpointConfigName": "string"
  },
  "attributes": [
    { … }
  ],
  "carrierIdentifier": {
    "type": "SCAC",
    "value": "string"
  },
  "capacityProviderAccountGroup": {
    "accounts": [ … ],
    "code": "string"
  },
  "contents": [
    { … }
  ],
  "equipmentIdentifiers": [
    { … }
  ],
  "equipmentIdentifierChanges": [
    { … }
  ],
  "id": 0,
  "idleDuration": 0,
  "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
  "pointsOfInterest": [
    { … }
  ],
  "route": {
    "plannedRouteId": "string"
  },
  "shipmentIdentifiers": [
    { … }
  ],
  "shipmentStops": [
    { … },
    { … }
  ],
  "sensors": [
    { … }
  ],
  "shippingDetails": {
    "hazmatDetails": { … },
    "multipleDrivers": true,
    "truckDetails": { … }
  },
  "shipmentDetails": {
    "lineItems": [ … ]
  },
  "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
  "scope": [
    "RISK_MANAGEMENT"
  ],
  "trackingDetails": [
    { … }
  ]
}

Update a truckload shipment

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being updated.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
apiConfigurationobject(TruckloadShipmentApiConfiguration)

Contains fields used to configure the truckload shipment API.

attributesArray of objects(ShipmentAttribute)[ 0 .. 25 ] items

${TruckloadShipment.apiModel.attributes.value}

carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

capacityProviderAccountGroupobject(CapacityProviderAccountGroup)

The requested capacity provider account group containing the account used for authentication with the capacity provider's API.

contentsArray of objects(ShipmentContentApiModel)[ 0 .. 250 ] items

${TruckloadShipment.apiModel.contents.value}

equipmentIdentifiersArray of objects(TruckloadEquipmentIdentifier)

${TruckloadShipment.apiModel.equipmentIdentifiers.value}

equipmentIdentifierChangesArray of objects(TruckloadEquipmentIdentifierChange)[ 0 .. 20 ] items

${TruckloadShipment.apiModel.equipmentIdentifierChanges.value}

idinteger(int64)

${TruckloadShipment.apiModel.id.value}

idleDurationinteger(int64)

${TruckloadShipment.apiModel.idleDuration.value}

masterShipmentIdstring(uuid)

${TruckloadShipment.apiModel.masterShipmentId.value}

pointsOfInterestArray of objects(TruckloadShipmentPointOfInterest)

${TruckloadShipment.apiModel.pointOfInterest.value}

routeobject(Route)

Route information for the shipment

shipmentIdentifiersArray of objects(TruckloadShipmentIdentifier)non-empty

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

shipmentStopsArray of objects(TruckloadShipmentStop)[ 2 .. 100 ] items

${TruckloadShipment.apiModel.shipmentStops.value}

sensorsArray of objects(TruckloadShipmentSensor)

${TruckloadShipment.apiModel.sensors.value}

shippingDetailsobject(TruckloadShippingDetails)

Contains fields which influence the way project44 calculates arrival estimates for stops.

shipmentDetailsobject(TruckloadTrackingShipmentDetails)

Contains fields which pertain to the shipment contents.

shipmentLegIdstring(uuid)

${TruckloadShipment.apiModel.shipmentLegId.value}

scopeArray of strings

${TruckloadShipment.apiModel.scope.value}

Items Enum"RISK_MANAGEMENT""ROUTE_DEVIATION""IDLING"
trackingDetailsArray of objects(TruckloadTrackingMethodDetails)

${TruckloadShipment.apiModel.trackingDetails.value}

curl -i -X PUT \
  'https://na12.api.project44.com/api/v4/tl/shipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiConfiguration": {
      "enableIntelligentMatching": true,
      "fallBackToDefaultAccountGroup": true,
      "webhookEndpointConfigName": "string"
    },
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "carrierIdentifier": {
      "type": "SCAC",
      "value": "string"
    },
    "capacityProviderAccountGroup": {
      "accounts": [
        {
          "code": "string"
        }
      ],
      "code": "string"
    },
    "contents": [
      {
        "minTemperatureThreshold": 0.1,
        "maxTemperatureThreshold": 0.1,
        "temperatureSetPoint": 0.1
      }
    ],
    "equipmentIdentifiers": [
      {
        "shouldDelete": true,
        "type": "MOBILE_PHONE_NUMBER",
        "value": "string"
      }
    ],
    "equipmentIdentifierChanges": [
      {
        "type": "MOBILE_PHONE_NUMBER",
        "timestamp": "2019-08-24T14:15:22Z",
        "value": "string"
      }
    ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [
      {
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "pointOfInterestName": "string",
        "pointOfInterestType": "GENERAL",
        "pointOfInterestDescription": "string",
        "pointOfInterestId": "string",
        "shouldDelete": true
      }
    ],
    "route": {
      "plannedRouteId": "string"
    },
    "shipmentIdentifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    ],
    "shipmentStops": [
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      },
      {
        "appointmentWindow": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "localTimeZoneIdentifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z"
        },
        "additionalAppointmentWindows": [
          {
            "appointmentWindow": {
              "endDateTime": "2019-08-24T14:15:22Z",
              "localTimeZoneIdentifier": "string",
              "startDateTime": "2019-08-24T14:15:22Z"
            },
            "appointmentStatus": "PENDING",
            "identifiers": [
              {
                "type": "DOCK",
                "value": "string"
              }
            ],
            "type": "STRATEGIC"
          }
        ],
        "externalArrivalEstimate": {
          "dateTime": "2019-08-24T14:15:22Z",
          "source": "SHIPPER"
        },
        "geoCoordinates": {
          "latitude": -90,
          "longitude": -180
        },
        "involvedParties": [
          {
            "addressInfo": {
              "addressLines": [
                "string"
              ],
              "addressLabel": "string",
              "city": "string",
              "country": "US",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "postalCode": "string",
              "state": "string"
            },
            "contactInfo": {
              "companyName": "string",
              "email": "user@example.com",
              "familyName": "string",
              "givenName": "string",
              "mobilePhoneNumber": "string",
              "phoneNumber": "string"
            },
            "identifyingCodes": {
              "codeListProvider": "WAVE",
              "codeListName": "DID",
              "partyCode": "string"
            },
            "locationIdentifiers": [
              {
                "type": "EXTERNAL",
                "value": "string"
              }
            ],
            "partyType": "SHIPPER",
            "vatNumber": "string"
          }
        ],
        "location": {
          "address": {
            "addressLines": [
              "string"
            ],
            "city": "string",
            "country": "US",
            "postalCode": "string",
            "state": "string"
          },
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          }
        },
        "locationIdentifiers": [
          {
            "type": "EXTERNAL",
            "value": "string"
          }
        ],
        "stopNumber": 1,
        "stopName": "string",
        "stopDescription": "string",
        "stopType": "PICKUP",
        "stopReferenceId": "string",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
      }
    ],
    "sensors": [
      {
        "identifier": {
          "type": "TEMPERATURE",
          "value": "string"
        },
        "min": 0.1,
        "max": 0.1,
        "target": 0.1
      }
    ],
    "shippingDetails": {
      "hazmatDetails": {
        "hazardClasses": [
          "string"
        ]
      },
      "multipleDrivers": true,
      "truckDetails": {
        "truckDimensions": {
          "height": 0,
          "length": 0,
          "unitOfMeasure": "IN",
          "width": 0
        },
        "truckType": "AUTO_CARRIER",
        "weight": 0,
        "weightUnitOfMeasure": "LB"
      }
    },
    "shipmentDetails": {
      "lineItems": [
        {
          "commodityCode": "string",
          "contact": {
            "companyName": "string",
            "contactName": "string",
            "email": "string",
            "faxNumber": "string",
            "faxNumberCountryCode": "string",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "string",
            "phoneNumber2": "string",
            "phoneNumber2CountryCode": "string"
          },
          "description": "string",
          "deliveryStopNumber": 0,
          "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
          "handlingUnitQuantity": 0,
          "handlingUnitPackageType": "PLT",
          "itemIdentifiers": [
            {
              "type": "PURCHASE_ORDER",
              "value": "string"
            }
          ],
          "itemQuantity": 0,
          "itemPackageType": "BAG",
          "involvedParties": [
            {
              "addressInfo": {
                "addressLines": [
                  null
                ],
                "addressLabel": "string",
                "city": "string",
                "country": "US",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "postalCode": "string",
                "state": "string"
              },
              "contactInfo": {
                "companyName": "string",
                "email": "user@example.com",
                "familyName": "string",
                "givenName": "string",
                "mobilePhoneNumber": "string",
                "phoneNumber": "string"
              },
              "identifyingCodes": {
                "codeListProvider": "WAVE",
                "codeListName": "DID",
                "partyCode": "string"
              },
              "locationIdentifiers": [
                {}
              ],
              "partyType": "SHIPPER",
              "vatNumber": "string"
            }
          ],
          "monetaryValue": {
            "amount": 0,
            "currency": "USD"
          },
          "pickupStopNumber": 0,
          "subLineItems": [
            {
              "commodityCode": "string",
              "contact": {
                "companyName": "string",
                "contactName": "string",
                "email": "string",
                "faxNumber": "string",
                "faxNumberCountryCode": "string",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "string",
                "phoneNumber2": "string",
                "phoneNumber2CountryCode": "string"
              },
              "description": "string",
              "freightClass": "50,55,60,65,70,77.5,85,92.5,100,110,125,150,175,200,250,300,400,500",
              "itemIdentifiers": [
                {}
              ],
              "itemQuantity": 0,
              "itemPackageType": "BAG",
              "involvedParties": [
                {
                  "locationIdentifiers": []
                }
              ],
              "monetaryValue": {
                "amount": 0,
                "currency": "USD"
              },
              "totalWeight": {
                "weight": 0,
                "weightUnit": "LB"
              }
            }
          ],
          "totalWeight": {
            "weight": 0,
            "weightUnit": "LB"
          }
        }
      ]
    },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [
      "RISK_MANAGEMENT"
    ],
    "trackingDetails": [
      {
        "equipmentIdentifier": {
          "shouldDelete": true,
          "type": "MOBILE_PHONE_NUMBER",
          "value": "string"
        },
        "equipmentIdentifierSource": "CUSTOMER",
        "trackingType": "MOBILE_PHONE"
      }
    ]
  }'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentConfirmation.apiModel.infoMessages.value}

shipmentobject(TruckloadShipment)
Response
{
  "infoMessages": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  }
}

Delete truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being deleted.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X DELETE \
  'https://na12.api.project44.com/api/v4/tl/shipments/{id}?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Create action for existing truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment to which this action applies.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
Body
required
codestring

${TruckloadShipmentAction.apiModel.code.value}

Value"CANCEL"
curl -i -X POST \
  'https://na12.api.project44.com/api/v4/tl/shipments/{id}/actions?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "CANCEL"
  }'

Responses

Created

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentActionConfirmation.apiModel.infoMessages.value}

Response
{
  "infoMessages": [
    { … }
  ]
}

Request ad hoc equipment approval from the tracking provider

Request

Path
idinteger(int64)required

The project44-generated id for the shipment.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
curl -i -X POST \
  'https://na12.api.project44.com/api/v4/tl/shipments/{id}/equipmentapprovals/requests?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Get status of truckload shipment by unique system id

Request

Path
idinteger(int64)required

The project44-generated id of the shipment being queried.

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
includeStatusHistoryboolean

Whether shipment status history ('statusUpdates') should be included in the response.

Default false
includeSensorHistoryboolean

Whether shipment sensor history ('sensorHistory') should be included in the response.

Default false
includeMapUrlboolean

Whether a publicly accessible URL to the shipment details page should be included in the response.

Default false
curl -i -X GET \
  'https://na12.api.project44.com/api/v4/tl/shipments/{id}/statuses?accountNonExpired=true&accountNonLocked=true&credentialsNonExpired=true&enabled=true&id=0&includeMapUrl=false&includeSensorHistory=false&includeStatusHistory=false&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentStatus.apiModel.infoMessages.value}

latestStatusUpdateobject(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

latestStopStatusesArray of objects(TruckloadShipmentStopStatus)

${TruckloadShipmentStatus.apiModel.latestStopStatuses.value}

mapUrlstring

${TruckloadShipmentStatus.apiModel.mapUrl.value}

notificationRuleobject(TruckloadShipmentNotificationRule)

Contains fields describing properties of rule that triggered a push notification

pointOfInterestStatusArray of objects(TruckloadShipmentPointOfInterestStatus)

${TruckloadShipmentStatus.apiModel.pointOfInterestStatus.value}

shipmentobject(TruckloadShipment)
statusUpdatesArray of objects(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

sensorHistoriesArray of objects(TruckloadShipmentSensorHistory)

${TruckloadShipmentStatus.apiModel.sensorHistories.value}

Response
{
  "infoMessages": [
    { … }
  ],
  "latestStatusUpdate": {
    "address": { … },
    "geoCoordinates": { … },
    "statusCode": "DISPATCHED",
    "statusReason": { … },
    "stopNumber": 0,
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "latestStopStatuses": [
    { … }
  ],
  "mapUrl": "string",
  "notificationRule": {
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.value}": "DEPRECATED_SHIPMENT_LATE",
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.ruleInfo}": { … }
  },
  "pointOfInterestStatus": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  },
  "statusUpdates": [
    { … }
  ],
  "sensorHistories": [
    { … }
  ]
}

Get status of a truckload shipment by shipment identifier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
shipmentQueryobject(TruckloadShipmentQuery)required
shipmentQuery.​carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

shipmentQuery.​shipmentIdentifierobject(TruckloadShipmentIdentifier)

${TruckloadShipment.apiModel.shipmentIdentifiers.value}

includeStatusHistoryboolean

Whether shipment status history ('statusUpdates') should be included in the response.

Default false
includeSensorHistoryboolean

Whether shipment sensor history ('sensorHistory') should be included in the response.

Default false
includeMapUrlboolean

Whether a publicly accessible URL to the shipment details page should be included in the response.

Default false
curl -i -X GET \
  'https://na12.api.project44.com/api/v4/tl/shipments/statuses?accountNonExpired=true&accountNonLocked=true&carrierIdentifier=%5Bobject%20Object%5D&credentialsNonExpired=true&enabled=true&id=0&includeMapUrl=false&includeSensorHistory=false&includeStatusHistory=false&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&shipmentIdentifier=%5Bobject%20Object%5D&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
infoMessagesArray of objects(Message)

${TruckloadShipmentStatus.apiModel.infoMessages.value}

latestStatusUpdateobject(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

latestStopStatusesArray of objects(TruckloadShipmentStopStatus)

${TruckloadShipmentStatus.apiModel.latestStopStatuses.value}

mapUrlstring

${TruckloadShipmentStatus.apiModel.mapUrl.value}

notificationRuleobject(TruckloadShipmentNotificationRule)

Contains fields describing properties of rule that triggered a push notification

pointOfInterestStatusArray of objects(TruckloadShipmentPointOfInterestStatus)

${TruckloadShipmentStatus.apiModel.pointOfInterestStatus.value}

shipmentobject(TruckloadShipment)
statusUpdatesArray of objects(TruckloadShipmentStatusUpdate)

${TruckloadShipmentStatus.apiModel.statusUpdates.value}

sensorHistoriesArray of objects(TruckloadShipmentSensorHistory)

${TruckloadShipmentStatus.apiModel.sensorHistories.value}

Response
{
  "infoMessages": [
    { … }
  ],
  "latestStatusUpdate": {
    "address": { … },
    "geoCoordinates": { … },
    "statusCode": "DISPATCHED",
    "statusReason": { … },
    "stopNumber": 0,
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "latestStopStatuses": [
    { … }
  ],
  "mapUrl": "string",
  "notificationRule": {
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.value}": "DEPRECATED_SHIPMENT_LATE",
    "${TruckloadShipmentNotificationRule.apiModel.ruleType.ruleInfo}": { … }
  },
  "pointOfInterestStatus": [
    { … }
  ],
  "shipment": {
    "apiConfiguration": { … },
    "attributes": [ … ],
    "carrierIdentifier": { … },
    "capacityProviderAccountGroup": { … },
    "contents": [ … ],
    "equipmentIdentifiers": [ … ],
    "equipmentIdentifierChanges": [ … ],
    "id": 0,
    "idleDuration": 0,
    "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
    "pointsOfInterest": [ … ],
    "route": { … },
    "shipmentIdentifiers": [ … ],
    "shipmentStops": [ … ],
    "sensors": [ … ],
    "shippingDetails": { … },
    "shipmentDetails": { … },
    "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
    "scope": [ … ],
    "trackingDetails": [ … ]
  },
  "statusUpdates": [
    { … }
  ],
  "sensorHistories": [
    { … }
  ]
}

Get available shipment tracking methods for a carrier

Request

Query
userobject(UserPrincipalDomain)required
user.​accountNonExpiredboolean
user.​accountNonLockedboolean
user.​credentialsNonExpiredboolean
user.​enabledboolean
user.​idinteger(int64)
user.​localestring
user.​registrationDatestring(date-time)
user.​tenantIdinteger(int64)
user.​tenantUuidstring(uuid)
user.​tenantPurposestring
Enum"DEFAULT""DEMO""PROOF_OF_CONCEPT""INTERNAL_TEST""TEST""PRODUCTION""ARCHIVED""INTERNAL_INFRASTRUCTURE"
user.​usernamestring
trackingMethodQueryobject(TruckloadShipmentTrackingMethodQuery)required
trackingMethodQuery.​carrierIdentifierobject(CapacityProviderIdentifier)

A capacity provider identifier object.

curl -i -X GET \
  'https://na12.api.project44.com/api/v4/tl/shipments/trackingmethods?accountNonExpired=true&accountNonLocked=true&carrierIdentifier=%5Bobject%20Object%5D&credentialsNonExpired=true&enabled=true&id=0&locale=string&registrationDate=2019-08-24T14%3A15%3A22Z&tenantId=0&tenantPurpose=DEFAULT&tenantUuid=e46705ba-31a8-4f12-b6d3-f41ec1d77a9a&username=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
trackingMethodsArray of objects(TruckloadShipmentTrackingMethod)

${TruckloadShipmentTrackingMethods.apiModel.trackingMethods.value}

Response
{
  "trackingMethods": [
    { … }
  ]
}

TL: Webhook

...

Operations

Parcel: Tracking

...

Operations

Parcel: Webhook

...

Operations

Rail: Tracking

...

Operations

Ocean: Tracking

...

Operations