GET api/TraceByCarrierPro?User={User}&Pass={Pass}&CarrierPro={CarrierPro}

This API will search for a single shipment by a partner carrier's pro number (CarrierPro#) and return dispatch activity associated with the shipment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
User

Enter the Logon Code assigned to your account (1-8 characters)

 string

Required
Pass

Enter the Password associated with your Logon Code

 string

Required
CarrierPro

Carrier Partner pro numbers are alphanumeric, up to 15 characters in length

 string

Required

Body Parameters

None.

Response Information

Resource Description

TracingResults

TracingResults
NameDescriptionTypeAdditional information
ProNumber

The Pro number assigned to this shipment

string

None.
BOL_Number

This is the Bill of Lading number associated with the shipment

string

None.
PO_Number

This is the Customer Purchase Order number for this shipment

string

None.
ShipperID

Contains the assigned shipment identification number (SID) for this shipment

string

None.
Pro_Total_Amt

The total amount billed for this shipment, after discount (when applicable) and before any partner/carrier splits are deducted

string

None.
Pro_Net_Amt

The net amount billed for this shipment, after any applicable partner/carriers splits have been deducted

string

None.
PickupDate

The pickup date of record for this shipment

string

None.
ShipperInfo

Shipper name and address information is included in this data structure

NameAddr

None.
ConsigneeInfo

Consignee name and address information is included in this data structure

NameAddr

None.
BillToInfo

Bill To account name and address information is included in this data structure

NameAddr

None.
PaymentType

Identifies the payment type associated with this pro: PPD (prepaid), COL (collect) or T/P (Third Party)

string

None.
ShipmentWeight

The total weight for this shipment (in lbs.)

string

None.
ScheduledDate

Identifies the date that this shipment was scheduled for delivery

string

None.
FuelSurcharge

Identifies that portion of the billed amount attributed to Fuel Surcharge

string

None.
WhoSigned

Identifies the person who signed for the shipment's delivery (assuming it has been delivered and the signatory was recorded, otherwise blank)

string

None.
TracingEvents

Dispatching events (i.e. shipment movement) is represented in this data structure collection

Collection of TracingEvent

None.
PartnerCarriers

This data structure identifies any Carrier/Partner contact with the shipment

Collection of CarrierInfo

None.
ProDetails

Reflects the line item details for the shipment, including freight, accessorials and comments with charges and credits.

Collection of ProDetail

None.
ErrorDescription

