SwsimV84 Web Service

SwsimV84

Click here for a complete list of operations.

GetAccountInfo

Get account information, including postage balance.

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/swsimv84.asmx HTTP/1.1
Host: swsim.testing.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2019/09/swsim/SwsimV84/GetAccountInfo"

<?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>
    <GetAccountInfo xmlns="http://stamps.com/xml/namespace/2019/09/swsim/SwsimV84" />
  </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>
    <GetAccountInfoResponse xmlns="http://stamps.com/xml/namespace/2019/09/swsim/SwsimV84">
      <Authenticator>string</Authenticator>
      <AccountInfo>
        <CustomerID>int</CustomerID>
        <MeterNumber>int</MeterNumber>
        <UserID>int</UserID>
        <PostageBalance>
          <AvailablePostage>decimal</AvailablePostage>
          <ControlTotal>decimal</ControlTotal>
        </PostageBalance>
        <MaxPostageBalance>decimal</MaxPostageBalance>
        <LPOCity>string</LPOCity>
        <LPOState>string</LPOState>
        <LPOZip>string</LPOZip>
        <AccountId>long</AccountId>
        <CorpID>int</CorpID>
        <StoreID>string</StoreID>
        <CostCodeLimit>int</CostCodeLimit>
        <MonthlyPostagePurchaseLimit>int</MonthlyPostagePurchaseLimit>
        <MaxUsers>int</MaxUsers>
        <Capabilities>
          <AlwaysIncludeDefaultImageOnShippingLabels>boolean</AlwaysIncludeDefaultImageOnShippingLabels>
        </Capabilities>
        <MeterPhysicalAddress>
          <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>
          <EmailAddress>string</EmailAddress>
          <FullAddress>string</FullAddress>
        </MeterPhysicalAddress>
        <ResubmitStatus>NOT_IN_RESUBMISSION or PAYMENT_RESUBMISSION or NON_CORRECTABLE_PAYMENT_RESUBMISSION</ResubmitStatus>
        <ResubmitCookie>string</ResubmitCookie>
        <PlanID>int</PlanID>
        <PendingPlanId>int</PendingPlanId>
        <Username>string</Username>
        <RatesetType>Unknown or Retail or CBP or CPP or NSA or STMP</RatesetType>
        <USPSRep>boolean</USPSRep>
        <AutoBuySettings>
          <AutoBuyEnabled>boolean</AutoBuyEnabled>
          <PurchaseAmount>decimal</PurchaseAmount>
          <TriggerAmount>decimal</TriggerAmount>
        </AutoBuySettings>
        <RateToken>string</RateToken>
        <CustomerData>string</CustomerData>
        <Terms>
          <TermsGP>boolean</TermsGP>
          <TermsAR>boolean</TermsAR>
          <TermsSL>boolean</TermsSL>
          <TermsDX>boolean</TermsDX>
          <TermsFX>boolean</TermsFX>
        </Terms>
        <OutstandingLabelBalance>decimal</OutstandingLabelBalance>
        <MaxOutstandingLabelBalance>decimal</MaxOutstandingLabelBalance>
        <Merchant>string</Merchant>
        <MeterProvider>string</MeterProvider>
        <MaxImageCount>int</MaxImageCount>
        <SEApiToken>string</SEApiToken>
        <GAPickupCarrier>None or Usps or Dhl</GAPickupCarrier>
        <LocalCurrency>string</LocalCurrency>
        <HasPOURMailerID>boolean</HasPOURMailerID>
        <MaxParcelGuardInsuredValue>decimal</MaxParcelGuardInsuredValue>
        <FacilityAssigned>boolean</FacilityAssigned>
      </AccountInfo>
      <Address>
        <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>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </Address>
      <CustomerEmail>string</CustomerEmail>
      <AccountStatus>string</AccountStatus>
      <DateAdvanceConfig>
        <MaxDateAdvanceEnvelope>int</MaxDateAdvanceEnvelope>
        <MaxDateAdvanceMailingLabel>int</MaxDateAdvanceMailingLabel>
        <MaxDateAdvanceShippingLabel>int</MaxDateAdvanceShippingLabel>
      </DateAdvanceConfig>
      <VerificationPhoneNumber>string</VerificationPhoneNumber>
      <VerificationPhoneExtension>string</VerificationPhoneExtension>
    </GetAccountInfoResponse>
  </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/swsimv84.asmx HTTP/1.1
