POST api/MailTracking/GetFirstClassTracking

Gets basic tracking details for a given list of order numbers. For additional tracking details, use results from this and retrieve additional details for specific recipients via GetFirstClassTrackingDetails.

Request Information

URI Parameters

None.

Body Parameters

GetFirstClassTrackingRequestModel

Name	Description	Type	Additional information
UserId		integer	None.
AuthToken		string	None.
OrderIdList	The SouthData order numbers that will be used to retrieve the first class tracking status. OrderIdList is required.	Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "OrderIdList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<GetFirstClassTrackingRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <OrderIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderIdList>
  <UserId>1</UserId>
</GetFirstClassTrackingRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing IMB tracking details for provided list of orders

GetFirstClassTrackingsResponseModel

Name	Description	Type	Additional information
FirstClassTrackings		Collection of GetFirstClassTrackingResponseModel	None.
ErrorDetails		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "FirstClassTrackings": [
    {
      "TrackingNumber": "sample string 1",
      "AccountNumber": "sample string 2",
      "Name": "sample string 3",
      "Address": "sample string 4",
      "City": "sample string 5",
      "StateOrRegion": "sample string 6",
      "Zip": "sample string 7",
      "EstimatedDeliveryDate": "sample string 8",
      "EstimatedReceiptDate": "sample string 9",
      "MailDate": "sample string 10",
      "OrderId": "sample string 11"
    },
    {
      "TrackingNumber": "sample string 1",
      "AccountNumber": "sample string 2",
      "Name": "sample string 3",
      "Address": "sample string 4",
      "City": "sample string 5",
      "StateOrRegion": "sample string 6",
      "Zip": "sample string 7",
      "EstimatedDeliveryDate": "sample string 8",
      "EstimatedReceiptDate": "sample string 9",
      "MailDate": "sample string 10",
      "OrderId": "sample string 11"
    }
  ],
  "ErrorDetails": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetFirstClassTrackingsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <ErrorDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorDetails>
  <FirstClassTrackings>
    <GetFirstClassTrackingResponseModel>
      <AccountNumber>sample string 2</AccountNumber>
      <Address>sample string 4</Address>
      <City>sample string 5</City>
      <EstimatedDeliveryDate>sample string 8</EstimatedDeliveryDate>
      <EstimatedReceiptDate>sample string 9</EstimatedReceiptDate>
      <MailDate>sample string 10</MailDate>
      <Name>sample string 3</Name>
      <OrderId>sample string 11</OrderId>
      <StateOrRegion>sample string 6</StateOrRegion>
      <TrackingNumber>sample string 1</TrackingNumber>
      <Zip>sample string 7</Zip>
    </GetFirstClassTrackingResponseModel>
    <GetFirstClassTrackingResponseModel>
      <AccountNumber>sample string 2</AccountNumber>
      <Address>sample string 4</Address>
      <City>sample string 5</City>
      <EstimatedDeliveryDate>sample string 8</EstimatedDeliveryDate>
      <EstimatedReceiptDate>sample string 9</EstimatedReceiptDate>
      <MailDate>sample string 10</MailDate>
      <Name>sample string 3</Name>
      <OrderId>sample string 11</OrderId>
      <StateOrRegion>sample string 6</StateOrRegion>
      <TrackingNumber>sample string 1</TrackingNumber>
      <Zip>sample string 7</Zip>
    </GetFirstClassTrackingResponseModel>
  </FirstClassTrackings>
</GetFirstClassTrackingsResponseModel>