This field will be empty (blank) if the API was processed successfully; a non-blank entry will document the nature of the error(s) encountered during processing.

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ProNumber": "sample string 1",
  "BOL_Number": "sample string 2",
  "PO_Number": "sample string 3",
  "ShipperID": "sample string 4",
  "Pro_Total_Amt": "sample string 5",
  "Pro_Net_Amt": "sample string 6",
  "PickupDate": "sample string 7",
  "ShipperInfo": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "ContactList": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Phone": "sample string 3",
        "Fax": "sample string 4",
        "Email": "sample string 5",
        "bShipper": true,
        "bConsignee": true,
        "bBillTo": true,
        "beBilling": true
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Phone": "sample string 3",
        "Fax": "sample string 4",
        "Email": "sample string 5",
        "bShipper": true,
        "bConsignee": true,
        "bBillTo": true,
        "beBilling": true
      }
    ]
  },
  "ConsigneeInfo": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "ContactList": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Phone": "sample string 3",
        "Fax": "sample string 4",
        "Email": "sample string 5",
        "bShipper": true,
        "bConsignee": true,
        "bBillTo": true,
        "beBilling": true
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Phone": "sample string 3",
        "Fax": "sample string 4",
        "Email": "sample string 5",
        "bShipper": true,
        "bConsignee": true,
        "bBillTo": true,
        "beBilling": true
      }
    ]
  },
  "BillToInfo": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "ContactList": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Phone": "sample string 3",
        "Fax": "sample string 4",
        "Email": "sample string 5",
        "bShipper": true,
        "bConsignee": true,
        "bBillTo": true,
        "beBilling": true
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Phone": "sample string 3",
        "Fax": "sample string 4",
        "Email": "sample string 5",
        "bShipper": true,
        "bConsignee": true,
        "bBillTo": true,
        "beBilling": true
      }
    ]
  },
  "PaymentType": "sample string 8",
  "ShipmentWeight": "sample string 9",
  "ScheduledDate": "sample string 10",
  "FuelSurcharge": "sample string 11",
  "WhoSigned": "sample string 12",
  "TracingEvents": [
    {
      "Status": "sample string 1",
      "Comment": "sample string 2"
    },
    {
      "Status": "sample string 1",
      "Comment": "sample string 2"
    }
  ],
  "PartnerCarriers": [
    {
      "SCAC": "sample string 1",
      "Split": "sample string 2",
      "Type": "sample string 3"
    },
    {
      "SCAC": "sample string 1",
      "Split": "sample string 2",
      "Type": "sample string 3"
    }
  ],
  "ProDetails": [
    {
      "Sequence": 1,
      "RecordType": "sample string 2",
      "Description": "sample string 3",
      "FreightClass": "sample string 4",
      "Weight": 5,
      "WeightMeasure": "sample string 6",
      "PalletCount": 7,
      "PieceCount": 8,
      "QtyMeasure": "sample string 9",
      "Length": 10,
      "Height": 11,
      "Width": 12,
      "HazmatUNnumber": "sample string 13",
      "HazmatClass": "sample string 14",
      "HazmatPackingGroup": "sample string 15",
      "HazmatProperName": "sample string 16",
      "Charges": 17.0
    },
    {
      "Sequence": 1,
      "RecordType": "sample string 2",
      "Description": "sample string 3",
      "FreightClass": "sample string 4",
      "Weight": 5,
      "WeightMeasure": "sample string 6",
      "PalletCount": 7,
      "PieceCount": 8,
      "QtyMeasure": "sample string 9",
      "Length": 10,
      "Height": 11,
      "Width": 12,
      "HazmatUNnumber": "sample string 13",
      "HazmatClass": "sample string 14",
      "HazmatPackingGroup": "sample string 15",
      "HazmatProperName": "sample string 16",
      "Charges": 17.0
    }
  ],
  "ErrorDescription": "sample string 13"
}

application/xml, text/xml

