PostalWSSimple


Click here for a complete list of operations.

CancelDelivery

The CancelDelivery() method is a way to cancel fulfillment of a letter still not delivered to the postal service. Cancellation may take up to a few minutes to succeed. If funds were deducted from the account, they will be refunded immediately.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
Username:
Password:
ID:

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 /PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "PostalMethods/CancelDelivery"

<?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>
    <CancelDelivery xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <ID>int</ID>
    </CancelDelivery>
  </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>
    <CancelDeliveryResponse xmlns="PostalMethods">
      <CancelDeliveryResult>int</CancelDeliveryResult>
    </CancelDeliveryResponse>
  </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 /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>
    <CancelDelivery xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <ID>int</ID>
    </CancelDelivery>
  </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>
    <CancelDeliveryResponse xmlns="PostalMethods">
      <CancelDeliveryResult>int</CancelDeliveryResult>
    </CancelDeliveryResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /PostalWS.asmx/CancelDelivery?Username=string&Password=string&ID=string HTTP/1.1
Host: api.postalmethods.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="PostalMethods">int</int>

HTTP POST

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

POST /PostalWS.asmx/CancelDelivery HTTP/1.1
Host: api.postalmethods.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&ID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="PostalMethods">int</int>