Last updated

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

ElementDescriptionTypeNotes
carrierIdentifier.typeThe carrier identifier type.stringValid values are SCAC, MC_NUMBER, DOT_NUMBER, SYSTEM, VAT, or P44_EU.
carrierIdentifier.valueThe value of the carrier identifier.string

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"
      }
    }
  ]
}

This is an example of what could be returned in the response. Null fields will not show up in the response. Please refer to the reference data for more information on required and potential null fields.

Fields and Objects

ElementDescriptionTypeNotes
trackingMethods.capacityProviderAccount.codeThe code for the requested capacity provider account.string
trackingMethods.equipmentIdentifier.typeThe type of equipment identifier.stringValid values are MOBILE_PHONE_NUMBER, VEHICLE_ID, LICENSE_PLATE, SENSITECH_DEVICE, or TIVE_DEVICE_ID.
trackingMethods.equipmentIdentifier.valueThe value of the equipment identifier.stringCell phone numbers will be obfuscated in project44 responses for privacy reasons.
trackingMethods.shipmentIdentifier.typeThe type of shipment identifier.stringValid values are BILL_OF_LADING and ORDER.
trackingMethods.shipmentIdentifier.valueThe value of the shipment identifier.string

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.

Previous page
Next page