POST api/Track

Retrieves the tracking information for one or more tracking numbers

Parameters

* Required
Property Description
Key (String)
* Your API key provided by i-parcel.
TrackingNumbers (List)
* A list of tracking numbers to see events for.
IncludeAttempts (Boolean)
If set to true, this will include parcel data that the merchant attempted to submit that did not pass our validation.

Request body formats

application/json, text/json

Sample:
{
  "key": "sample string 1",
  "TrackingNumbers": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "IncludeAttempts": true
}

application/xml, text/xml

Sample:
<TrackRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary">
  <IncludeAttempts>true</IncludeAttempts>
  <TrackingNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </TrackingNumbers>
  <key>sample string 1</key>
</TrackRequest>

Response Information

You will get back the tracking events for each requested tracking number.

Response body formats

application/json, text/json

Sample:
{
  "Parcels": [
    {
      "TrackingNumber": "sample string 1",
      "UPSTrackingNumber": "sample string 2",
      "Destination": {
        "City": "sample string 1",
        "Region": "sample string 2",
        "PostCode": "sample string 3",
        "Country": "sample string 4"
      },
      "Events": null
    },
    {
      "TrackingNumber": "sample string 1",
      "UPSTrackingNumber": "sample string 2",
      "Destination": {
        "City": "sample string 1",
        "Region": "sample string 2",
        "PostCode": "sample string 3",
        "Country": "sample string 4"
      },
      "Events": null
    },
    {
      "TrackingNumber": "sample string 1",
      "UPSTrackingNumber": "sample string 2",
      "Destination": {
        "City": "sample string 1",
        "Region": "sample string 2",
        "PostCode": "sample string 3",
        "Country": "sample string 4"
      },
      "Events": null
    }
  ]
}

application/xml, text/xml

Sample:
<TrackResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary">
  <Parcels>
    <Parcel>
      <Destination>
        <City>sample string 1</City>
        <Country>sample string 4</Country>
        <PostCode>sample string 3</PostCode>
        <Region>sample string 2</Region>
      </Destination>
      <Events i:nil="true" />
      <TrackingNumber>sample string 1</TrackingNumber>
      <UPSTrackingNumber>sample string 2</UPSTrackingNumber>
    </Parcel>
    <Parcel>
      <Destination>
        <City>sample string 1</City>
        <Country>sample string 4</Country>
        <PostCode>sample string 3</PostCode>
        <Region>sample string 2</Region>
      </Destination>
      <Events i:nil="true" />
      <TrackingNumber>sample string 1</TrackingNumber>
      <UPSTrackingNumber>sample string 2</UPSTrackingNumber>
    </Parcel>
    <Parcel>
      <Destination>
        <City>sample string 1</City>
        <Country>sample string 4</Country>
        <PostCode>sample string 3</PostCode>
        <Region>sample string 2</Region>
      </Destination>
      <Events i:nil="true" />
      <TrackingNumber>sample string 1</TrackingNumber>
      <UPSTrackingNumber>sample string 2</UPSTrackingNumber>
    </Parcel>
  </Parcels>
</TrackResponse>