POST api/MailTracking/GetCertifiedTracking

Gets basic certified tracking delivery details for the provided list of orders. For additional details, use the results from this and pass specific recipients to GetCertifiedTrackingDetails.

Request Information

URI Parameters

None.

Body Parameters

GetCertifiedTrackingRequestModel

Name	Description	Type	Additional information
UserId		integer	None.
AuthToken		string	None.
OrderIdList	The SouthData order number that will be used to search for tracking information. OrderIdList is required and must be a positive number.	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:

<GetCertifiedTrackingRequestModel 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>
</GetCertifiedTrackingRequestModel>

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 basic certified tracking delivery details for the provided list of orders

GetCertifiedTrackingResponseModel

Name	Type	Additional information
ClientId	integer	None.
OrderId	integer	None.
AccountNumber	string	None.
Name1	string	None.
Name2	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
State	string	None.
Zip	string	None.
USPSReceipt	string	None.
TrackingStatus	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "OrderId": 2,
  "AccountNumber": "sample string 3",
  "Name1": "sample string 4",
  "Name2": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "Zip": "sample string 10",
  "USPSReceipt": "sample string 11",
  "TrackingStatus": "sample string 12"
}

application/xml, text/xml

Sample:

<GetCertifiedTrackingResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AccountNumber>sample string 3</AccountNumber>
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <City>sample string 8</City>
  <ClientId>1</ClientId>
  <Name1>sample string 4</Name1>
  <Name2>sample string 5</Name2>
  <OrderId>2</OrderId>
  <State>sample string 9</State>
  <TrackingStatus>sample string 12</TrackingStatus>
  <USPSReceipt>sample string 11</USPSReceipt>
  <Zip>sample string 10</Zip>
</GetCertifiedTrackingResponseModel>