GetDetails

Description

The GetDetails() method returns the processing details of a single, multiple or range of letters or postcards, such as: price, number of sheets, work mode and more.

Additional production details, such as stationery items used, postage and more are available using the GetDetailsExtended method.

Formal Definition

https://api.postalmethods.com/2009-02-26/PostalWS.asmx?op=GetDetails

Input

Property Type Comments
Username String As provided during registration
Password String As provided during registration
ID String Single Item: Matches the ID provided as the response for the original Web Service request.
Multiple Items: ID1,ID2,ID3. Response is provided for up to 1000 letters per query. Additional items are ignored. Items not assigned to the account or which the user has no permission to access are returned with a "No Permissions" status code.
Range Of Items: LowerID-HigherID. Response is provided for up to 1000 letters per query. Additional items are ignored. Items not assigned to the account or which the user has no permission to access will not be returned.

Output: GetDetailsResponse

Structure: GetDetailsResult

Element Type Comments
ResultCode int Result code for this Web Service request. Possible result codes appear in the Web Service Result Codes list.
Details Array Array of RequestDetails structures

 

Structure: RequestDetails

Element Type Comments
ID int Matches the ID requested in this Web Service request
Price Decimal Total price, in US Dollars, of the letter or postcard.
NumOfSheets int Number of sheets of paper inserted to the envelope.
When using "Print Sides: Simplex", NumOfSheets equals the number of pages in the document.
Value is always "2" for postcards.
SubmitTime datetime Date and time when the letter or postcard was submitted to the PostalMethods service.
CompletionTime datetime Approximate date and time when the letter or postcard was delivered to the postal service.
Status int The current status code of the letter or postcard.
Letter Sending Status Codes
StatusDescription string The text description for the status code of the letter or postcard.
Letter Sending Status Codes
IsBatch Boolean Indicates whether the request contains a single mail item or multiple items (batch).
MyDescription String Returns the text description provided by the sender in the original send request.
MailerType Letter or Postcard Indicates whether the mail item is a letter or a postcard.
WorkMode Production or Development Indicates whether the letter was processed completely ('Production') or only simulated as a test ('Development'). In case the letter is in Development Work Mode, it was not charged and the Price value only indicates the estimated price for such a letter

Change Log

  • Rename "GetLetterDetailsV2" to "GetDetails"
  • Change "ID" type to string to allow getting details for multiple and range of items.
  • Results are provided as an array.