Host: swsim.testing.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>
    <GetAccountInfo xmlns="http://stamps.com/xml/namespace/2019/09/swsim/SwsimV84" />
  </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>
    <GetAccountInfoResponse xmlns="http://stamps.com/xml/namespace/2019/09/swsim/SwsimV84">
      <Authenticator>string</Authenticator>
      <AccountInfo>
        <CustomerID>int</CustomerID>
        <MeterNumber>int</MeterNumber>
        <UserID>int</UserID>
        <PostageBalance>
          <AvailablePostage>decimal</AvailablePostage>
          <ControlTotal>decimal</ControlTotal>
        </PostageBalance>
        <MaxPostageBalance>decimal</MaxPostageBalance>
        <LPOCity>string</LPOCity>
        <LPOState>string</LPOState>
        <LPOZip>string</LPOZip>
        <AccountId>long</AccountId>
        <CorpID>int</CorpID>
        <StoreID>string</StoreID>
        <CostCodeLimit>int</CostCodeLimit>
        <MonthlyPostagePurchaseLimit>int</MonthlyPostagePurchaseLimit>
        <MaxUsers>int</MaxUsers>
        <Capabilities>
          <AlwaysIncludeDefaultImageOnShippingLabels>boolean</AlwaysIncludeDefaultImageOnShippingLabels>
        </Capabilities>
        <MeterPhysicalAddress>
          <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>
          <EmailAddress>string</EmailAddress>
          <FullAddress>string</FullAddress>
        </MeterPhysicalAddress>
        <ResubmitStatus>NOT_IN_RESUBMISSION or PAYMENT_RESUBMISSION or NON_CORRECTABLE_PAYMENT_RESUBMISSION</ResubmitStatus>
        <ResubmitCookie>string</ResubmitCookie>
        <PlanID>int</PlanID>
        <PendingPlanId>int</PendingPlanId>
        <Username>string</Username>
        <RatesetType>Unknown or Retail or CBP or CPP or NSA or STMP</RatesetType>
        <USPSRep>boolean</USPSRep>
        <AutoBuySettings>
          <AutoBuyEnabled>boolean</AutoBuyEnabled>
          <PurchaseAmount>decimal</PurchaseAmount>
          <TriggerAmount>decimal</TriggerAmount>
        </AutoBuySettings>
        <RateToken>string</RateToken>
        <CustomerData>string</CustomerData>
        <Terms>
          <TermsGP>boolean</TermsGP>
          <TermsAR>boolean</TermsAR>
          <TermsSL>boolean</TermsSL>
          <TermsDX>boolean</TermsDX>
          <TermsFX>boolean</TermsFX>
        </Terms>
        <OutstandingLabelBalance>decimal</OutstandingLabelBalance>
        <MaxOutstandingLabelBalance>decimal</MaxOutstandingLabelBalance>
        <Merchant>string</Merchant>
        <MeterProvider>string</MeterProvider>
        <MaxImageCount>int</MaxImageCount>
        <SEApiToken>string</SEApiToken>
        <GAPickupCarrier>None or Usps or Dhl</GAPickupCarrier>
        <LocalCurrency>string</LocalCurrency>
        <HasPOURMailerID>boolean</HasPOURMailerID>
        <MaxParcelGuardInsuredValue>decimal</MaxParcelGuardInsuredValue>
        <FacilityAssigned>boolean</FacilityAssigned>
      </AccountInfo>
      <Address>
        <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>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </Address>
      <CustomerEmail>string</CustomerEmail>
      <AccountStatus>string</AccountStatus>
      <DateAdvanceConfig>
        <MaxDateAdvanceEnvelope>int</MaxDateAdvanceEnvelope>
        <MaxDateAdvanceMailingLabel>int</MaxDateAdvanceMailingLabel>
        <MaxDateAdvanceShippingLabel>int</MaxDateAdvanceShippingLabel>
      </DateAdvanceConfig>
      <VerificationPhoneNumber>string</VerificationPhoneNumber>
      <VerificationPhoneExtension>string</VerificationPhoneExtension>
    </GetAccountInfoResponse>
  </soap12:Body>
</soap12:Envelope>