PostalWS


Click here for a complete list of operations.

SendLetterAdvanced

The SendLetterAdvanced() method offers full control over the settings of each letter sent through the PostalMethods service. The method also allows sending multiple documents to be concatenated to a single letter. Additional settings parameters will be offered over time.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /2009-09-09/PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "PostalMethods/SendLetterAdvanced"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendLetterAdvanced xmlns="PostalMethods">
      <APIKey>string</APIKey>
      <MyDescription>string</MyDescription>
      <Files>
        <File>
          <FileExtension>string</FileExtension>
          <FileBinaryData>base64Binary</FileBinaryData>
        </File>
        <File>
          <FileExtension>string</FileExtension>
          <FileBinaryData>base64Binary</FileBinaryData>
        </File>
      </Files>
      <Addresses>
        <RecipientAddress>
          <AttentionLine1>string</AttentionLine1>
          <AttentionLine2>string</AttentionLine2>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zipcode>string</Zipcode>
          <Country>string</Country>
        </RecipientAddress>
        <ReplyAddress>
          <Contact>
            <AttentionLine1>string</AttentionLine1>
            <AttentionLine2>string</AttentionLine2>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <Zipcode>string</Zipcode>
            <Country>string</Country>
          </Contact>
          <StampingLocation>Top or Bottom</StampingLocation>
        </ReplyAddress>
      </Addresses>
      <Settings>
        <Perforation>BottomThird</Perforation>
        <ReplyEnvelope>Env9ReplySingleWindow</ReplyEnvelope>
        <WorkMode>Default or Production or Development</WorkMode>
        <PrintColor>Default or Black or FullColor</PrintColor>
      </Settings>
    </SendLetterAdvanced>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendLetterAdvancedResponse xmlns="PostalMethods">
      <SendLetterAdvancedResult>int</SendLetterAdvancedResult>
    </SendLetterAdvancedResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /2009-09-09/PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendLetterAdvanced xmlns="PostalMethods">
      <APIKey>string</APIKey>
      <MyDescription>string</MyDescription>
      <Files>
        <File>
          <FileExtension>string</FileExtension>
          <FileBinaryData>base64Binary</FileBinaryData>
        </File>
        <File>
          <FileExtension>string</FileExtension>
          <FileBinaryData>base64Binary</FileBinaryData>
        </File>
      </Files>
      <Addresses>
        <RecipientAddress>
          <AttentionLine1>string</AttentionLine1>
          <AttentionLine2>string</AttentionLine2>
          <Company>string</Company>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zipcode>string</Zipcode>
          <Country>string</Country>
        </RecipientAddress>
        <ReplyAddress>
          <Contact>
            <AttentionLine1>string</AttentionLine1>
            <AttentionLine2>string</AttentionLine2>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <Zipcode>string</Zipcode>
            <Country>string</Country>
          </Contact>
          <StampingLocation>Top or Bottom</StampingLocation>
        </ReplyAddress>
      </Addresses>
      <Settings>
        <Perforation>BottomThird</Perforation>
        <ReplyEnvelope>Env9ReplySingleWindow</ReplyEnvelope>
        <WorkMode>Default or Production or Development</WorkMode>
        <PrintColor>Default or Black or FullColor</PrintColor>
      </Settings>
    </SendLetterAdvanced>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendLetterAdvancedResponse xmlns="PostalMethods">
      <SendLetterAdvancedResult>int</SendLetterAdvancedResult>
    </SendLetterAdvancedResponse>
  </soap12:Body>
</soap12:Envelope>