GET api/Track/{CompanyID}/{TrackingNumber}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyID | integer |
Required |
|
TrackingNumber | string |
Required |
Body Parameters
None.
Response Information
Resource Description
TrackingInfoName | Description | Type | Additional information |
---|---|---|---|
TrackingNumber | string |
None. |
|
StatusDescription | string |
None. |
|
DateOfShipment | date |
None. |
|
Pieces | integer |
None. |
|
Weight | decimal number |
None. |
|
WeightUOM | string |
None. |
|
PickupCityName | string |
None. |
|
PickupStateProvID | string |
None. |
|
PickupCountryID | string |
None. |
|
PickupCountryName | string |
None. |
|
DeliveryCityName | string |
None. |
|
DeliveryStateProvID | string |
None. |
|
DeliveryCountryID | string |
None. |
|
DeliveryCountryName | string |
None. |
|
Itinerary | Collection of ItineraryItem |
None. |
|
LocationLatitude | decimal number |
None. |
|
LocationLongitude | decimal number |
None. |
|
IsSuccessful | boolean |
None. |
|
ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "TrackingNumber": "sample string 1", "StatusDescription": "sample string 2", "DateOfShipment": "2024-12-28T09:57:02.0566544+00:00", "Pieces": 4, "Weight": 1.0, "WeightUOM": "sample string 5", "PickupCityName": "sample string 6", "PickupStateProvID": "sample string 7", "PickupCountryID": "sample string 8", "PickupCountryName": "sample string 9", "DeliveryCityName": "sample string 10", "DeliveryStateProvID": "sample string 11", "DeliveryCountryID": "sample string 12", "DeliveryCountryName": "sample string 13", "Itinerary": [ { "IsComplete": true, "StepName": "sample string 2", "StepDescription": "sample string 3", "CompletedUTC": "2024-12-28T09:57:02.0566544+00:00", "CompletedLocal": "2024-12-28T09:57:02.0566544+00:00" }, { "IsComplete": true, "StepName": "sample string 2", "StepDescription": "sample string 3", "CompletedUTC": "2024-12-28T09:57:02.0566544+00:00", "CompletedLocal": "2024-12-28T09:57:02.0566544+00:00" } ], "LocationLatitude": 1.0, "LocationLongitude": 1.0, "IsSuccessful": true, "ErrorMessage": "sample string 15" }
application/xml, text/xml
Sample:
<TrackingInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models"> <ErrorMessage>sample string 15</ErrorMessage> <IsSuccessful>true</IsSuccessful> <DateOfShipment>2024-12-28T09:57:02.0566544+00:00</DateOfShipment> <DeliveryCityName>sample string 10</DeliveryCityName> <DeliveryCountryID>sample string 12</DeliveryCountryID> <DeliveryCountryName>sample string 13</DeliveryCountryName> <DeliveryStateProvID>sample string 11</DeliveryStateProvID> <Itinerary> <ItineraryItem> <CompletedLocal>2024-12-28T09:57:02.0566544+00:00</CompletedLocal> <CompletedUTC>2024-12-28T09:57:02.0566544+00:00</CompletedUTC> <IsComplete>true</IsComplete> <StepDescription>sample string 3</StepDescription> <StepName>sample string 2</StepName> </ItineraryItem> <ItineraryItem> <CompletedLocal>2024-12-28T09:57:02.0566544+00:00</CompletedLocal> <CompletedUTC>2024-12-28T09:57:02.0566544+00:00</CompletedUTC> <IsComplete>true</IsComplete> <StepDescription>sample string 3</StepDescription> <StepName>sample string 2</StepName> </ItineraryItem> </Itinerary> <LocationLatitude>1</LocationLatitude> <LocationLongitude>1</LocationLongitude> <PickupCityName>sample string 6</PickupCityName> <PickupCountryID>sample string 8</PickupCountryID> <PickupCountryName>sample string 9</PickupCountryName> <PickupStateProvID>sample string 7</PickupStateProvID> <Pieces>4</Pieces> <StatusDescription>sample string 2</StatusDescription> <TrackingNumber>sample string 1</TrackingNumber> <Weight>1</Weight> <WeightUOM>sample string 5</WeightUOM> </TrackingInfo>