Version 4.0.0 of project44's API
License © 2024 project44 - Terms of Use
Version 4.0.0 of project44's API
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 VOC 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.
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).
project44's Truckload Tracking endpoints give you or your customers visibility into your truckload shipments, including such features as predictive ETAs and temperature tracking. Use these endpoints to initialize (POST), track (GET), update (PUT), cancel (POST) or delete(DELETE) truckload shipments. You can return shipment information by either unique system ID or by identifier.
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/tl/assets?capacityProviderIdentifierType=SCAC&capacityProviderIdentifierValue=string&page=1&size=100' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "infoMessages": [ { … } ], "paginationInfo": { "total": 0, "pageSize": 0, "pageNumber": 0 }, "results": [ { … } ] }
Use this endpoint to test an equipment identifier to see if it is a valid equipment identifier for the given carrier that may be used for tracking. If the carrier's tracking vendor does not support validating equipment identifiers without initiating tracking, then the endpoint will always report that the identifier is valid.
| Equipment ID Type | valid | exists | Notes |
|---|---|---|---|
EMERSON_DEVICE_ID, SENSITECH_DEVICE_ID, TIVE_DEVICE_ID, VEHICLE_ID | True, if the equipment exists and is considered as active equipment by project44. This equipment is owned by the capacity provider and sent in the query params. Validity depends on the type of vendor. | True, if the equipment exists in the project44 system This equipment is owned by the capacity provider and passed as an argument to the endpoint (see | The capacity provider identifier passed as an argument to the endpoint must be the owner of the equipment. |
LICENSE_PLATE | True, if the asset can be used for tracking the shipment by the requester. | True, if the license plate exists in the project44 system. | capacity provider identifier should be set to one of identifiers of requesting organisation |
MOBILE_PHONE_NUMBER | True, if there is a driver who signed up with the given phone number OR if there is no driver who signed up with the given phone number but the phone number can be used to create a shipment. (see | True, if the mobile phone was used in the past to create a shipment. False, if there is no driver with such phone number in project44 network. |
Capacity provider identifier type.
Optional field indicating whether equipment identifier should be deleted.
The type of the equipment identifier.
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/tl/equipment/validate?capacityProviderIdentifier.type=SCAC&capacityProviderIdentifier.value=string&equipmentIdentifier.shouldDelete=true&equipmentIdentifier.type=MOBILE_PHONE_NUMBER&equipmentIdentifier.value=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
True if asset exists in project44 platform. If equipment type is not MOBILE_PHONE_NUMBER and LICENSE_PLATE, capacity provider must be the owner of the equipment, otherwise false.
${TruckloadEquipmentValidation.apiModel.ownershipStatus.value}
{ "exists": true, "ownershipStatus": "CONNECTED", "valid": true }
curl -i -X DELETE \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/tl/shipments?carrierIdentifier.type=SCAC&carrierIdentifier.value=string&shipmentIdentifier.type=BILL_OF_LADING&shipmentIdentifier.value=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "httpStatusCode": 0, "httpMessage": "string", "errorMessage": "string", "errors": [ { … } ], "supportReferenceId": "string" }
Use this POST call to start a tracking job, initializing Truckload Tracking. Note that If the shipment is initialized by using GeoCoordinates instead of an address, it may be possible that a street address will not be returned in the response.
shipment
Contains fields used to configure the truckload shipment API.
A list of up to 5 attributes (name/value pairs) to associate with this shipment. These values will be returned unchanged with each status response for the shipment and can also be used to group together related shipments in reporting scenarios, e.g. all shipments tracked for "division":"Central". The attribute names have to be unique within the list. These attributes may optionally be predefined by your organization's admin
The requested capacity provider account group containing the account used for authentication with the capacity provider's API.
A list of equipment identifier changes that should be applied to the shipment
A user-defined list of equipment identifiers identifying truckload equipment that can be tracked, such as cell phones and electronic logging devices (ELDs). These need not be unique to this shipment.
The project44-generated id for the shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment.
Computed value representing how long (in minutes) shipment is being Idle. This value is available while whole status history is being requested.
The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment.
A user-defined list of all the point of interest for the shipment.
Contains fields which pertain to the shipment contents.
A user-defined list of shipment identifiers that are unique to this shipment and carrier identifier. These may be used in subsequent API calls along with the carrier identifier to reference a shipment. They may also be used by project44 to track the shipment. Only one shipment identifier of each type may be provided.
The project44-generated id for the truckload shipment. This id may be used in subsequent API calls to reference a shipment.
A user-defined list of all the shipment stops for the shipment, including stop locations and appointment windows. This list must contain the shipment's origin and destination and any stops of interest in between (other pickup or delivery locations).
Contains fields which influence the way project44 calculates arrival estimates for stops.
Contains information about how we obtain tracking data for the shipment. Currently, this list always includes either zero or one active tracking method. Future versions will be able to combine data from more than one tracking method. In that case, the primary tracking method will be listed first.
curl -i -X POST \ https://developers.project44.com/_mock/api-reference/api-docs/api/v4/tl/shipments \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "apiConfiguration": { "enableIntelligentMatching": true, "fallBackToDefaultAccountGroup": true, "webhookEndpointConfigName": "string" }, "attributes": [ { "name": "string", "predefined": true, "value": "string", "values": [ "string" ] } ], "capacityProviderAccountGroup": { "accounts": [ { "code": "string" } ], "code": "string" }, "carrierIdentifier": { "type": "SCAC", "value": "string" }, "equipmentIdentifierChanges": [ { "timestamp": "string", "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "id": 0, "idleDuration": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "pointsOfInterest": [ { "geoCoordinates": { "latitude": -90, "longitude": -180 }, "location": { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "locationIdentifiers": [ { "type": "EXTERNAL", "value": "string" } ], "pointOfInterestDescription": "string", "pointOfInterestId": "string", "pointOfInterestName": "string", "pointOfInterestType": "GENERAL", "shouldDelete": true } ], "sensors": [ { "identifier": { "type": "TEMPERATURE", "value": "string" }, "max": 0.1, "min": 0.1, "target": 0.1 } ], "shipmentDetails": { "lineItems": [ { "commodityCode": "string", "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" }, "deliveryStopNumber": 0, "description": "string", "freightClass": "50", "handlingUnitPackageType": "PLT", "handlingUnitQuantity": 0, "involvedParties": [ { "partyIdentifiers": [ {} ] } ], "itemIdentifiers": [ { "type": "PURCHASE_ORDER", "value": "string" } ], "itemPackageType": "BAG", "itemQuantity": 0, "monetaryValue": { "currency": "USD", "amount": 0 }, "pickupStopNumber": 0, "subLineItems": [ { "commodityCode": "string", "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" }, "description": "string", "freightClass": "50", "involvedParties": [ { "partyIdentifiers": [] } ], "itemIdentifiers": [ {} ], "itemPackageType": "BAG", "itemQuantity": 0, "monetaryValue": { "currency": "USD", "amount": 0 }, "totalWeight": { "weight": 0, "weightUnit": "LB" } } ], "totalWeight": { "weight": 0, "weightUnit": "LB" } } ] }, "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd", "shipmentStops": [ { "additionalAppointmentWindows": [ { "appointmentStatus": "PENDING", "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "identifiers": [ { "type": "DOCK", "value": "string" } ], "type": "STRATEGIC" } ], "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "externalArrivalEstimate": { "dateTime": "string", "source": "SHIPPER" }, "geoCoordinates": { "latitude": -90, "longitude": -180 }, "involvedParties": [ { "partyIdentifiers": [ { "type": "ACCOUNT", "value": "string" } ] } ], "location": { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "locationIdentifiers": [ { "type": "EXTERNAL", "value": "string" } ], "stopDescription": "string", "stopName": "string", "stopNumber": 0, "stopType": "PICKUP", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" } ], "shippingDetails": { "hazmatDetails": { "hazardClasses": [ "string" ] }, "multipleDrivers": true, "truckDetails": { "truckDimensions": { "height": 0, "length": 0, "unitOfMeasure": "IN", "width": 0 }, "truckType": "AUTO_CARRIER", "weight": 0, "weightUnitOfMeasure": "LB" } }, "trackingDetails": [ { "equipmentIdentifier": { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" }, "equipmentIdentifierSource": "CUSTOMER", "trackingType": "MOBILE_PHONE" } ] }'
{ "infoMessages": [ { … } ], "shipment": { "apiConfiguration": { … }, "attributes": [ … ], "capacityProviderAccountGroup": { … }, "carrierIdentifier": { … }, "equipmentIdentifierChanges": [ … ], "equipmentIdentifiers": [ … ], "id": 0, "idleDuration": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "pointsOfInterest": [ … ], "sensors": [ … ], "shipmentDetails": { … }, "shipmentIdentifiers": [ … ], "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd", "shipmentStops": [ … ], "shippingDetails": { … }, "trackingDetails": [ … ] } }
Use this endpoint to update a truckload shipment with a given shipment identifier.
Example: You can update location fields or appointment windows to reflect changes with this endpoint.
Note that tracking information updates are currently not supported. This includes shipmentIdentifiers, capacityProviderAccountGroup, and apiConfiguration changes.* It is suggested to first get the current shipment object from the GET shipment endpoint, make the desired modifications, and then PUT the modified shipment to this endpoint. After the modified shipment is successfully submitted, the updated stops, attributes, shipping details etc. will be applied and used in tracking from then on. If a shipment PUT request comes in with only GeoCoordinates, it is possible that a street address will not be returned in the response.shipment
Contains fields used to configure the truckload shipment API.
A list of up to 5 attributes (name/value pairs) to associate with this shipment. These values will be returned unchanged with each status response for the shipment and can also be used to group together related shipments in reporting scenarios, e.g. all shipments tracked for "division":"Central". The attribute names have to be unique within the list. These attributes may optionally be predefined by your organization's admin
The requested capacity provider account group containing the account used for authentication with the capacity provider's API.
A list of equipment identifier changes that should be applied to the shipment
A user-defined list of equipment identifiers identifying truckload equipment that can be tracked, such as cell phones and electronic logging devices (ELDs). These need not be unique to this shipment.
The project44-generated id for the shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment.
Computed value representing how long (in minutes) shipment is being Idle. This value is available while whole status history is being requested.
The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment.
A user-defined list of all the point of interest for the shipment.
Contains fields which pertain to the shipment contents.
A user-defined list of shipment identifiers that are unique to this shipment and carrier identifier. These may be used in subsequent API calls along with the carrier identifier to reference a shipment. They may also be used by project44 to track the shipment. Only one shipment identifier of each type may be provided.
The project44-generated id for the truckload shipment. This id may be used in subsequent API calls to reference a shipment.
A user-defined list of all the shipment stops for the shipment, including stop locations and appointment windows. This list must contain the shipment's origin and destination and any stops of interest in between (other pickup or delivery locations).
Contains fields which influence the way project44 calculates arrival estimates for stops.
Contains information about how we obtain tracking data for the shipment. Currently, this list always includes either zero or one active tracking method. Future versions will be able to combine data from more than one tracking method. In that case, the primary tracking method will be listed first.
curl -i -X PUT \ https://developers.project44.com/_mock/api-reference/api-docs/api/v4/tl/shipments \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "apiConfiguration": { "enableIntelligentMatching": true, "fallBackToDefaultAccountGroup": true, "webhookEndpointConfigName": "string" }, "attributes": [ { "name": "string", "predefined": true, "value": "string", "values": [ "string" ] } ], "capacityProviderAccountGroup": { "accounts": [ { "code": "string" } ], "code": "string" }, "carrierIdentifier": { "type": "SCAC", "value": "string" }, "equipmentIdentifierChanges": [ { "timestamp": "string", "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "id": 0, "idleDuration": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "pointsOfInterest": [ { "geoCoordinates": { "latitude": -90, "longitude": -180 }, "location": { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "locationIdentifiers": [ { "type": "EXTERNAL", "value": "string" } ], "pointOfInterestDescription": "string", "pointOfInterestId": "string", "pointOfInterestName": "string", "pointOfInterestType": "GENERAL", "shouldDelete": true } ], "sensors": [ { "identifier": { "type": "TEMPERATURE", "value": "string" }, "max": 0.1, "min": 0.1, "target": 0.1 } ], "shipmentDetails": { "lineItems": [ { "commodityCode": "string", "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" }, "deliveryStopNumber": 0, "description": "string", "freightClass": "50", "handlingUnitPackageType": "PLT", "handlingUnitQuantity": 0, "involvedParties": [ { "partyIdentifiers": [ {} ] } ], "itemIdentifiers": [ { "type": "PURCHASE_ORDER", "value": "string" } ], "itemPackageType": "BAG", "itemQuantity": 0, "monetaryValue": { "currency": "USD", "amount": 0 }, "pickupStopNumber": 0, "subLineItems": [ { "commodityCode": "string", "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" }, "description": "string", "freightClass": "50", "involvedParties": [ { "partyIdentifiers": [] } ], "itemIdentifiers": [ {} ], "itemPackageType": "BAG", "itemQuantity": 0, "monetaryValue": { "currency": "USD", "amount": 0 }, "totalWeight": { "weight": 0, "weightUnit": "LB" } } ], "totalWeight": { "weight": 0, "weightUnit": "LB" } } ] }, "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd", "shipmentStops": [ { "additionalAppointmentWindows": [ { "appointmentStatus": "PENDING", "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "identifiers": [ { "type": "DOCK", "value": "string" } ], "type": "STRATEGIC" } ], "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "externalArrivalEstimate": { "dateTime": "string", "source": "SHIPPER" }, "geoCoordinates": { "latitude": -90, "longitude": -180 }, "involvedParties": [ { "partyIdentifiers": [ { "type": "ACCOUNT", "value": "string" } ] } ], "location": { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "locationIdentifiers": [ { "type": "EXTERNAL", "value": "string" } ], "stopDescription": "string", "stopName": "string", "stopNumber": 0, "stopType": "PICKUP", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" } ], "shippingDetails": { "hazmatDetails": { "hazardClasses": [ "string" ] }, "multipleDrivers": true, "truckDetails": { "truckDimensions": { "height": 0, "length": 0, "unitOfMeasure": "IN", "width": 0 }, "truckType": "AUTO_CARRIER", "weight": 0, "weightUnitOfMeasure": "LB" } }, "trackingDetails": [ { "equipmentIdentifier": { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" }, "equipmentIdentifierSource": "CUSTOMER", "trackingType": "MOBILE_PHONE" } ] }'