Create a Shipment

Create a Full Truckload (FTL) shipment to add the shipment to project44's system.

Create an FTL Shipment

Create an FTL shipment to be tracked in project44's network. This step is necessary before tracking can start.

Requirements

Have the following information:

• Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT, or P44_EU)
• Shipment Identifier (BILL_OF_LADING or ORDER)
• At least two shipment stops with stop information including
  • Stop number
  • Appointment windows (start and end dates and times)
  • Location (using either an address or geocoordinates)
• Equipment Identifier (MOBILE_PHONE, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE, or TIVE_DEVICE_ID)

Workflow

Complete these steps:

1. Prepare a POST request to /api/v4/tl/shipments.
2. Add the required information to the request schema. For an example that uses addresses for the stop locations,

{
  "carrierIdentifier": {
    "type": "SCAC",
    "value": "string"
  },
  "shipmentIdentifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    }
  ],
  "shipmentStops": [
    {
      "stopNumber": 0,
      "appointmentWindow": {
        "startDateTime": "2019-08-24T14:15:22",
        "endDateTime": "2019-08-24T14:15:22",
        "localTimeZoneIdentifier": "string"
      },
      "location": {
        "address": {
          "postalCode": "string",
          "addressLines": [
            "string"
          ],
          "city": "string",
          "state": "string",
          "country": "US"
        }
      }
    }
  ],
  "equipmentIdentifiers": [
    {
      "type": "MOBILE_PHONE_NUMBER",
      "value": "string",
      "shouldDelete": false
    }
  ]
}

3. Send the request.

Fields and Objects

Expected System Response

You have successfully submitted the request when you receive a 201 Created response. For example,

{
    "shipment": {
        "id": 0,
        "carrierIdentifier": {
            "type": "SCAC",
            "value": "string"
        },
        "shipmentIdentifiers": [
            {
                "type": "BILL_OF_LADING",
                "value": "string"
            }
        ],
        "shipmentStops": [
            {
                "stopNumber": 0,
                "appointmentWindow": {
                    "startDateTime": "2019-08-24T14:15:22",
                    "endDateTime": "2019-08-24T14:15:22",
                    "localTimeZoneIdentifier": "string"
                },
                "location": {
                    "address": {
                        "postalCode": "string",
                        "addressLines": [
                            "string"
                        ],
                        "city": "string",
                        "state": "string",
                        "country": "US"
                    }
                }
            }
        ],
        "equipmentIdentifiers": [
            {
                "type": "MOBILE_PHONE_NUMBER",
                "value": "string",
                "shouldDelete": false
            }
        ],
        "id": 0
    },
    "infoMessages": [
        {
            "severity": "ERROR",
            "message": "string",
            "diagnostic": "string",
            "source": "SYSTEM"
        }
    ]
}

A unique project44 ID is returned in the response after shipment creation. Store this ID to use in future API calls.

Fields and Objects

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.

Get Available Tracking Methods

Return available shipment tracking methods for a given carrier.

Requirements

Have the following information:

• Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, VAT, or P44_EU)

Workflow

Complete these steps:

1. Prepare a GET request to /api/v4/tl/shipments/trackingmethods.
2. Send the request.

Fields and Objects

Expected System Response

You have successfully submitted the request when you receive a 200 OK response. For example,

{
  "trackingMethods": [
    {
      "capacityProviderAccount": {
        "code": "string"
      },
      "equipmentIdentifier": {
        "shouldDelete": true,
        "type": "MOBILE_PHONE_NUMBER",
        "value": "string"
      },
      "infoMessages": [
        {
          "severity": "ERROR",
          "message": "string",
          "diagnostic": "string",
          "source": "SYSTEM"
        }
      ],
      "shipmentIdentifier": {
        "type": "BILL_OF_LADING",
        "value": "string"
      }
    }
  ]
}

Fields and Objects

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.

Get List of Assets for a Given Carrier

Get all assets for a carrier that are known by project44. Use this endpoint if you do not know the carrier's equipment identifiers. This information is necessary to create a shipment.

Requirements

Have the following information:

• Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT, or P44_EU).

Workflow

Complete the following steps:

1. Prepare a GET request to /api/v4/tl/assets and include the carrier identifier.
2. Send the request.

Fields and Objects

Expected System Response

The request is successfully submitted and confirmed when a 200 OK response is received. For example,

{
  "paginationInfo": {
    "total": 0,
    "pageSize": 0,
    "pageNumber": 0
  },
  "results": [
    {
      "type": "MOBILE_PHONE_NUMBER",
      "value": "string",
      "shouldDelete": false
    }
  ],
  "infoMessages": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "SYSTEM"
    }
  ]
}

Fields and Objects

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.

Validate Equipment Identifiers

Determine if an equipment identifier is valid for a given carrier and can be used for tracking. If the carrier's tracking vendor does not support validating equipment identifiers without initiating tracking, then the endpoint will always report that the identifier is valid.

Requirements

Have the following information:

• Carrier Identifier (SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT or P44_EU).
• Equipment Identifier (MOBILE_PHONE, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE, or TIVE_DEVICE_ID)

Workflow

Complete the following steps:

1. Prepare a GET request to /api/v4/tl/equipment/validate and include the carrier and equipment identifiers.
2. Send the request.

Fields and Objects

Expected System Response

The request is successfully submitted and confirmed when a 200 OK response is received. For example,

{
  "exists": true,
  "ownershipStatus": "CONNECTED",
  "valid": true
}

Fields and Objects

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.