SwsimV22 Web Service

SwsimV22

Click here for a complete list of operations.

CreateNetStampsIndicia

Generate NetStamps indicia.

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

<?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>
    <CreateNetStampsIndicia xmlns="http://stamps.com/xml/namespace/2012/04/swsim/swsimv22">
      <IntegratorTxId>string</IntegratorTxId>
      <Layout>string</Layout>
      <NetStamps>
        <NetStampV4>
          <Row>int</Row>
          <Column>int</Column>
          <Rate>
            <FromZIPCode>string</FromZIPCode>
            <ToZIPCode>string</ToZIPCode>
            <ToCountry>string</ToCountry>
            <Amount>decimal</Amount>
            <MaxAmount>decimal</MaxAmount>
            <ServiceType>Unknown or US-FC or US-PM or US-XM or US-PP or US-MM or US-BP or US-EMI or US-PMI or US-FCI</ServiceType>
            <PrintLayout>string</PrintLayout>
            <DeliverDays>string</DeliverDays>
            <WeightLb>double</WeightLb>
            <WeightOz>double</WeightOz>
            <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
            <RequiresAllOf xsi:nil="true" />
            <Length>double</Length>
            <Width>double</Width>
            <Height>double</Height>
            <ShipDate>date</ShipDate>
            <InsuredValue>decimal</InsuredValue>
            <RegisteredValue>decimal</RegisteredValue>
            <CODValue>decimal</CODValue>
            <DeclaredValue>decimal</DeclaredValue>
            <NonMachinable>boolean</NonMachinable>
            <RectangularShaped>boolean</RectangularShaped>
            <Prohibitions>string</Prohibitions>
            <Restrictions>string</Restrictions>
            <Observations>string</Observations>
            <Regulations>string</Regulations>
            <GEMNotes>string</GEMNotes>
            <MaxDimensions>string</MaxDimensions>
            <DimWeighting>string</DimWeighting>
            <AddOns xsi:nil="true" />
            <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
            <IsIntraBMC>boolean</IsIntraBMC>
            <Zone>int</Zone>
            <RateCategory>int</RateCategory>
            <ToState>string</ToState>
            <CubicPricing>boolean</CubicPricing>
          </Rate>
        </NetStampV4>
        <NetStampV4>
          <Row>int</Row>
          <Column>int</Column>
          <Rate>
            <FromZIPCode>string</FromZIPCode>
            <ToZIPCode>string</ToZIPCode>
            <ToCountry>string</ToCountry>
            <Amount>decimal</Amount>
            <MaxAmount>decimal</MaxAmount>
            <ServiceType>Unknown or US-FC or US-PM or US-XM or US-PP or US-MM or US-BP or US-EMI or US-PMI or US-FCI</ServiceType>
            <PrintLayout>string</PrintLayout>
            <DeliverDays>string</DeliverDays>
            <WeightLb>double</WeightLb>
            <WeightOz>double</WeightOz>
            <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
            <RequiresAllOf xsi:nil="true" />
            <Length>double</Length>
            <Width>double</Width>
            <Height>double</Height>
            <ShipDate>date</ShipDate>
            <InsuredValue>decimal</InsuredValue>
            <RegisteredValue>decimal</RegisteredValue>
            <CODValue>decimal</CODValue>
            <DeclaredValue>decimal</DeclaredValue>
            <NonMachinable>boolean</NonMachinable>
            <RectangularShaped>boolean</RectangularShaped>
            <Prohibitions>string</Prohibitions>
            <Restrictions>string</Restrictions>
            <Observations>string</Observations>
            <Regulations>string</Regulations>
            <GEMNotes>string</GEMNotes>
            <MaxDimensions>string</MaxDimensions>
            <DimWeighting>string</DimWeighting>
            <AddOns xsi:nil="true" />
            <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
            <IsIntraBMC>boolean</IsIntraBMC>
            <Zone>int</Zone>
            <RateCategory>int</RateCategory>
            <ToState>string</ToState>
            <CubicPricing>boolean</CubicPricing>
          </Rate>
        </NetStampV4>
      </NetStamps>
      <From>
        <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>
      </From>
      <SampleOnly>boolean</SampleOnly>
      <ImageType>Auto or Png or Gif or Pdf or Epl or Jpg or PrintOncePdf or EncryptedPngUrl or Zpl</ImageType>
      <cost_code_id>int</cost_code_id>
      <ImageId>int</ImageId>
      <ReturnIndiciaData>boolean</ReturnIndiciaData>
    </CreateNetStampsIndicia>
  </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>
    <CreateNetStampsIndiciaResponse xmlns="http://stamps.com/xml/namespace/2012/04/swsim/swsimv22">
      <Authenticator>string</Authenticator>
      <IntegratorTxId>string</IntegratorTxId>
      <StampsTxId>guid</StampsTxId>
      <URL>string</URL>
      <PostageBalance>
        <AvailablePostage>decimal</AvailablePostage>
        <ControlTotal>decimal</ControlTotal>
      </PostageBalance>
      <NetstampsStatus>Success or PartialSuccess or Failed</NetstampsStatus>
      <NetstampsIssued>int</NetstampsIssued>
      <ErrorReason>string</ErrorReason>
      <Mac>string</Mac>
      <IndiciaData>
        <IndiciumData>
          <IBI>base64Binary</IBI>
          <IBILite>base64Binary</IBILite>
        </IndiciumData>
        <IndiciumData>
          <IBI>base64Binary</IBI>
          <IBILite>base64Binary</IBILite>
        </IndiciumData>
      </IndiciaData>
    </CreateNetStampsIndiciaResponse>
  </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/swsimv22.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>
    <CreateNetStampsIndicia xmlns="http://stamps.com/xml/namespace/2012/04/swsim/swsimv22">
      <IntegratorTxId>string</IntegratorTxId>
      <Layout>string</Layout>
      <NetStamps>
        <NetStampV4>
          <Row>int</Row>
          <Column>int</Column>
          <Rate>
            <FromZIPCode>string</FromZIPCode>
            <ToZIPCode>string</ToZIPCode>
            <ToCountry>string</ToCountry>
            <Amount>decimal</Amount>
            <MaxAmount>decimal</MaxAmount>
            <ServiceType>Unknown or US-FC or US-PM or US-XM or US-PP or US-MM or US-BP or US-EMI or US-PMI or US-FCI</ServiceType>
            <PrintLayout>string</PrintLayout>
            <DeliverDays>string</DeliverDays>
            <WeightLb>double</WeightLb>
            <WeightOz>double</WeightOz>
            <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
            <RequiresAllOf xsi:nil="true" />
            <Length>double</Length>
            <Width>double</Width>
            <Height>double</Height>
            <ShipDate>date</ShipDate>
            <InsuredValue>decimal</InsuredValue>
            <RegisteredValue>decimal</RegisteredValue>
            <CODValue>decimal</CODValue>
            <DeclaredValue>decimal</DeclaredValue>
            <NonMachinable>boolean</NonMachinable>
            <RectangularShaped>boolean</RectangularShaped>
            <Prohibitions>string</Prohibitions>
            <Restrictions>string</Restrictions>
            <Observations>string</Observations>
            <Regulations>string</Regulations>
            <GEMNotes>string</GEMNotes>
            <MaxDimensions>string</MaxDimensions>
            <DimWeighting>string</DimWeighting>
            <AddOns xsi:nil="true" />
            <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
            <IsIntraBMC>boolean</IsIntraBMC>
            <Zone>int</Zone>
            <RateCategory>int</RateCategory>
            <ToState>string</ToState>
            <CubicPricing>boolean</CubicPricing>
          </Rate>
        </NetStampV4>
        <NetStampV4>
          <Row>int</Row>
          <Column>int</Column>
          <Rate>
            <FromZIPCode>string</FromZIPCode>
            <ToZIPCode>string</ToZIPCode>
            <ToCountry>string</ToCountry>
            <Amount>decimal</Amount>
            <MaxAmount>decimal</MaxAmount>
            <ServiceType>Unknown or US-FC or US-PM or US-XM or US-PP or US-MM or US-BP or US-EMI or US-PMI or US-FCI</ServiceType>
            <PrintLayout>string</PrintLayout>
            <DeliverDays>string</DeliverDays>
            <WeightLb>double</WeightLb>
            <WeightOz>double</WeightOz>
            <PackageType>Unknown or Postcard or Letter or Large Envelope or Flat or Thick Envelope or Package or Flat Rate Box or Small Flat Rate Box or Large Flat Rate Box or Flat Rate Envelope or Flat Rate Padded Envelope or Large Package or Oversized Package or Regional Rate Box A or Regional Rate Box B or Legal Flat Rate Envelope or Regional Rate Box C</PackageType>
            <RequiresAllOf xsi:nil="true" />
            <Length>double</Length>
            <Width>double</Width>
            <Height>double</Height>
            <ShipDate>date</ShipDate>
            <InsuredValue>decimal</InsuredValue>
            <RegisteredValue>decimal</RegisteredValue>
            <CODValue>decimal</CODValue>
            <DeclaredValue>decimal</DeclaredValue>
            <NonMachinable>boolean</NonMachinable>
            <RectangularShaped>boolean</RectangularShaped>
            <Prohibitions>string</Prohibitions>
            <Restrictions>string</Restrictions>
            <Observations>string</Observations>
            <Regulations>string</Regulations>
            <GEMNotes>string</GEMNotes>
            <MaxDimensions>string</MaxDimensions>
            <DimWeighting>string</DimWeighting>
            <AddOns xsi:nil="true" />
            <EffectiveWeightInOunces>int</EffectiveWeightInOunces>
            <IsIntraBMC>boolean</IsIntraBMC>
            <Zone>int</Zone>
            <RateCategory>int</RateCategory>
            <ToState>string</ToState>
            <CubicPricing>boolean</CubicPricing>
          </Rate>
        </NetStampV4>
      </NetStamps>
      <From>
        <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>
      </From>
      <SampleOnly>boolean</SampleOnly>
      <ImageType>Auto or Png or Gif or Pdf or Epl or Jpg or PrintOncePdf or EncryptedPngUrl or Zpl</ImageType>
      <cost_code_id>int</cost_code_id>
      <ImageId>int</ImageId>
      <ReturnIndiciaData>boolean</ReturnIndiciaData>
    </CreateNetStampsIndicia>
  </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>
    <CreateNetStampsIndiciaResponse xmlns="http://stamps.com/xml/namespace/2012/04/swsim/swsimv22">
      <Authenticator>string</Authenticator>
      <IntegratorTxId>string</IntegratorTxId>
      <StampsTxId>guid</StampsTxId>
      <URL>string</URL>
      <PostageBalance>
        <AvailablePostage>decimal</AvailablePostage>
        <ControlTotal>decimal</ControlTotal>
      </PostageBalance>
      <NetstampsStatus>Success or PartialSuccess or Failed</NetstampsStatus>
      <NetstampsIssued>int</NetstampsIssued>
      <ErrorReason>string</ErrorReason>
      <Mac>string</Mac>
      <IndiciaData>
        <IndiciumData>
          <IBI>base64Binary</IBI>
          <IBILite>base64Binary</IBILite>
        </IndiciumData>
        <IndiciumData>
          <IBI>base64Binary</IBI>
          <IBILite>base64Binary</IBILite>
        </IndiciumData>
      </IndiciaData>
    </CreateNetStampsIndiciaResponse>
  </soap12:Body>
</soap12:Envelope>