SwsimV40 Web Service

SwsimV40

Click here for a complete list of operations.

CreateScanForm

Generate a SCAN form.

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 /swsim/swsimv40.asmx HTTP/1.1
Host: swsim.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2014/12/swsim/swsimv40/CreateScanForm"

<?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>
    <CreateScanForm xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <StampsTxIDs>
        <guid>guid</guid>
        <guid>guid</guid>
      </StampsTxIDs>
      <FromAddress>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
      </FromAddress>
      <ImageType>Auto or Png or Gif or Pdf or Epl or Jpg or PrintOncePdf or EncryptedPngUrl or Zpl or AZpl or BZpl</ImageType>
      <PrintInstructions>boolean</PrintInstructions>
      <Carrier>Usps or Dhl</Carrier>
      <ShipDate>date</ShipDate>
    </CreateScanForm>
  </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>
    <CreateScanFormResponse xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <Authenticator>string</Authenticator>
      <ScanFormId>string</ScanFormId>
      <Url>string</Url>
    </CreateScanFormResponse>
  </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 /swsim/swsimv40.asmx HTTP/1.1
Host: swsim.stamps.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>
    <CreateScanForm xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <StampsTxIDs>
        <guid>guid</guid>
        <guid>guid</guid>
      </StampsTxIDs>
      <FromAddress>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
      </FromAddress>
      <ImageType>Auto or Png or Gif or Pdf or Epl or Jpg or PrintOncePdf or EncryptedPngUrl or Zpl or AZpl or BZpl</ImageType>
      <PrintInstructions>boolean</PrintInstructions>
      <Carrier>Usps or Dhl</Carrier>
      <ShipDate>date</ShipDate>
    </CreateScanForm>
  </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>
    <CreateScanFormResponse xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <Authenticator>string</Authenticator>
      <ScanFormId>string</ScanFormId>
      <Url>string</Url>
    </CreateScanFormResponse>
  </soap12:Body>
</soap12:Envelope>