Sample: 
<TracingResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <BOL_Number>sample string 2</BOL_Number>
  <BillToInfo>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <Address3>sample string 5</Address3>
    <City>sample string 6</City>
    <Code>sample string 1</Code>
    <ContactList>
      <Contact>
        <Email>sample string 5</Email>
        <Fax>sample string 4</Fax>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 3</Phone>
        <bBillTo>true</bBillTo>
        <bConsignee>true</bConsignee>
        <bShipper>true</bShipper>
        <beBilling>true</beBilling>
      </Contact>
      <Contact>
        <Email>sample string 5</Email>
        <Fax>sample string 4</Fax>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 3</Phone>
        <bBillTo>true</bBillTo>
        <bConsignee>true</bConsignee>
        <bShipper>true</bShipper>
        <beBilling>true</beBilling>
      </Contact>
    </ContactList>
    <Name>sample string 2</Name>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
  </BillToInfo>
  <ConsigneeInfo>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <Address3>sample string 5</Address3>
    <City>sample string 6</City>
    <Code>sample string 1</Code>
    <ContactList>
      <Contact>
        <Email>sample string 5</Email>
        <Fax>sample string 4</Fax>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 3</Phone>
        <bBillTo>true</bBillTo>
        <bConsignee>true</bConsignee>
        <bShipper>true</bShipper>
        <beBilling>true</beBilling>
      </Contact>
      <Contact>
        <Email>sample string 5</Email>
        <Fax>sample string 4</Fax>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 3</Phone>
        <bBillTo>true</bBillTo>
        <bConsignee>true</bConsignee>
        <bShipper>true</bShipper>
        <beBilling>true</beBilling>
      </Contact>
    </ContactList>
    <Name>sample string 2</Name>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
  </ConsigneeInfo>
  <ErrorDescription>sample string 13</ErrorDescription>
  <FuelSurcharge>sample string 11</FuelSurcharge>
  <PO_Number>sample string 3</PO_Number>
  <PartnerCarriers>
    <CarrierInfo>
      <SCAC>sample string 1</SCAC>
      <Split>sample string 2</Split>
      <Type>sample string 3</Type>
    </CarrierInfo>
    <CarrierInfo>
      <SCAC>sample string 1</SCAC>
      <Split>sample string 2</Split>
      <Type>sample string 3</Type>
    </CarrierInfo>
  </PartnerCarriers>
  <PaymentType>sample string 8</PaymentType>
  <PickupDate>sample string 7</PickupDate>
  <ProDetails>
    <ProDetail>
      <Charges>17</Charges>
      <Description>sample string 3</Description>
      <FreightClass>sample string 4</FreightClass>
      <HazmatClass>sample string 14</HazmatClass>
      <HazmatPackingGroup>sample string 15</HazmatPackingGroup>
      <HazmatProperName>sample string 16</HazmatProperName>
      <HazmatUNnumber>sample string 13</HazmatUNnumber>
      <Height>11</Height>
      <Length>10</Length>
      <PalletCount>7</PalletCount>
      <PieceCount>8</PieceCount>
      <QtyMeasure>sample string 9</QtyMeasure>
      <RecordType>sample string 2</RecordType>
      <Sequence>1</Sequence>
      <Weight>5</Weight>
      <WeightMeasure>sample string 6</WeightMeasure>
      <Width>12</Width>
    </ProDetail>
    <ProDetail>
      <Charges>17</Charges>
      <Description>sample string 3</Description>
      <FreightClass>sample string 4</FreightClass>
      <HazmatClass>sample string 14</HazmatClass>
      <HazmatPackingGroup>sample string 15</HazmatPackingGroup>
      <HazmatProperName>sample string 16</HazmatProperName>
      <HazmatUNnumber>sample string 13</HazmatUNnumber>
      <Height>11</Height>
      <Length>10</Length>
      <PalletCount>7</PalletCount>
      <PieceCount>8</PieceCount>
      <QtyMeasure>sample string 9</QtyMeasure>
      <RecordType>sample string 2</RecordType>
      <Sequence>1</Sequence>
      <Weight>5</Weight>
      <WeightMeasure>sample string 6</WeightMeasure>
      <Width>12</Width>
    </ProDetail>
  </ProDetails>
  <ProNumber>sample string 1</ProNumber>
  <Pro_Net_Amt>sample string 6</Pro_Net_Amt>
  <Pro_Total_Amt>sample string 5</Pro_Total_Amt>
  <ScheduledDate>sample string 10</ScheduledDate>
  <ShipmentWeight>sample string 9</ShipmentWeight>
  <ShipperID>sample string 4</ShipperID>
  <ShipperInfo>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <Address3>sample string 5</Address3>
    <City>sample string 6</City>
    <Code>sample string 1</Code>
    <ContactList>
      <Contact>
        <Email>sample string 5</Email>
        <Fax>sample string 4</Fax>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 3</Phone>
        <bBillTo>true</bBillTo>
        <bConsignee>true</bConsignee>
        <bShipper>true</bShipper>
        <beBilling>true</beBilling>
      </Contact>
      <Contact>
        <Email>sample string 5</Email>
        <Fax>sample string 4</Fax>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 3</Phone>
        <bBillTo>true</bBillTo>
        <bConsignee>true</bConsignee>
        <bShipper>true</bShipper>
        <beBilling>true</beBilling>
      </Contact>
    </ContactList>
    <Name>sample string 2</Name>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
  </ShipperInfo>
  <TracingEvents>
    <TracingEvent>
      <Comment>sample string 2</Comment>
      <Status>sample string 1</Status>
    </TracingEvent>
    <TracingEvent>
      <Comment>sample string 2</Comment>
      <Status>sample string 1</Status>
    </TracingEvent>
  </TracingEvents>
  <WhoSigned>sample string 12</WhoSigned>
</TracingResults>