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).
Use this POST call to start a tracking job, initializing LTL tracking. The tracking job will run for a given duration (designated with the startDateTime and endDateTime parameters), gathering updates from the carrier and reference numbers detailed in the API call. Once a tracking update has been pulled from the carrier into the project44 tracking job, you can access the information via the GET requests below this endpoint. Note that if your dispatch was done through project44, you do not need to initialize tracking. project44 will implicitly start tracking based on the data provided in the dispatch.
shipment
The requested capacity provider account group containing the account used for authentication with the capacity provider's API.
The project44-generated id of the LTL shipment. This may be provided when creating a tracked shipment only if a tracked shipment does not exist with this id but a shipment record does exist in project44's system with this id. This enables linking a dispatched shipment that initially failed to track to its tracking information by passing the id from dispatch. This id will always be returned in the shipment confirmation and may be used in subsequent API calls to reference a shipment.
The project44-generated id that is the UUID equivalent of id. The same rules apply to this value as applies to the id.
The project44-generated id that connects multi-leg shipments agnostic of mode.
A user-defined list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment with the capacity provider.
A list of the shipment stops for the shipment. Two and only two stops must be provided -- one of type 'ORIGIN' and one of type 'DESTINATION'. Stops of type 'TERMINAL' may be added as the shipment is tracked and they are discovered via capacity provider information. Note that 'TERMINAL' will be ignored if provided as part of a PUT.
curl -i -X POST \ https://na12.api.project44.com/api/v4/ltl/trackedshipments \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "apiConfiguration": { "fallBackToDefaultAccountGroup": true }, "capacityProviderAccountGroup": { "accounts": [ { "code": "string" } ], "code": "string" }, "id": 0, "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "shipmentAttributes": [ { "name": "string", "values": [ "string" ] } ], "shipmentIdentifiers": [ { "primaryForType": true, "source": "CUSTOMER", "type": "PRO", "value": "string" } ], "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" }, "geoCoordinates": { "latitude": 0.1, "longitude": 0.1 }, "id": 0, "involvedParties": [ { "partyIdentifiers": [ { "type": "ACCOUNT", "value": "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", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "locationIdentifiers": [ { "type": "EXTERNAL", "value": "string" } ], "stopDescription": "string", "stopName": "string", "stopNumber": 0, "stopType": "ORIGIN", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" } ] }'
{ "infoMessages": [ { … } ], "shipment": { "apiConfiguration": { … }, "capacityProviderAccountGroup": { … }, "id": 0, "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "shipmentAttributes": [ … ], "shipmentIdentifiers": [ … ], "shipmentStops": [ … ] } }
curl -i -X DELETE \ 'https://na12.api.project44.com/api/v4/ltl/trackedshipments/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "errorMessage": "string", "errors": [ { … } ], "httpMessage": "string", "httpStatusCode": 0, "supportReferenceId": "string" }
Use this endpoint to update a shipment. To achieve this, this endpoint deletes the current shipment and creates a new shipment on which it will begin tracking. This updates how we track the shipment but will not affect the dispatch with the carrier. Note that you must pass the entire details for the shipment, just as you would on a POST. Note that you only need to update a shipment when the carrier, time, or date has changed.
shipment
The requested capacity provider account group containing the account used for authentication with the capacity provider's API.
The project44-generated id of the LTL shipment. This may be provided when creating a tracked shipment only if a tracked shipment does not exist with this id but a shipment record does exist in project44's system with this id. This enables linking a dispatched shipment that initially failed to track to its tracking information by passing the id from dispatch. This id will always be returned in the shipment confirmation and may be used in subsequent API calls to reference a shipment.
The project44-generated id that is the UUID equivalent of id. The same rules apply to this value as applies to the id.
The project44-generated id that connects multi-leg shipments agnostic of mode.
A user-defined list of shipment identifiers that, with the exception of the EXTERNAL type, can be used to track the shipment with the capacity provider.
A list of the shipment stops for the shipment. Two and only two stops must be provided -- one of type 'ORIGIN' and one of type 'DESTINATION'. Stops of type 'TERMINAL' may be added as the shipment is tracked and they are discovered via capacity provider information. Note that 'TERMINAL' will be ignored if provided as part of a PUT.
curl -i -X PUT \ 'https://na12.api.project44.com/api/v4/ltl/trackedshipments/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "apiConfiguration": { "fallBackToDefaultAccountGroup": true }, "capacityProviderAccountGroup": { "accounts": [ { "code": "string" } ], "code": "string" }, "id": 0, "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "shipmentAttributes": [ { "name": "string", "values": [ "string" ] } ], "shipmentIdentifiers": [ { "primaryForType": true, "source": "CUSTOMER", "type": "PRO", "value": "string" } ], "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" }, "geoCoordinates": { "latitude": 0.1, "longitude": 0.1 }, "id": 0, "involvedParties": [ { "partyIdentifiers": [ { "type": "ACCOUNT", "value": "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", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "locationIdentifiers": [ { "type": "EXTERNAL", "value": "string" } ], "stopDescription": "string", "stopName": "string", "stopNumber": 0, "stopType": "ORIGIN", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" } ] }'
{ "infoMessages": [ { … } ], "shipment": { "apiConfiguration": { … }, "capacityProviderAccountGroup": { … }, "id": 0, "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "shipmentAttributes": [ … ], "shipmentIdentifiers": [ … ], "shipmentStops": [ … ] } }
curl -i -X GET \ 'https://na12.api.project44.com/api/v4/ltl/trackedshipments/{id}/statuses?includeMapUrl=false&includeStatusHistory=false' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
A list of references to images of documents related to the shipment.
System messages and messages from the capacity provider with severity "INFO" or "WARNING". Note that no messages with severity "ERROR" will be returned here.
The most up-to-date statuses of the vehicle in relation to each stop. One and only one status will always be returned for each stop. If the shipment does not have status "COMPLETED", this list will always contain one and only one stop status with a code of either "EN_ROUTE" or "ARRIVED".
{ "imageReferences": [ { … } ], "infoMessages": [ { … } ], "latestStatusUpdate": { "address": { … }, "exceptionDetailCode": "APPOINTMENT_SET", "exceptionSummaryCode": "APPOINTMENT_ISSUE", "retrievalDateTime": "string", "statusCode": "IN_TRANSIT", "statusReason": { … }, "stopId": 0, "stopNumber": 0, "stopType": "ORIGIN", "timestamp": { … } }, "latestStopStatuses": [ { … } ], "mapUrl": "string", "shipment": { "apiConfiguration": { … }, "capacityProviderAccountGroup": { … }, "id": 0, "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "shipmentAttributes": [ … ], "shipmentIdentifiers": [ … ], "shipmentStops": [ … ] }, "statusUpdates": [ { … } ] }
Use this endpoint to return the status of an LTL shipment according to a given identifier value. Note that this endpoint may return multiple shipments if the identifier is used for multiple shipments such as with a pickup number.
Set to "TRUE" if you wish to receive the shipment status history ('statusUpdates') in the response.
The source system that created the identifier.
The type of identifier for which to search.
curl -i -X GET \ 'https://na12.api.project44.com/api/v4/ltl/trackedshipments/statuses?includeStatusHistory=false&shipmentIdentifier.source=CUSTOMER&shipmentIdentifier.type=PRO&shipmentIdentifier.value=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "infoMessages": [ { … } ], "shipmentStatuses": [ { … } ] }
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.
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.
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 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.