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.
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.
load
The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.
The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.
Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.
The project44-generated id of the shipment with which the load is associated.
curl -i -X POST \ https://na12.api.project44.com/api/v4/loads \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "createdDateTime": "string", "deletedDateTime": "string", "deliveryStopReference": { "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43" }, "description": "string", "handlingUnits": { "details": [ { "cubicDimension": { "height": 0, "length": 0, "unit": "IN", "width": 0 }, "handlingUnitType": "BAG", "quantity": 0, "volume": { "unit": "CUBIC_FT", "value": 0 }, "weight": { "weight": 0, "weightUnit": "LB" } } ] }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "involvedParties": [ { "partyIdentifiers": [ { "type": "ACCOUNT", "value": "string" } ] } ], "items": [ { "description": "string", "identifiers": [ { "type": "STOCK_KEEPING_UNIT", "value": "string" } ], "orderIdentifierReferences": [ { "orderId": "string", "orderIdentifier": "string", "orderIdentifierAuthority": "string", "orderType": "PURCHASE_ORDER" } ], "unitQuantity": 0, "unitType": "BAG" } ], "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "pickupStopReference": { "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43" } }'
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
curl -i -X DELETE \ 'https://na12.api.project44.com/api/v4/loads/{loadId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "errorMessage": "string", "errors": [ { … } ], "httpMessage": "string", "httpStatusCode": 0, "supportReferenceId": "string" }
curl -i -X GET \ 'https://na12.api.project44.com/api/v4/loads/{loadId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.
The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.
Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.
The project44-generated id of the shipment with which the load is associated.
{ "createdDateTime": "string", "deletedDateTime": "string", "deliveryStopReference": { "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43" }, "description": "string", "handlingUnits": { "details": [ … ] }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { … } ], "involvedParties": [ { … } ], "items": [ { … } ], "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "pickupStopReference": { "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43" } }
load
The unique project44-generated id of the load. This can be null when the load is created, but will always exist in the response after the load has been created.
The identifiers that can identify this Load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as Purchase Order or ASN.
Parties which are specifically related to this load and the identifiers which are associated with those parties. This identifies the relationship between the load and its relevant parties.
The project44-generated id of the shipment with which the load is associated.
curl -i -X PUT \ 'https://na12.api.project44.com/api/v4/loads/{loadId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "createdDateTime": "string", "deletedDateTime": "string", "deliveryStopReference": { "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43" }, "description": "string", "handlingUnits": { "details": [ { "cubicDimension": { "height": 0, "length": 0, "unit": "IN", "width": 0 }, "handlingUnitType": "BAG", "quantity": 0, "volume": { "unit": "CUBIC_FT", "value": 0 }, "weight": { "weight": 0, "weightUnit": "LB" } } ] }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "involvedParties": [ { "partyIdentifiers": [ { "type": "ACCOUNT", "value": "string" } ] } ], "items": [ { "description": "string", "identifiers": [ { "type": "STOCK_KEEPING_UNIT", "value": "string" } ], "orderIdentifierReferences": [ { "orderId": "string", "orderIdentifier": "string", "orderIdentifierAuthority": "string", "orderType": "PURCHASE_ORDER" } ], "unitQuantity": 0, "unitType": "BAG" } ], "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "pickupStopReference": { "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43" } }'
{ "errorMessage": "string", "errors": [ { … } ], "httpMessage": "string", "httpStatusCode": 0, "supportReferenceId": "string" }
curl -i -X GET \ 'https://na12.api.project44.com/api/v4/shipments/{masterShipmentId}/loads?page=1&size=100' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "paginationInfo": { "pageNumber": 0, "pageSize": 0, "total": 0 }, "results": [ { … } ] }