GET Track?ReferenceNum={ReferenceNum}&BeginDate={BeginDate}&EndDate={EndDate}
Retrieve shipment tracking information
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ReferenceNum |
Reference number, freight bill number, or pro number |
string |
None. |
BeginDate |
Find shipments picked up on or after this date. Date range cannot exceed 7 days. If not provided, defaults to current date. |
date |
None. |
EndDate |
Find shipments picked up on or before this date. Date range cannot exceed 7 days. If not provided, defaults to current date. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of TrackName | Description | Type | Additional information |
---|---|---|---|
FreightBillNum |
Freight bill number |
string |
None. |
ProNum |
Pro number |
string |
None. |
PrimaryReferenceNum |
The primary reference number associated with this shipment |
string |
None. |
Reference |
Reference numbers associated with this shipment |
Collection of TrackReference |
None. |
Status |
Status updates for this shipment |
Collection of TrackStatus |
None. |
Images |
Images associated with this shipment |
Collection of Image |
None. |
ShipperAddress |
Shipper address |
Address |
None. |
ConsigneeAddress |
Consignee address |
Address |
None. |
BillingTerms |
Billing terms (e.g. Prepaid, Collect, Third Party) |
string |
None. |
BillingAddress |
Billing address |
Address |
None. |
PickupSchedule |
Pickup appointment information |
Schedule |
None. |
PickupDate |
Pickup date |
date |
None. |
DeliverySchedule |
Delivery appointment information |
Schedule |
None. |
DeliveryDate |
Delivery date |
date |
None. |
DeliverySignatory |
Delivery signatory |
string |
None. |
Details |
Freight characteristics and charges |
Collection of TrackDetailLine |
None. |
TotalUnits |
Total number of handling units |
integer |
None. |
TotalWeight |
Total weight |
decimal number |
None. |
BaseCharge |
Base charges |
decimal number |
None. |
Accessorials |
Accessorial services and fees |
Collection of TrackAccessorial |
None. |
AccessorialCharge |
Accessorial charges |
decimal number |
None. |
FuelCharge |
Fuel charges |
decimal number |
None. |
HiCostCharge |
High cost charges |
decimal number |
None. |
TotalCharge |
Total charges |
decimal number |
None. |
Response Formats
application/json, text/json
[ { "FreightBillNum": "sample string 1", "ProNum": "sample string 2", "PrimaryReferenceNum": "sample string 3", "Reference": [ { "Number": "sample string 1", "Type": "sample string 2" }, { "Number": "sample string 1", "Type": "sample string 2" } ], "Status": [ { "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "Description": "sample string 2" }, { "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "Description": "sample string 2" } ], "Images": [ { "ImageId": "sample string 1", "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "DocumentType": "sample string 3", "FileFormat": "sample string 4", "Content": "QEA=" }, { "ImageId": "sample string 1", "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "DocumentType": "sample string 3", "FileFormat": "sample string 4", "Content": "QEA=" } ], "ShipperAddress": { "Name": "sample string 1", "Address1": "sample string 2", "Address2": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zip": "sample string 6", "Country": "sample string 7", "Contact": "sample string 8", "Phone": "sample string 9", "Latitude": 1.1, "Longitude": 1.1 }, "ConsigneeAddress": { "Name": "sample string 1", "Address1": "sample string 2", "Address2": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zip": "sample string 6", "Country": "sample string 7", "Contact": "sample string 8", "Phone": "sample string 9", "Latitude": 1.1, "Longitude": 1.1 }, "BillingTerms": "sample string 4", "BillingAddress": { "Name": "sample string 1", "Address1": "sample string 2", "Address2": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zip": "sample string 6", "Country": "sample string 7", "Contact": "sample string 8", "Phone": "sample string 9", "Latitude": 1.1, "Longitude": 1.1 }, "PickupSchedule": { "After": "2024-10-13T05:46:18.7925122-05:00", "Before": "2024-10-13T05:46:18.7925122-05:00", "AppointmentRequired": true, "AppointmentMade": true }, "PickupDate": "2024-10-13T05:46:18.7925122-05:00", "DeliverySchedule": { "After": "2024-10-13T05:46:18.7925122-05:00", "Before": "2024-10-13T05:46:18.7925122-05:00", "AppointmentRequired": true, "AppointmentMade": true }, "DeliveryDate": "2024-10-13T05:46:18.7925122-05:00", "DeliverySignatory": "sample string 5", "Details": [ { "Units": 1, "PackageType": "sample string 2", "Description": "sample string 3", "Weight": 4.1, "Class": 5.1, "Length": 6.1, "Width": 7.1, "Height": 8.1, "Cube": 350.81099999999992, "Area": 43.309999999999995, "Density": 20.195489879165709, "BaseCharge": 12.1 }, { "Units": 1, "PackageType": "sample string 2", "Description": "sample string 3", "Weight": 4.1, "Class": 5.1, "Length": 6.1, "Width": 7.1, "Height": 8.1, "Cube": 350.81099999999992, "Area": 43.309999999999995, "Density": 20.195489879165709, "BaseCharge": 12.1 } ], "TotalUnits": 6, "TotalWeight": 7.1, "BaseCharge": 8.1, "Accessorials": [ { "Code": "sample string 1", "Description": "sample string 2", "Charge": 3.1 }, { "Code": "sample string 1", "Description": "sample string 2", "Charge": 3.1 } ], "AccessorialCharge": 9.1, "FuelCharge": 10.1, "HiCostCharge": 11.1, "TotalCharge": 12.1 }, { "FreightBillNum": "sample string 1", "ProNum": "sample string 2", "PrimaryReferenceNum": "sample string 3", "Reference": [ { "Number": "sample string 1", "Type": "sample string 2" }, { "Number": "sample string 1", "Type": "sample string 2" } ], "Status": [ { "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "Description": "sample string 2" }, { "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "Description": "sample string 2" } ], "Images": [ { "ImageId": "sample string 1", "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "DocumentType": "sample string 3", "FileFormat": "sample string 4", "Content": "QEA=" }, { "ImageId": "sample string 1", "Timestamp": "2024-10-13T05:46:18.7925122-05:00", "DocumentType": "sample string 3", "FileFormat": "sample string 4", "Content": "QEA=" } ], "ShipperAddress": { "Name": "sample string 1", "Address1": "sample string 2", "Address2": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zip": "sample string 6", "Country": "sample string 7", "Contact": "sample string 8", "Phone": "sample string 9", "Latitude": 1.1, "Longitude": 1.1 }, "ConsigneeAddress": { "Name": "sample string 1", "Address1": "sample string 2", "Address2": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zip": "sample string 6", "Country": "sample string 7", "Contact": "sample string 8", "Phone": "sample string 9", "Latitude": 1.1, "Longitude": 1.1 }, "BillingTerms": "sample string 4", "BillingAddress": { "Name": "sample string 1", "Address1": "sample string 2", "Address2": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zip": "sample string 6", "Country": "sample string 7", "Contact": "sample string 8", "Phone": "sample string 9", "Latitude": 1.1, "Longitude": 1.1 }, "PickupSchedule": { "After": "2024-10-13T05:46:18.7925122-05:00", "Before": "2024-10-13T05:46:18.7925122-05:00", "AppointmentRequired": true, "AppointmentMade": true }, "PickupDate": "2024-10-13T05:46:18.7925122-05:00", "DeliverySchedule": { "After": "2024-10-13T05:46:18.7925122-05:00", "Before": "2024-10-13T05:46:18.7925122-05:00", "AppointmentRequired": true, "AppointmentMade": true }, "DeliveryDate": "2024-10-13T05:46:18.7925122-05:00", "DeliverySignatory": "sample string 5", "Details": [ { "Units": 1, "PackageType": "sample string 2", "Description": "sample string 3", "Weight": 4.1, "Class": 5.1, "Length": 6.1, "Width": 7.1, "Height": 8.1, "Cube": 350.81099999999992, "Area": 43.309999999999995, "Density": 20.195489879165709, "BaseCharge": 12.1 }, { "Units": 1, "PackageType": "sample string 2", "Description": "sample string 3", "Weight": 4.1, "Class": 5.1, "Length": 6.1, "Width": 7.1, "Height": 8.1, "Cube": 350.81099999999992, "Area": 43.309999999999995, "Density": 20.195489879165709, "BaseCharge": 12.1 } ], "TotalUnits": 6, "TotalWeight": 7.1, "BaseCharge": 8.1, "Accessorials": [ { "Code": "sample string 1", "Description": "sample string 2", "Charge": 3.1 }, { "Code": "sample string 1", "Description": "sample string 2", "Charge": 3.1 } ], "AccessorialCharge": 9.1, "FuelCharge": 10.1, "HiCostCharge": 11.1, "TotalCharge": 12.1 } ]
application/xml, text/xml
<ArrayOfTrack xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Track> <FreightBillNum>sample string 1</FreightBillNum> <ProNum>sample string 2</ProNum> <PrimaryReferenceNum>sample string 3</PrimaryReferenceNum> <Reference> <TrackReference> <Number>sample string 1</Number> <Type>sample string 2</Type> </TrackReference> <TrackReference> <Number>sample string 1</Number> <Type>sample string 2</Type> </TrackReference> </Reference> <Status> <TrackStatus> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <Description>sample string 2</Description> </TrackStatus> <TrackStatus> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <Description>sample string 2</Description> </TrackStatus> </Status> <Images> <Image> <ImageId>sample string 1</ImageId> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <DocumentType>sample string 3</DocumentType> <FileFormat>sample string 4</FileFormat> <Content>QEA=</Content> </Image> <Image> <ImageId>sample string 1</ImageId> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <DocumentType>sample string 3</DocumentType> <FileFormat>sample string 4</FileFormat> <Content>QEA=</Content> </Image> </Images> <ShipperAddress> <Name>sample string 1</Name> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Country>sample string 7</Country> <Contact>sample string 8</Contact> <Phone>sample string 9</Phone> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> </ShipperAddress> <ConsigneeAddress> <Name>sample string 1</Name> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Country>sample string 7</Country> <Contact>sample string 8</Contact> <Phone>sample string 9</Phone> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> </ConsigneeAddress> <BillingTerms>sample string 4</BillingTerms> <BillingAddress> <Name>sample string 1</Name> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Country>sample string 7</Country> <Contact>sample string 8</Contact> <Phone>sample string 9</Phone> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> </BillingAddress> <PickupSchedule> <After>2024-10-13T05:46:18.7925122-05:00</After> <Before>2024-10-13T05:46:18.7925122-05:00</Before> <AppointmentRequired>true</AppointmentRequired> <AppointmentMade>true</AppointmentMade> </PickupSchedule> <PickupDate>2024-10-13T05:46:18.7925122-05:00</PickupDate> <DeliverySchedule> <After>2024-10-13T05:46:18.7925122-05:00</After> <Before>2024-10-13T05:46:18.7925122-05:00</Before> <AppointmentRequired>true</AppointmentRequired> <AppointmentMade>true</AppointmentMade> </DeliverySchedule> <DeliveryDate>2024-10-13T05:46:18.7925122-05:00</DeliveryDate> <DeliverySignatory>sample string 5</DeliverySignatory> <Details> <TrackDetailLine> <Units>1</Units> <PackageType>sample string 2</PackageType> <Description>sample string 3</Description> <Weight>4.1</Weight> <Class>5.1</Class> <Length>6.1</Length> <Width>7.1</Width> <Height>8.1</Height> <Cube>350.81099999999992</Cube> <Area>43.309999999999995</Area> <Density>20.195489879165709</Density> <BaseCharge>12.1</BaseCharge> </TrackDetailLine> <TrackDetailLine> <Units>1</Units> <PackageType>sample string 2</PackageType> <Description>sample string 3</Description> <Weight>4.1</Weight> <Class>5.1</Class> <Length>6.1</Length> <Width>7.1</Width> <Height>8.1</Height> <Cube>350.81099999999992</Cube> <Area>43.309999999999995</Area> <Density>20.195489879165709</Density> <BaseCharge>12.1</BaseCharge> </TrackDetailLine> </Details> <TotalUnits>6</TotalUnits> <TotalWeight>7.1</TotalWeight> <BaseCharge>8.1</BaseCharge> <Accessorials> <TrackAccessorial> <Code>sample string 1</Code> <Description>sample string 2</Description> <Charge>3.1</Charge> </TrackAccessorial> <TrackAccessorial> <Code>sample string 1</Code> <Description>sample string 2</Description> <Charge>3.1</Charge> </TrackAccessorial> </Accessorials> <AccessorialCharge>9.1</AccessorialCharge> <FuelCharge>10.1</FuelCharge> <HiCostCharge>11.1</HiCostCharge> <TotalCharge>12.1</TotalCharge> </Track> <Track> <FreightBillNum>sample string 1</FreightBillNum> <ProNum>sample string 2</ProNum> <PrimaryReferenceNum>sample string 3</PrimaryReferenceNum> <Reference> <TrackReference> <Number>sample string 1</Number> <Type>sample string 2</Type> </TrackReference> <TrackReference> <Number>sample string 1</Number> <Type>sample string 2</Type> </TrackReference> </Reference> <Status> <TrackStatus> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <Description>sample string 2</Description> </TrackStatus> <TrackStatus> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <Description>sample string 2</Description> </TrackStatus> </Status> <Images> <Image> <ImageId>sample string 1</ImageId> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <DocumentType>sample string 3</DocumentType> <FileFormat>sample string 4</FileFormat> <Content>QEA=</Content> </Image> <Image> <ImageId>sample string 1</ImageId> <Timestamp>2024-10-13T05:46:18.7925122-05:00</Timestamp> <DocumentType>sample string 3</DocumentType> <FileFormat>sample string 4</FileFormat> <Content>QEA=</Content> </Image> </Images> <ShipperAddress> <Name>sample string 1</Name> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Country>sample string 7</Country> <Contact>sample string 8</Contact> <Phone>sample string 9</Phone> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> </ShipperAddress> <ConsigneeAddress> <Name>sample string 1</Name> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Country>sample string 7</Country> <Contact>sample string 8</Contact> <Phone>sample string 9</Phone> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> </ConsigneeAddress> <BillingTerms>sample string 4</BillingTerms> <BillingAddress> <Name>sample string 1</Name> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Country>sample string 7</Country> <Contact>sample string 8</Contact> <Phone>sample string 9</Phone> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> </BillingAddress> <PickupSchedule> <After>2024-10-13T05:46:18.7925122-05:00</After> <Before>2024-10-13T05:46:18.7925122-05:00</Before> <AppointmentRequired>true</AppointmentRequired> <AppointmentMade>true</AppointmentMade> </PickupSchedule> <PickupDate>2024-10-13T05:46:18.7925122-05:00</PickupDate> <DeliverySchedule> <After>2024-10-13T05:46:18.7925122-05:00</After> <Before>2024-10-13T05:46:18.7925122-05:00</Before> <AppointmentRequired>true</AppointmentRequired> <AppointmentMade>true</AppointmentMade> </DeliverySchedule> <DeliveryDate>2024-10-13T05:46:18.7925122-05:00</DeliveryDate> <DeliverySignatory>sample string 5</DeliverySignatory> <Details> <TrackDetailLine> <Units>1</Units> <PackageType>sample string 2</PackageType> <Description>sample string 3</Description> <Weight>4.1</Weight> <Class>5.1</Class> <Length>6.1</Length> <Width>7.1</Width> <Height>8.1</Height> <Cube>350.81099999999992</Cube> <Area>43.309999999999995</Area> <Density>20.195489879165709</Density> <BaseCharge>12.1</BaseCharge> </TrackDetailLine> <TrackDetailLine> <Units>1</Units> <PackageType>sample string 2</PackageType> <Description>sample string 3</Description> <Weight>4.1</Weight> <Class>5.1</Class> <Length>6.1</Length> <Width>7.1</Width> <Height>8.1</Height> <Cube>350.81099999999992</Cube> <Area>43.309999999999995</Area> <Density>20.195489879165709</Density> <BaseCharge>12.1</BaseCharge> </TrackDetailLine> </Details> <TotalUnits>6</TotalUnits> <TotalWeight>7.1</TotalWeight> <BaseCharge>8.1</BaseCharge> <Accessorials> <TrackAccessorial> <Code>sample string 1</Code> <Description>sample string 2</Description> <Charge>3.1</Charge> </TrackAccessorial> <TrackAccessorial> <Code>sample string 1</Code> <Description>sample string 2</Description> <Charge>3.1</Charge> </TrackAccessorial> </Accessorials> <AccessorialCharge>9.1</AccessorialCharge> <FuelCharge>10.1</FuelCharge> <HiCostCharge>11.1</HiCostCharge> <TotalCharge>12.1</TotalCharge> </Track> </ArrayOfTrack>