POST api/orders/{OrderNumber}/trackShipment

Tracks one or more shipments.

Request Information

URI Parameters

Name	Description	Type	Additional information
OrderNumber	Work order number	integer	Required

Body Parameters

Structure providing additional information about which packages to track.

ShipmentTrackRequest

Name	Description	Type	Additional information
ShipmentIds	Ids of the shipments to track. If omitted, all shipments from the order will be tracked.	Collection of integer	Min length: 1
ReturnAllData	Whether to return all data or just the latest event.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipmentIds": [
    1,
    2
  ],
  "ReturnAllData": true
}

application/xml, text/xml

Sample:

<ShipmentTrackRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ShipmentIds>
    <int>1</int>
    <int>2</int>
  </ShipmentIds>
  <ReturnAllData>true</ReturnAllData>
</ShipmentTrackRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A structure returning data associated with the tracking of the shipments.

ShipmentTrackResponse

Name	Description	Type	Additional information
TrackingInformation	An array of structures detailing the tracking information for one or more packages.	Collection of ShipmentTrackInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "TrackingInformation": [
    {
      "ShipmentId": 1,
      "PackageId": 2,
      "TrackingId": "sample string 3",
      "Status": 0,
      "Events": [
        {
          "Timestamp": "2024-05-18T04:51:41.0665922-04:00",
          "EventType": "sample string 2",
          "EventDescription": "sample string 3",
          "EventCode": "sample string 4",
          "Address": {
            "Street1": "sample string 1",
            "Street2": "sample string 2",
            "City": "sample string 3",
            "Region": "sample string 4",
            "Postalcode": "sample string 5",
            "PostalZip4": "sample string 6",
            "CountryCode": "sample string 7"
          },
          "SignedForBy": "sample string 5"
        },
        {
          "Timestamp": "2024-05-18T04:51:41.0665922-04:00",
          "EventType": "sample string 2",
          "EventDescription": "sample string 3",
          "EventCode": "sample string 4",
          "Address": {
            "Street1": "sample string 1",
            "Street2": "sample string 2",
            "City": "sample string 3",
            "Region": "sample string 4",
            "Postalcode": "sample string 5",
            "PostalZip4": "sample string 6",
            "CountryCode": "sample string 7"
          },
          "SignedForBy": "sample string 5"
        }
      ]
    },
    {
      "ShipmentId": 1,
      "PackageId": 2,
      "TrackingId": "sample string 3",
      "Status": 0,
      "Events": [
        {
          "Timestamp": "2024-05-18T04:51:41.0665922-04:00",
          "EventType": "sample string 2",
          "EventDescription": "sample string 3",
          "EventCode": "sample string 4",
          "Address": {
            "Street1": "sample string 1",
            "Street2": "sample string 2",
            "City": "sample string 3",
            "Region": "sample string 4",
            "Postalcode": "sample string 5",
            "PostalZip4": "sample string 6",
            "CountryCode": "sample string 7"
          },
          "SignedForBy": "sample string 5"
        },
        {
          "Timestamp": "2024-05-18T04:51:41.0665922-04:00",
          "EventType": "sample string 2",
          "EventDescription": "sample string 3",
          "EventCode": "sample string 4",
          "Address": {
            "Street1": "sample string 1",
            "Street2": "sample string 2",
            "City": "sample string 3",
            "Region": "sample string 4",
            "Postalcode": "sample string 5",
            "PostalZip4": "sample string 6",
            "CountryCode": "sample string 7"
          },
          "SignedForBy": "sample string 5"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentTrackResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TrackingInformation>
    <ShipmentTrackInfo>
      <ShipmentId>1</ShipmentId>
      <PackageId>2</PackageId>
      <TrackingId>sample string 3</TrackingId>
      <Status>Draft</Status>
      <Events>
        <ShipmentTrackInfoEvent>
          <Timestamp>2024-05-18T04:51:41.0665922-04:00</Timestamp>
          <EventType>sample string 2</EventType>
          <EventDescription>sample string 3</EventDescription>
          <EventCode>sample string 4</EventCode>
          <Address>
            <Street1>sample string 1</Street1>
            <Street2>sample string 2</Street2>
            <City>sample string 3</City>
            <Region>sample string 4</Region>
            <Postalcode>sample string 5</Postalcode>
            <PostalZip4>sample string 6</PostalZip4>
            <CountryCode>sample string 7</CountryCode>
          </Address>
          <SignedForBy>sample string 5</SignedForBy>
        </ShipmentTrackInfoEvent>
        <ShipmentTrackInfoEvent>
          <Timestamp>2024-05-18T04:51:41.0665922-04:00</Timestamp>
          <EventType>sample string 2</EventType>
          <EventDescription>sample string 3</EventDescription>
          <EventCode>sample string 4</EventCode>
          <Address>
            <Street1>sample string 1</Street1>
            <Street2>sample string 2</Street2>
            <City>sample string 3</City>
            <Region>sample string 4</Region>
            <Postalcode>sample string 5</Postalcode>
            <PostalZip4>sample string 6</PostalZip4>
            <CountryCode>sample string 7</CountryCode>
          </Address>
          <SignedForBy>sample string 5</SignedForBy>
        </ShipmentTrackInfoEvent>
      </Events>
    </ShipmentTrackInfo>
    <ShipmentTrackInfo>
      <ShipmentId>1</ShipmentId>
      <PackageId>2</PackageId>
      <TrackingId>sample string 3</TrackingId>
      <Status>Draft</Status>
      <Events>
        <ShipmentTrackInfoEvent>
          <Timestamp>2024-05-18T04:51:41.0665922-04:00</Timestamp>
          <EventType>sample string 2</EventType>
          <EventDescription>sample string 3</EventDescription>
          <EventCode>sample string 4</EventCode>
          <Address>
            <Street1>sample string 1</Street1>
            <Street2>sample string 2</Street2>
            <City>sample string 3</City>
            <Region>sample string 4</Region>
            <Postalcode>sample string 5</Postalcode>
            <PostalZip4>sample string 6</PostalZip4>
            <CountryCode>sample string 7</CountryCode>
          </Address>
          <SignedForBy>sample string 5</SignedForBy>
        </ShipmentTrackInfoEvent>
        <ShipmentTrackInfoEvent>
          <Timestamp>2024-05-18T04:51:41.0665922-04:00</Timestamp>
          <EventType>sample string 2</EventType>
          <EventDescription>sample string 3</EventDescription>
          <EventCode>sample string 4</EventCode>
          <Address>
            <Street1>sample string 1</Street1>
            <Street2>sample string 2</Street2>
            <City>sample string 3</City>
            <Region>sample string 4</Region>
            <Postalcode>sample string 5</Postalcode>
            <PostalZip4>sample string 6</PostalZip4>
            <CountryCode>sample string 7</CountryCode>
          </Address>
          <SignedForBy>sample string 5</SignedForBy>
        </ShipmentTrackInfoEvent>
      </Events>
    </ShipmentTrackInfo>
  </TrackingInformation>
</ShipmentTrackResponse>