GET api/ShipTrack?key={key}&shipmentReferences={shipmentReferences}

Request Information

URI Parameters

Name	Description	Type	Additional information
key		string	Required
shipmentReferences		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ShipmentTracking

Name	Type	Additional information
TrackingNumber	string	None.
ShipmentType	string	None.
LanguageCode	string	None.
CountryCode	string	None.
Success	boolean	None.
Status	string	None.
StatusLocale	string	None.
CurrentStatus	Activity	None.
PackageWeight	PackageWeight	None.
ShipmentMethod	string	None.
Activity	Collection of Activity	None.
Errors	Collection of Error	None.
EstimateDeliveryDate	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "TrackingNumber": "sample string 1",
    "ShipmentType": "sample string 2",
    "Success": true,
    "Status": "sample string 6",
    "StatusLocale": "sample string 7",
    "CurrentStatus": {
      "ActivityLocation": {
        "Address": {
          "AddressLine": "sample string 1",
          "City": "sample string 2",
          "StateProvinceCode": "sample string 3",
          "PostalCode": "sample string 4",
          "CountryCode": "sample string 5"
        },
        "DeliverySignatureNameField": "sample string 1"
      },
      "Status": "sample string 1",
      "ActivityDateTime": "sample string 5"
    },
    "PackageWeight": {
      "UnitOfMeasurement": "sample string 1",
      "Weight": "sample string 2"
    },
    "ShipmentMethod": "sample string 8",
    "Activity": [
      {
        "ActivityLocation": {
          "Address": {
            "AddressLine": "sample string 1",
            "City": "sample string 2",
            "StateProvinceCode": "sample string 3",
            "PostalCode": "sample string 4",
            "CountryCode": "sample string 5"
          },
          "DeliverySignatureNameField": "sample string 1"
        },
        "Status": "sample string 1",
        "ActivityDateTime": "sample string 5"
      },
      {
        "ActivityLocation": {
          "Address": {
            "AddressLine": "sample string 1",
            "City": "sample string 2",
            "StateProvinceCode": "sample string 3",
            "PostalCode": "sample string 4",
            "CountryCode": "sample string 5"
          },
          "DeliverySignatureNameField": "sample string 1"
        },
        "Status": "sample string 1",
        "ActivityDateTime": "sample string 5"
      }
    ],
    "Errors": [
      {
        "Description": "sample string 1"
      },
      {
        "Description": "sample string 1"
      }
    ],
    "EstimateDeliveryDate": "sample string 9"
  },
  {
    "TrackingNumber": "sample string 1",
    "ShipmentType": "sample string 2",
    "Success": true,
    "Status": "sample string 6",
    "StatusLocale": "sample string 7",
    "CurrentStatus": {
      "ActivityLocation": {
        "Address": {
          "AddressLine": "sample string 1",
          "City": "sample string 2",
          "StateProvinceCode": "sample string 3",
          "PostalCode": "sample string 4",
          "CountryCode": "sample string 5"
        },
        "DeliverySignatureNameField": "sample string 1"
      },
      "Status": "sample string 1",
      "ActivityDateTime": "sample string 5"
    },
    "PackageWeight": {
      "UnitOfMeasurement": "sample string 1",
      "Weight": "sample string 2"
    },
    "ShipmentMethod": "sample string 8",
    "Activity": [
      {
        "ActivityLocation": {
          "Address": {
            "AddressLine": "sample string 1",
            "City": "sample string 2",
            "StateProvinceCode": "sample string 3",
            "PostalCode": "sample string 4",
            "CountryCode": "sample string 5"
          },
          "DeliverySignatureNameField": "sample string 1"
        },
        "Status": "sample string 1",
        "ActivityDateTime": "sample string 5"
      },
      {
        "ActivityLocation": {
          "Address": {
            "AddressLine": "sample string 1",
            "City": "sample string 2",
            "StateProvinceCode": "sample string 3",
            "PostalCode": "sample string 4",
            "CountryCode": "sample string 5"
          },
          "DeliverySignatureNameField": "sample string 1"
        },
        "Status": "sample string 1",
        "ActivityDateTime": "sample string 5"
      }
    ],
    "Errors": [
      {
        "Description": "sample string 1"
      },
      {
        "Description": "sample string 1"
      }
    ],
    "EstimateDeliveryDate": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfShipmentTracking xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DK_ShippingStatusApi.Models">
  <ShipmentTracking>
    <Activity>
      <Activity>
        <ActivityDateTime>sample string 5</ActivityDateTime>
        <ActivityLocation>
          <Address>
            <AddressLine>sample string 1</AddressLine>
            <City>sample string 2</City>
            <CountryCode>sample string 5</CountryCode>
            <PostalCode>sample string 4</PostalCode>
            <StateProvinceCode>sample string 3</StateProvinceCode>
          </Address>
          <DeliverySignatureNameField>sample string 1</DeliverySignatureNameField>
        </ActivityLocation>
        <Date>sample string 2</Date>
        <Offset>sample string 4</Offset>
        <Status>sample string 1</Status>
        <Time>sample string 3</Time>
      </Activity>
      <Activity>
        <ActivityDateTime>sample string 5</ActivityDateTime>
        <ActivityLocation>
          <Address>
            <AddressLine>sample string 1</AddressLine>
            <City>sample string 2</City>
            <CountryCode>sample string 5</CountryCode>
            <PostalCode>sample string 4</PostalCode>
            <StateProvinceCode>sample string 3</StateProvinceCode>
          </Address>
          <DeliverySignatureNameField>sample string 1</DeliverySignatureNameField>
        </ActivityLocation>
        <Date>sample string 2</Date>
        <Offset>sample string 4</Offset>
        <Status>sample string 1</Status>
        <Time>sample string 3</Time>
      </Activity>
    </Activity>
    <CurrentStatus>
      <ActivityDateTime>sample string 5</ActivityDateTime>
      <ActivityLocation>
        <Address>
          <AddressLine>sample string 1</AddressLine>
          <City>sample string 2</City>
          <CountryCode>sample string 5</CountryCode>
          <PostalCode>sample string 4</PostalCode>
          <StateProvinceCode>sample string 3</StateProvinceCode>
        </Address>
        <DeliverySignatureNameField>sample string 1</DeliverySignatureNameField>
      </ActivityLocation>
      <Date>sample string 2</Date>
      <Offset>sample string 4</Offset>
      <Status>sample string 1</Status>
      <Time>sample string 3</Time>
    </CurrentStatus>
    <Errors>
      <Error>
        <Description>sample string 1</Description>
      </Error>
      <Error>
        <Description>sample string 1</Description>
      </Error>
    </Errors>
    <EstimateDeliveryDate>sample string 9</EstimateDeliveryDate>
    <PackageWeight>
      <UnitOfMeasurement>sample string 1</UnitOfMeasurement>
      <Weight>sample string 2</Weight>
    </PackageWeight>
    <ShipmentMethod>sample string 8</ShipmentMethod>
    <ShipmentType>sample string 2</ShipmentType>
    <Status>sample string 6</Status>
    <StatusLocale>sample string 7</StatusLocale>
    <Success>true</Success>
    <TrackingNumber>sample string 1</TrackingNumber>
    <bStoreInCache>true</bStoreInCache>
  </ShipmentTracking>
  <ShipmentTracking>
    <Activity>
      <Activity>
        <ActivityDateTime>sample string 5</ActivityDateTime>
        <ActivityLocation>
          <Address>
            <AddressLine>sample string 1</AddressLine>
            <City>sample string 2</City>
            <CountryCode>sample string 5</CountryCode>
            <PostalCode>sample string 4</PostalCode>
            <StateProvinceCode>sample string 3</StateProvinceCode>
          </Address>
          <DeliverySignatureNameField>sample string 1</DeliverySignatureNameField>
        </ActivityLocation>
        <Date>sample string 2</Date>
        <Offset>sample string 4</Offset>
        <Status>sample string 1</Status>
        <Time>sample string 3</Time>
      </Activity>
      <Activity>
        <ActivityDateTime>sample string 5</ActivityDateTime>
        <ActivityLocation>
          <Address>
            <AddressLine>sample string 1</AddressLine>
            <City>sample string 2</City>
            <CountryCode>sample string 5</CountryCode>
            <PostalCode>sample string 4</PostalCode>
            <StateProvinceCode>sample string 3</StateProvinceCode>
          </Address>
          <DeliverySignatureNameField>sample string 1</DeliverySignatureNameField>
        </ActivityLocation>
        <Date>sample string 2</Date>
        <Offset>sample string 4</Offset>
        <Status>sample string 1</Status>
        <Time>sample string 3</Time>
      </Activity>
    </Activity>
    <CurrentStatus>
      <ActivityDateTime>sample string 5</ActivityDateTime>
      <ActivityLocation>
        <Address>
          <AddressLine>sample string 1</AddressLine>
          <City>sample string 2</City>
          <CountryCode>sample string 5</CountryCode>
          <PostalCode>sample string 4</PostalCode>
          <StateProvinceCode>sample string 3</StateProvinceCode>
        </Address>
        <DeliverySignatureNameField>sample string 1</DeliverySignatureNameField>
      </ActivityLocation>
      <Date>sample string 2</Date>
      <Offset>sample string 4</Offset>
      <Status>sample string 1</Status>
      <Time>sample string 3</Time>
    </CurrentStatus>
    <Errors>
      <Error>
        <Description>sample string 1</Description>
      </Error>
      <Error>
        <Description>sample string 1</Description>
      </Error>
    </Errors>
    <EstimateDeliveryDate>sample string 9</EstimateDeliveryDate>
    <PackageWeight>
      <UnitOfMeasurement>sample string 1</UnitOfMeasurement>
      <Weight>sample string 2</Weight>
    </PackageWeight>
    <ShipmentMethod>sample string 8</ShipmentMethod>
    <ShipmentType>sample string 2</ShipmentType>
    <Status>sample string 6</Status>
    <StatusLocale>sample string 7</StatusLocale>
    <Success>true</Success>
    <TrackingNumber>sample string 1</TrackingNumber>
    <bStoreInCache>true</bStoreInCache>
  </ShipmentTracking>
</ArrayOfShipmentTracking>