Submit Equipment Identifier

Submit tracking equipment information, such as license plate or phone number, to project44 customer shipments using project44's RESTful API (webservice) that accepts JSON as input. The webservice resides on a single endpoint and the service requires OAuth 2.0 authentication.

This API tackles 2 use-cases:

1. Inform of a change of equipment at the moment that the change occurs.
2. Schedule an equipment change within the duration of a shipment.

You can only use one use case at a time – either to inform of an immediate change or to schedule a change for later. When scheduling a truck change, you can only schedule one change per API call. If you wish to schedule more than one change, you must call the API for each change separately.

If tracking via a mobile number, you can exclude the license plate information and only enter the phone number with the corresponding country code (i.e., +45, +351, +55, etc) in the equipmentIdentifiers array.

Send Equipment Identifier Information for a Shipment

Send or update equipment identifier information for a shipment.

Required Fields

• Customer Account Number
• Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, or P44_EU)
• Shipment Identifier (BILL_OF_LADING or ORDER, use the same Shipment ID as the customer)
• Equipment Identifier (either LICENSE_PLATE (EU only), VEHICLE_ID (NA only), or MOBILE_NUMBER)

Workflow

1. Reach out to your project44 technical contact to request the endpoint, carrierIdentifier, and customerAccountNumber. Please specify in the email that you are integrating to the FTL Equipment Assignment API and the name of the customer who you to wish to send data to.
2. Prepare a POST request to /api/v4/capacityproviders/tl/equipmentIdentifierAssignments. For example,

{
 "customerAccountNumber": "XXXX",
 "carrierIdentifier": {
   "type": "P44_EU",
   "value": "[Your carrier ID]"
 },
 "shipmentIdentifiers": [
   {
     "type": "BILL_OF_LADING",
     "value": "[Shipment identifier]"
   }
 ],
 "equipmentIdentifiers": [
   {
     "type": "LICENSE_PLATE",
     "value": "[License plate of the vehicle to track - this equipment ID is relevant to EU users only]"
   },
   {
     "type": " MOBILE_PHONE_NUMBER",
     "value": "[Mobile number to track (if applicable)]"
   }
 ]
}

3. Submit the request.

Expected System Response

The request is successfully submitted and confirmed when a 202 Accepted response is received.

Errors

If there was a problem with your request, you will receive one of the following error codes:

• 400 Invalid request
• 401 Invalid or missing credentials
• 403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Fields & Objects

Schedule an Equipment Change

Schedule an upcoming change to a shipment's equipment identifier information.

Required Fields

• Customer Account Number
• Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, or P44_EU)
• Shipment Identifier (BILL_OF_LADING or ORDER, use the same Shipment ID as the customer)
• Equipment Identifier (either LICENSE_PLATE (EU only), VEHICLE_ID (NA only), or MOBILE_NUMBER)

Workflow

1. Reach out to your project44 technical contact to request the endpoint, carrierIdentifier, and customerAccountNumber. Please specify in the email that you are integrating to the FTL Equipment Assignment API and the name of the customer who you to wish to send data to.
2. Prepare a POST request to /api/v4/capacityproviders/tl/equipmentIdentifierAssignments. For example,

{
 "customerAccountNumber": "XXXX",
 "carrierIdentifier": {
   "type": "P44_EU",
   "value": "[Your carrier ID]"
 },
 "shipmentIdentifiers": [
   {
     "type": "BILL_OF_LADING",
     "value": "[Shipment identifier]"
   }
 ],
 "equipmentIdentifiers": [
   {
     "type": "LICENSE_PLATE",
     "value": "[License plate of the vehicle to track - this equipment ID is relevant to EU users only]"
   },
   {
     "type": " MOBILE_PHONE_NUMBER",
     "value": "[Mobile number to track (if applicable)]"
   }
 ],
 "scheduledTruckChangeDateTime" : "2022-08-03T15:00:00+1000"
}

3. Submit the request.

Expected System Response

The request is successfully submitted and confirmed when a 202 Accepted response is received.

Errors

If there was a problem with your request, you will receive one of the following error codes:

• 400 Invalid request
• 401 Invalid or missing credentials
• 403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Fields & Objects