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.
Manage capacity provider account groups. Groups are used to sort capacity provider accounts on a per customer or location basis.
For example, you can add multiple capacity providers to a group if they all share lanes to the same origin/destination location.
Another example, if certain customers receive different rates for a capacity provider, it may be reasonable to use separate groups for each customer's capacity provider accounts.
Use these APIs to create (POST), retrieve (GET) or delete (DELETE) capacity provider account groups.
Manage capacity provider accounts where a capacity provider is typically used to represent a carrier.
Capacity providers have capacity provider account definitions also known as capacity provider account types. Capacity provider accounts are arranged in sets where each set contains one or more accounts for the same capacity provider. Each capacity provider's service is compatible with one and only one of these capacity provider accounts. Because most capacity providers have only one capacity provider account definition, most sets will contain only one capacity provider account. For capacity providers with more then one account definition, the set of accounts may consist of one account per account definition.
For example, FedEx has a standard account to be used with LTL rating, LTL and Volume LTL dispatch, tracking, and imaging and a separate account for Volume LTL rating. A set of FedEx capacity provider accounts may have a single standard account, a single volume LTL rating account, or both. Providing the capacity provider account set code in the request resolves which capacity provider account to use.
Capacity provider specific credential information is available in the portal.
Use these APIs to create (POST), retrieve (GET), update (POST) or delete (DELETE) capacity provider accounts.
Manage locations. Locations combine physical addresses with contact details and are used in configuring Capacity Provider Accounts and Stop Locations, for example to identify the Bill To party.
Use these APIs to create (POST), update (PUT) or retrieve (GET) locations.
These operations are also all available under the /locations endpoint for backward compatibility.
If the shipment does not exist, this will create a new shipment.
If the shipment is already being tracked (and the corresponding id field is provided), this operation is add only for the provided fields.
Note: This operation only modifies data that the user has provided.
shipment
This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.
An optional user-defined set of custom attributes to associate with this shipment.
All costs incurred for this shipment and the assets contained within.
The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.
Used to identify a shipment.
Only the following identifier types are accepted when creating or updating a shipment:
The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.
List of related shipments of the parent shipment. This is optional.
Route info model that contains the stops and route for the shipment.
curl -i -X POST \ https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/tracking \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "accessGroups": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } ], "attributes": [ { "name": "string", "value": "string", "values": [ "string" ] } ], "costs": [ { "type": "UNKNOWN", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "totalCost": { "currency": "USD", "amount": 0 }, "tier": "UNKNOWN" } ], "createdDateTime": "string", "events": [ { "dateTime": "string", "dateTimes": [ { "type": "UNKNOWN", "dateTime": "2019-08-24T14:15:22Z", "endDateTime": "2019-08-24T14:15:22Z", "lastModifiedDateTime": "2019-08-24T14:15:22Z", "source": "UNKNOWN", "sourceIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "selected": true, "sequence": 0 } ], "description": "string", "details": { "mobileTracking": { "code": "UNKNOWN" }, "ocean": { "code": "UNKNOWN" }, "qualityControl": { "code": "UNKNOWN" } }, "estimateDateTime": "string", "estimateLastCalculatedDateTime": "string", "plannedDateTime": "string", "plannedEndDateTime": "string", "receivedDateTime": "string", "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352", "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43", "type": "UNKNOWN" } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "lastModifiedDateTime": "string", "plan": { "expectedTransportationModes": [ { "enumValue": "AIR" } ] }, "relatedShipments": [ { "accessGroups": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } ], "attributes": [ { "name": "string", "value": "string", "values": [ "string" ] } ], "createdDateTime": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "lastModifiedDateTime": "string", "plan": { "expectedTransportationModes": [ { "enumValue": "AIR" } ] }, "shipmentShareLink": "string" } ], "routeInfo": { "routeSegments": [ { "emissions": { "distance": { "value": 0, "unit": "FT" }, "co2EmissionIntensity": { "value": 0, "unit": "KG_PER_KM" }, "totalCO2Emissions": { "value": 0, "unit": "LB" }, "vehicleInfo": { "weight": { "value": 0, "unit": "LB" }, "type": "string" }, "cargoWeight": { "value": 0, "unit": "LB" }, "loadFactor": 0.1 }, "fromStopId": "257296aa-4e11-4168-b6a7-981b8b94815b", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "toStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56", "transportationMode": "AIR" } ], "stops": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "UNKNOWN", "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } } ] }, "shipmentShareLink": "string" }'
OK
This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.
An optional user-defined set of custom attributes to associate with this shipment.
All costs incurred for this shipment and the assets contained within.
The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.
Used to identify a shipment.
Only the following identifier types are accepted when creating or updating a shipment:
The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.
List of related shipments of the parent shipment. This is optional.
Route info model that contains the stops and route for the shipment.
{ "accessGroups": [ { … } ], "attributes": [ { … } ], "costs": [ { … } ], "createdDateTime": "string", "events": [ { … } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { … } ], "lastModifiedDateTime": "string", "plan": { "expectedTransportationModes": [ … ] }, "relatedShipments": [ { … } ], "routeInfo": { "routeSegments": [ … ], "stops": [ … ] }, "shipmentShareLink": "string" }
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/{shipmentId}/attributes' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
[ { "attributeName": "string", "attributeValues": [ … ] } ]
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/{shipmentId}/eventhistory?includeRouteInfo=false' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
All costs incurred for this shipment and the assets contained within.
All events that occurred for this shipment. Will always be in ascending order by the date the event occurred.
This model is populated when the data is shared across tenants, it conditionally describes which tenant(s) are involved with the shared data using tenant name and tenant UUID.
{ "costs": [ { … } ], "events": [ { … } ], "exceptions": [ { … } ], "sharingContext": { "dataOriginators": [ … ], "recipients": [ … ] }, "shipment": { "accessGroups": [ … ], "attributes": [ … ], "createdDateTime": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ … ], "lastModifiedDateTime": "string", "plan": { … }, "relatedShipments": [ … ], "routeInfo": { … }, "shipmentShareLink": "string" }, "states": [ { … } ] }
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/{shipmentId}/positionhistory?includeRouteInfo=false' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "positions": [ { … } ], "shipment": { "accessGroups": [ … ], "attributes": [ … ], "createdDateTime": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ … ], "lastModifiedDateTime": "string", "plan": { … }, "relatedShipments": [ … ], "routeInfo": { … }, "shipmentShareLink": "string" } }
curl -i -X DELETE \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/{shipmentId}/tracking' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "httpStatusCode": 0, "httpMessage": "string", "errorMessage": "string", "errors": [ { … } ], "supportReferenceId": "string" }
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/{shipmentId}/tracking' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility.
An optional user-defined set of custom attributes to associate with this shipment.
The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.
Used to identify a shipment.
Only the following identifier types are accepted when creating or updating a shipment:
The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.
List of related shipments of the parent shipment. This is optional.
Route info model that contains the stops and route for the shipment.
{ "accessGroups": [ { … } ], "attributes": [ { … } ], "createdDateTime": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { … } ], "lastModifiedDateTime": "string", "plan": { "expectedTransportationModes": [ … ] }, "relatedShipments": [ { … } ], "routeInfo": { "routeSegments": [ … ], "stops": [ … ] }, "shipmentShareLink": "string" }
curl -i -X GET \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/shipments/{shipmentId}/tracking/history' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
All costs incurred for this shipment and the assets contained within.
All events that occurred for this shipment. Will always be in ascending order by the date the event occurred.
Locations where this shipment has been recorded. Data may be down-sampled. Will always be in ascending order by the date that the shipment was at that position.
This model is populated when the data is shared across tenants, it conditionally describes which tenant(s) are involved with the shared data using tenant name and tenant UUID.
{ "costs": [ { … } ], "events": [ { … } ], "exceptions": [ { … } ], "positions": [ { … } ], "sharingContext": { "dataOriginators": [ … ], "recipients": [ … ] }, "shipment": { "accessGroups": [ … ], "attributes": [ … ], "createdDateTime": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ … ], "lastModifiedDateTime": "string", "plan": { … }, "relatedShipments": [ … ], "routeInfo": { … }, "shipmentShareLink": "string" }, "states": [ { … } ] }
curl -i -X PUT \ 'https://developers.project44.com/_mock/api-reference/api-docs/services/tracking/v4/shipments/{shipmentId}/route-segments' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "routeSegments": [ { "fromStop": { "type": "UNKNOWN", "location": { "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } }, "toStop": { "type": "UNKNOWN", "location": { "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } }, "transportationMode": "AIR", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ] } ] }'
{ "httpStatusCode": 400, "httpMessage": "Bad Request", "errors": [ { … } ], "supportReferenceId": "aa119154-bf85-4b6a-958b-497f85d16a70" }
curl -i -X PUT \ https://developers.project44.com/_mock/api-reference/api-docs/services/tracking/v4/route-segments \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "routeSegments": [ { "fromStop": { "type": "UNKNOWN", "location": { "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } }, "toStop": { "type": "UNKNOWN", "location": { "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } }, "transportationMode": "AIR", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ] } ] }'
{ "httpStatusCode": 400, "httpMessage": "Bad Request", "errors": [ { … } ], "supportReferenceId": "4718e890-541f-47d8-a1f0-e1bed7657d22" }
Any standardized 3rd party identifier. Can be used to identify a shipment, freight, vehicle, carrier, or other freight entity.
curl -i -X POST \ 'https://developers.project44.com/_mock/api-reference/api-docs/services/tracking/v4/shipments/{shipmentId}/events-positions' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "events": [ { "type": "UNKNOWN", "description": "string", "dateTime": "2019-08-24T14:15:22Z", "plannedDateTime": "2019-08-24T14:15:22Z", "plannedEndDateTime": "2019-08-24T14:15:22Z", "source": "UNKNOWN", "sourceIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "location": { "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } } ], "positions": [ { "dateTime": "2019-08-24T14:15:22Z", "latitude": -90, "longitude": -180 } ] }'
{ "httpStatusCode": 400, "httpMessage": "Bad Request", "errors": [ { … } ], "supportReferenceId": "781a6e4f-0611-4a3f-9e8b-46f612f50c87" }
Any standardized 3rd party identifier. Can be used to identify a shipment, freight, vehicle, carrier, or other freight entity.
curl -i -X POST \ https://developers.project44.com/_mock/api-reference/api-docs/services/tracking/v4/events-positions \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "events": [ { "type": "UNKNOWN", "description": "string", "dateTime": "2019-08-24T14:15:22Z", "plannedDateTime": "2019-08-24T14:15:22Z", "plannedEndDateTime": "2019-08-24T14:15:22Z", "source": "UNKNOWN", "sourceIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "location": { "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "coordinates": { "latitude": -90, "longitude": -180 }, "timeZone": "string" } } ], "positions": [ { "dateTime": "2019-08-24T14:15:22Z", "latitude": -90, "longitude": -180 } ] }'
{ "httpStatusCode": 400, "httpMessage": "Bad Request", "errors": [ { … } ], "supportReferenceId": "c9708def-7742-4bd0-b117-8b7f1153b4c6" }
Track parcel shipments. Before parcel shipments can be tracked, they must first be initialized with a shipment identifier. Shipments cannot be modified once initialized and tracking has begun. To stop tracking a shipment, delete it.
Use these APIs to initialize (POST), track (GET), or delete (DELETE) parcel shipments.