POST Track/GetTrackingReadOnly

Generates tracking details from the system based on the provided tracking request object. If the specified transaction is not found, an error message will be returned.

To perform this action, include the HTTP Authorization request header with the value "Bearer {token}".

EndPoint

Production Url: https://enterprise.freightpop.com/Track/GetTrackingReadOnly

Sandbox Url: https://sandbox-api.freightpop.com/Track/GetTrackingReadOnly

Request Information

URI Parameters

None.

Body Parameters

An object containing information for tracking.

TrackingRequest
NameDescriptionTypeAdditional information
TransactionNumbers

Provide a list of Transaction Numbers

Collection of string

None.

TransactionType

Provide Transaction Type against which tracking details needs to be retrieved against Transaction Numbers list.

GetTrackingBy

None.

Request Formats

application/json, text/json

Sample:
{
  "TransactionNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "TransactionType": 1
}

Response Information

Resource Description

The tracking details if available; otherwise, an error message indicating that the transaction was not found.

TrackResponse
NameDescriptionTypeAdditional information
Data

tracking response object info

Collection of TrackingResponse

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "Carrier": "sample string 1",
      "Service": "sample string 2",
      "TotalWeight": "sample string 3",
      "TrackingNumber": "sample string 4",
      "ShipmentId": 5,
      "OrderNumber": "sample string 6",
      "TotalLegSequences": 7,
      "LegSequenceId": 8,
      "ShipFrom": "sample string 9",
      "ShipTo": "sample string 10",
      "Ref1": "sample string 11",
      "Ref2": "sample string 12",
      "Ref3": "sample string 13",
      "Ref4": "sample string 14",
      "Ref5": "sample string 15",
      "Ref6": "sample string 16",
      "BOLNumber": "sample string 17",
      "CreatedOn": "sample string 18",
      "EstimatedDeliveryDate": "sample string 19",
      "DeliveredDate": "sample string 20",
      "DeliveryDays": "sample string 21",
      "SignedBy": "sample string 22",
      "CurrentStatus": "sample string 23",
      "CurrentStatusCode": 1,
      "CarrierType": "sample string 24",
      "BookingDate": "2024-05-17T20:35:54.5953577-07:00",
      "PickupDate": "2024-05-17T20:35:54.5953577-07:00",
      "OutboundCustomsDate": "2024-05-17T20:35:54.5953577-07:00",
      "OnboardDate": "2024-05-17T20:35:54.5953577-07:00",
      "EstimatedDepartureDate": "2024-05-17T20:35:54.5953577-07:00",
      "ActualDepartureDate": "2024-05-17T20:35:54.5953577-07:00",
      "EstimatedArrivalDate": "2024-05-17T20:35:54.5953577-07:00",
      "ActualArrivalDate": "2024-05-17T20:35:54.5953577-07:00",
      "InboundCustomsDate": "2024-05-17T20:35:54.5953577-07:00",
      "PortDepartureDate": "2024-05-17T20:35:54.5953577-07:00",
      "MasterBillNo": "sample string 25",
      "CarrierCode": "sample string 26",
      "VoyageFlightNo": "sample string 27",
      "VesselName": "sample string 28",
      "OriginPort": "sample string 29",
      "DestinationPort": "sample string 30",
      "OrigionalETA": "sample string 31",
      "UpdatedETA": "sample string 32",
      "IsReturnShipment": true,
      "Longitude": "sample string 34",
      "Latitude": "sample string 35",
      "MovementId": 1,
      "Details": [
        {
          "StatusDate": "sample string 1",
          "StatusComment": "sample string 2",
          "City": "sample string 3",
          "State": "sample string 4",
          "Longitude": "sample string 5",
          "Latitude": "sample string 6",
          "StatusTrack": "sample string 7"
        },
        {
          "StatusDate": "sample string 1",
          "StatusComment": "sample string 2",
          "City": "sample string 3",
          "State": "sample string 4",
          "Longitude": "sample string 5",
          "Latitude": "sample string 6",
          "StatusTrack": "sample string 7"
        }
      ]
    },
    {
      "Carrier": "sample string 1",
      "Service": "sample string 2",
      "TotalWeight": "sample string 3",
      "TrackingNumber": "sample string 4",
      "ShipmentId": 5,
      "OrderNumber": "sample string 6",
      "TotalLegSequences": 7,
      "LegSequenceId": 8,
      "ShipFrom": "sample string 9",
      "ShipTo": "sample string 10",
      "Ref1": "sample string 11",
      "Ref2": "sample string 12",
      "Ref3": "sample string 13",
      "Ref4": "sample string 14",
      "Ref5": "sample string 15",
      "Ref6": "sample string 16",
      "BOLNumber": "sample string 17",
      "CreatedOn": "sample string 18",
      "EstimatedDeliveryDate": "sample string 19",
      "DeliveredDate": "sample string 20",
      "DeliveryDays": "sample string 21",
      "SignedBy": "sample string 22",
      "CurrentStatus": "sample string 23",
      "CurrentStatusCode": 1,
      "CarrierType": "sample string 24",
      "BookingDate": "2024-05-17T20:35:54.5953577-07:00",
      "PickupDate": "2024-05-17T20:35:54.5953577-07:00",
      "OutboundCustomsDate": "2024-05-17T20:35:54.5953577-07:00",
      "OnboardDate": "2024-05-17T20:35:54.5953577-07:00",
      "EstimatedDepartureDate": "2024-05-17T20:35:54.5953577-07:00",
      "ActualDepartureDate": "2024-05-17T20:35:54.5953577-07:00",
      "EstimatedArrivalDate": "2024-05-17T20:35:54.5953577-07:00",
      "ActualArrivalDate": "2024-05-17T20:35:54.5953577-07:00",
      "InboundCustomsDate": "2024-05-17T20:35:54.5953577-07:00",
      "PortDepartureDate": "2024-05-17T20:35:54.5953577-07:00",
      "MasterBillNo": "sample string 25",
      "CarrierCode": "sample string 26",
      "VoyageFlightNo": "sample string 27",
      "VesselName": "sample string 28",
      "OriginPort": "sample string 29",
      "DestinationPort": "sample string 30",
      "OrigionalETA": "sample string 31",
      "UpdatedETA": "sample string 32",
      "IsReturnShipment": true,
      "Longitude": "sample string 34",
      "Latitude": "sample string 35",
      "MovementId": 1,
      "Details": [
        {
          "StatusDate": "sample string 1",
          "StatusComment": "sample string 2",
          "City": "sample string 3",
          "State": "sample string 4",
          "Longitude": "sample string 5",
          "Latitude": "sample string 6",
          "StatusTrack": "sample string 7"
        },
        {
          "StatusDate": "sample string 1",
          "StatusComment": "sample string 2",
          "City": "sample string 3",
          "State": "sample string 4",
          "Longitude": "sample string 5",
          "Latitude": "sample string 6",
          "StatusTrack": "sample string 7"
        }
      ]
    }
  ],
  "Code": 100,
  "Message": "sample string 1"
}