GET api/TraceByCarrier?User={User}&Pass={Pass}&StartDate={StartDate}&EndDate={EndDate}
This API method will search for one or more shipments associated with the specified pickup date range where the account credentials reference a partner carrier involved with transport of the shipment. For those shipments, a chronology of dispatch activity will be returned.
Request Information
URI Parameters
| Name | Description | Type | Additional 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 |
| StartDate |
Specifies the earliest date for the pickup date range criteria used to select shipments |
string |
Required |
| EndDate |
Specifies the latest date for the pickup date range criteria used to select shipments |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
TracingList| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentList | Collection of TracingResults |
None. |
|
| ErrorDescription | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ShipmentList": [
{
"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"
},
{
"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"
}
],
"ErrorDescription": "sample string 1"
}
application/xml, text/xml
Sample:
<TracingList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RudeWebAPI">
<ErrorDescription>sample string 1</ErrorDescription>
<ShipmentList>
<TracingResults>
<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>
<TracingResults>
<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>
</ShipmentList>
</TracingList>