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.
curl -i -X POST \ https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/equipmentIdentifierAssignments \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerAccountNumber": "string", "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "scheduledTruckChangeDateTime": "string", "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shouldDelete": true }'
{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerAccountNumber": "string", "equipmentIdentifiers": [ { … } ], "scheduledTruckChangeDateTime": "string", "shipmentIdentifiers": [ { … } ], "shouldDelete": true }
curl -i -X POST \ https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/shipments/intermediateStops \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerAccountNumber": "string", "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentStops": [ { "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "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" } }, "stopName": "string" } ] }'
{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerAccountNumber": "string", "shipmentIdentifiers": [ { … } ], "shipmentStops": [ { … } ] }
statusUpdate
curl -i -X POST \ https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/shipments/statusUpdates \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerId": "string", "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "eventStopNumber": 0, "eventType": "DELIVERED", "hoursOfServiceRemaining": 0, "latestTemperature": 0, "latestTemperatureUnit": "F", "latitude": 0, "longitude": 0, "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentStops": [ { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "arrivalDateTime": "2019-08-24T14:15:22Z", "carrierSuppliedEta": "string", "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" }, "departureDateTime": "2019-08-24T14:15:22Z", "stopName": "string", "stopNumber": 0 } ], "utcTimestamp": "2019-08-24T14:15:22Z" }'
{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerId": "string", "equipmentIdentifiers": [ { … } ], "eventStopNumber": 0, "eventType": "DELIVERED", "hoursOfServiceRemaining": 0, "latestTemperature": 0, "latestTemperatureUnit": "F", "latitude": 0, "longitude": 0, "shipmentIdentifiers": [ { … } ], "shipmentStops": [ { … } ], "utcTimestamp": "2019-08-24T14:15:22Z" }
shipmentEvent
The time when this event occurred. If relevant, the offset will be relative to where the event occurred, otherwise will be in UTC. Will only be populated for events that have already happened.
The estimated time that this event is likely to occur. Only populated if event has not occurred yet.
The time when project44 last calculated the estimate for this event. Only populated if event has not occurred yet.
The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.
The time when project44 received or calculated this event. Will only be populated for events that have already happened.
If relevant, this will be populated with the id of a route segment on which this event occurred. This can be used to associate the event with a specific vehicle.
If relevant, this will be populated with the id of the stop to which this event relates.
The type of event that occurred. Will always be populated.
curl -i -X POST \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/events' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "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" }'
OK
The time when this event occurred. If relevant, the offset will be relative to where the event occurred, otherwise will be in UTC. Will only be populated for events that have already happened.
The estimated time that this event is likely to occur. Only populated if event has not occurred yet.
The time when project44 last calculated the estimate for this event. Only populated if event has not occurred yet.
The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.
The time when project44 received or calculated this event. Will only be populated for events that have already happened.
If relevant, this will be populated with the id of a route segment on which this event occurred. This can be used to associate the event with a specific vehicle.
If relevant, this will be populated with the id of the stop to which this event relates.
The type of event that occurred. Will always be populated.
{ "dateTime": "string", "dateTimes": [ { … } ], "description": "string", "details": { "mobileTracking": { … }, "ocean": { … }, "qualityControl": { … } }, "estimateDateTime": "string", "estimateLastCalculatedDateTime": "string", "plannedDateTime": "string", "plannedEndDateTime": "string", "receivedDateTime": "string", "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352", "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43", "type": "UNKNOWN" }
additionalAppointmentWindow
This is the state of the appointment as determined by the source appointment management system. This status is used to represent where the appointment is within its lifecycle, it does not represent the physical state of the asset fulfilling the appointment.
A date and time range, including a time zone, representing a window of availability.
A list of identifiers of the additional appointment windows to a shipment.
curl -i -X PUT \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/stops/{stopId}/additional-appointment-windows' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "appointmentStatus": "PENDING", "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "identifiers": [ { "type": "DOCK", "value": "string" } ], "type": "STRATEGIC" }'
OK
This is the state of the appointment as determined by the source appointment management system. This status is used to represent where the appointment is within its lifecycle, it does not represent the physical state of the asset fulfilling the appointment.
A date and time range, including a time zone, representing a window of availability.
A list of identifiers of the additional appointment windows to a shipment.
{ "appointmentStatus": "PENDING", "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "identifiers": [ { … } ], "type": "STRATEGIC" }
tenderAcceptance
This field contains the identifier that should be used to select this capacity provider's offer for dispatching.
Carrier provided equipment identifiers that can be used to facilitate tracking.
The expiration date time of this capacity provider offer. A time zone offset must be provided. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).
curl -i -X POST \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/acceptances' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "capacityProviderOfferIdentifier": "string", "carrierIdentifier": { "type": "SCAC", "value": "string" }, "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "offerExpirationDateTime": "string", "trackingShipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ] }'
{ "infoMessages": [ { … } ], "tenderAcceptance": { "capacityProviderOfferIdentifier": "string", "carrierIdentifier": { … }, "equipmentIdentifiers": [ … ], "offerExpirationDateTime": "string", "trackingShipmentIdentifiers": [ … ] }, "tenderIdentifier": "string" }
tenderDecline
The capacity provider's identifier that references their decision to decline this tender.
A more detailed description of the capacity provider's reason for declining this tender.
curl -i -X POST \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/declines' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "capacityProviderDeclineIdentifier": "string", "declineReason": "string", "declineReasonCode": "DECLINED_CAPACITY_TYPE" }'
{ "infoMessages": [ { … } ], "tenderIdentifier": "string" }
tenderError
The capacity provider's identifier that references their error for this tender.
curl -i -X POST \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/errors' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "capacityProviderErrorIdentifier": "string", "errorReason": "string" }'
{ "infoMessages": [ { … } ], "tenderIdentifier": "string" }
rateQuote
This field contains the identifier that should be used to select this capacity provider's offer for dispatching.
The currency used to express the capacity provider's quoted price.
Carrier provided equipment identifiers that can be used to facilitate tracking.
The expiration date time of this capacity provider offer. A time zone offset must be provided. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).
curl -i -X POST \ 'https://developers.project44.com/_mock/api-reference/api-docs/api/v4/capacityproviders/tl/tenders/{tenderIdentifier}/quotes' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "capacityProviderOfferIdentifier": "string", "carrierIdentifier": { "type": "SCAC", "value": "string" }, "currency": "USD", "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "offerExpirationDateTime": "string", "rateQuoteDetail": { "charges": [ { "amount": 0, "description": "string", "vendorCode": "LH" } ], "subtotal": 0, "total": 0 }, "trackingShipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ] }'
{ "infoMessages": [ { … } ], "rateQuote": { "capacityProviderOfferIdentifier": "string", "carrierIdentifier": { … }, "currency": "USD", "equipmentIdentifiers": [ … ], "offerExpirationDateTime": "string", "rateQuoteDetail": { … }, "trackingShipmentIdentifiers": [ … ] }, "tenderIdentifier": "string" }
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.