Navbar

Stamps API Reference Guide

To make your first call, Click Here to sign up for a Developer Account.

API Endpoints:
 Staging:
https://swsim.testing.stamps.com/swsim/swsimv71.asmx
 Production:
https://swsim.stamps.com/swsim/swsimv71.asmx

Contact us M-F, 6AM to 6PM. For high-volume accounts, we offer 24/7 support.
  Email: developer@stamps.com
  Phone: 1‑877-782-6739

Stamps Web Services API is an industry leading SOAP based API. If you require a RESTful multi-carrier shipping API, check out ShipEngine.

The Stamps.com Web Services (SWS) API provides web services for creating an integrated solution for shipping via the United States Postal Service (USPS). The integrator will be able to create shipping labels, calculate the shipping cost of packages, standardize domestic addresses, and track shipments. The integrator controls the end-user experience and Stamps.com servers handle all the label generation, USPS compliance, and rate calculations.

Integrators must register for a developer account. The users of the integrator's product must also be Stamps.com customers in order to use the integration. Please contact Stamps.com if this model is not appropriate for the intended integration. Stamps.com offers alternative web services for other models, such as those where the end-user is not a Stamps.com customer, but rather prints postage that is re-sold through the integrator's application.

This table illustrates the steps to integrate the SWS API into an application.

Getting Started with SWSIM
STEP 1:  Purchase Postage PurchasePostage
GetPurchaseStatus
STEP 2: Standardize Shipping Rate CleanseAddress
GetRates
STEP 3: Generate the Shipping Label CreateIndicium
CancelIndicium

Changes in SWSIM 71

Description of Change Objects Referencing Calls Impacted
Removed CreateScanForm Method CreateScanForm CreateScanForm
CreateScanFormResponse
Added CreateManifest Method CreateManifest CreateManifest
CreateManifestResponse

General Conventions

Example: The GetRates method has a <GetRates> XML object that is sent as part of the GetRates request and a <GetRatesResponse> object that is returned.

All of the XML objects used by the SWS API are defined within an XML namespace (http://www.w3.org/TR/REC-xml-names/). The specific namespace is "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71".

The SWS API supports UTF-8 encoding of the XML.

Authentication

All web methods require authentication information to be supplied in order to identify the user and ensure that the user is authorized to perform the operation. It is through the authentication information that SWS identifies the particular account and USPS meter that the operation is being performed against. Authentication information can come in one of two forms:

It is recommended that an integration start a session with the AuthenticateUser web method and use the returned Authenticator string in all subsequent requests in the session, updating it after each web method call. In this way, the user's password need only be transmitted to the SWS server once and the SWS server will ensure that no messages are lost without notice due to network problems.

Print Labels

PurchasePostage

The PurchasePostage web method is used to purchase additional postage. The purchase will occur using the user's current payment method for purchasing postage. This can be changed using the account settings web page hosted by Stamps.com. See the GetURL web method for more information.

Due to the details of payment processing, postage purchase is inherently an asynchronous process. Typically, the PurchasePostage web method will return a status of Pending or Processing, indicating that the payment for the postage purchase has not yet been processed. The integration must then call GetPurchaseStatus in order to determine the status of the purchase. The integrator should use an exponential back-off wait algorithm as to not inundate the server with calls to GetPurchaseStatus. The integration should wait 8 seconds before making the first call, then 16 seconds before trying again, and then 32 seconds between all subsequent retries. Typically, the purchase will succeed before the second retry.

PurchasePostage web method has a fault-tolerance mechanism that can be utilized by passing IntegratorTxID. The method can be called multiple times with the same IntegratorTxID. If the initial call to PurchasePostage fails due to network or other errors (for example, the caller accidentally crashes or the server has some issues that prevent it from sending the result back to the caller), the call may be repeated to PurchasePostage with the same IntegratorTxID. By checking the IntegratorTxID, the service knows whether this is a initial PurchasePostage call or a replay. If it is a replay, meaning the IntegratorTxID has been used before, the service simply returns the response of the initial PurchasePostage call without further processing. If IntegratorTxID is not passed in, this fault-tolerance mechanism won’t be activiated.

PurchasePostage object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/PurchasePostage"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:PurchasePostage>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:PurchaseAmount>100</tns:PurchaseAmount>
      <tns:ControlTotal>####.##</tns:ControlTotal>
    </tns:PurchasePostage>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
PurchaseAmount xsd:decimal Amount of postage to purchase.
ControlTotal xsd:decimal Control total obtained from previous call to GetAccountInfo or other web method that returns a PostageBalance object. The control total protects the user from purchasing unwanted postage when postage was just printed by another user or via another application.
MI MachineInfo For internal use. Integrators may omit this value.
IntegratorTxID xsd:string If this value is passed in, the fault-tolerance mechanism will be activiated. The service checks if the IntegratorTxID has been used before. If it has been used, the service will treat the call as a replay and simply returns the response of the initial PurchasePostage call without further processing.
SendEmail xsd:boolean For internal use. Integrators may omit this value.

PurchasePostageResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 21:48:44 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <PurchasePostageResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <PurchaseStatus>Pending</PurchaseStatus>
      <TransactionID>1234</TransactionID>
      <PostageBalance>
        <AvailablePostage>####.##</AvailablePostage>
        <ControlTotal>####.##</ControlTotal>
      </PostageBalance>
      <RejectionReason>order being processed</RejectionReason>
    </PurchasePostageResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
PurchaseStatus
PurchaseStatus Success
Pending
Processing
Rejected
Status of purchase.
TransactionID xsd:int Transaction ID for purchase. Used in later call to GetPurchaseStatus web method.
PostageBalance PostageBalance New postage balance, including available postage and control total.
PostageBalance Object
Element Data Type Description
AvailablePostage xsd:decimal Current balance of available postage in the meter.
ControlTotal xsd:decimal Control total to be passed to PurchasePostage web method when purchasing additional postage.
RejectionReason xsd:string If purchase rejected, reason for rejection. Only present when PurchaseStatus is Rejected.
MIRequired xsd:boolean For internal use only. Integrations may ignore this value..
RejectionCode
PurchaseRejectionCode CustomerActionRequired
SystemFailure
RejectedDueToFraud
If purchase is rejected, a code represents the reason. Only present when PurchaseStatus is Rejected.

GetPurchaseStatus

The GetPurchaseStatus web method is used to get the status of a previous postage purchase request made with the PurchasePostage web method.

Due to the details of payment processing, postage purchase is inherently an asynchronous process. Typically, the PurchasePostage web method will return a status of Pending or Processing, indicating that the payment for the postage purchase has not yet been processed. The integration must then call GetPurchaseStatus in order to determine the status of the purchase. The integrator should use an exponential back-off wait algorithm as to not inundate the server with calls to GetPurchaseStatus. The integration should wait 8 seconds before making the first call, then 16 seconds before trying again, and then 32 seconds between all subsequent retries. Typically, the purchase will succeed before the second retry.

GetPurchaseStatus object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/GetPurchaseStatus"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:GetPurchaseStatus>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:TransactionID>1234</tns:TransactionID>
    </tns:GetPurchaseStatus>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
TransactionID xsd:int Transaction identifier returned from previous call to PurchasePostage web method.

GetPurchaseStatusResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 21:55:36 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetPurchaseStatusResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <PurchaseStatus>Success</PurchaseStatus>
      <PostageBalance>
        <AvailablePostage>####.##</AvailablePostage>
        <ControlTotal>####.##</ControlTotal>
      </PostageBalance>
      <RejectionReason/>
    </GetPurchaseStatusResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
PurchaseStatus
PurchaseStatus Success
Pending
Processing
Rejected
Status of purchase.
PostageBalance PostageBalance New postage balance, including available postage and control total.
PostageBalance Object
Element Data Type Description
AvailablePostage xsd:decimal Current balance of available postage in the meter.
ControlTotal xsd:decimal Control total to be passed to PurchasePostage web method when purchasing additional postage.
RejectionReason xsd:string If purchase rejected, reason for rejection. Only present when PurchaseStatus is Rejected.
MIRequired xsd:boolean For internal use only. Integrations may ignore this value.
RejectionCode
PurchaseRejectionCode CustomerActionRequired
SystemFailure
RejectedDueToFraud
If purchase is rejected, a code represents the reason. Only present when PurchaseStatus is Rejected.

CleanseAddress

The CleanseAddress method accepts an address and presents a standardized shipping address that complies with the USPS address formatting guidelines. The integration calling CleanseAddress is required to use the supplied standardized address, unless the city, state, and ZIP Code are a valid combination. International addresses are not standardized, but the country name is validated against the official USPS list of supported countries. We also offer international address cleansing to qualified customers. Please contact us if you’re interested in verifying your international mailing addresses. The CleanseAddress method expects as input a <CleanseAddress> object and returns a <CleanseAddressResponse> object. The <CleanseAddressResponse> object contains a <CleanseHash> and/or an <OverrideHash>, one of which must be passed along when the address is ultimately submitted to CreateIndicium. If <FromZIPCode> is provided, CleanseAddress method returns list of <Rate> objects with the DeliveryDate, DeliverDays and Zone for all possible combinations of ServiceType and PackageType.

How to process the response for a Domestic address:

How to process the response for an International address:

CleanseAddress object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/CleanseAddress"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:CleanseAddress>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:Address>
        <tns:FullName>Geoff Anton</tns:FullName>
        <tns:Company>Stamps.com</tns:Company>
        <tns:Address1>12959 Coral Tree Place</tns:Address1>
        <tns:City>Los Angeles</tns:City>
        <tns:State>CA</tns:State>
        <tns:ZIPCode>90066</tns:ZIPCode>
      </tns:Address>
<tns:FromZIPCode>11042</tns:FromZIPCode>
    </tns:CleanseAddress>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Address Address The address to cleanse. Only one Address object may be passed per CleanseAddress web method call.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.

FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses the ZIP Code to determine the DeliveryDate, DeliverDays, and Zone.

CleanseAddressResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 19:41:24 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CleanseAddressResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <Address>
        <FullName>GEOFF ANTON</FullName>
        <Company>STAMPS.COM</Company>
        <Address1>12959 CORAL TREE PL</Address1>
        <Address2 />
        <City>LOS ANGELES</City>
        <State>CA</State>
        <ZIPCode>90066</ZIPCode>
        <ZIPCodeAddOn>7020</ZIPCodeAddOn>
        <DPB>59</DPB>
        <CheckDigit>6</CheckDigit>
        <Urbanization />
        <CleanseHash>7SWYAzuNh82cWhIQyRFXRNa71HFkZWFkYmVlZg==20100210</CleanseHash>
        <OverrideHash>Tdwp4JlTc02DhscYxbI7l7o08apkZWFkYmVlZg==20100210</OverrideHash>
      </Address>
      <AddressMatch>true</AddressMatch>
      <CityStateZipOK>true</CityStateZipOK>
<Rates>
            <Rate>
               <FromZIPCode>11042</FromZIPCode>
               <ToZIPCode>90066</ToZIPCode>
               <ServiceType>US-FC</ServiceType>
               <DeliverDays>3</DeliverDays>
               <PackageType>Postcard</PackageType>
               <ShipDate>2014-10-30</ShipDate>
               <DeliveryDate>2014-10-31</DeliveryDate>
               <NonMachinable>true</NonMachinable>
               <Zone>8</Zone>
            </Rate>
            <Rate>
               <FromZIPCode>11042</FromZIPCode>
               <ToZIPCode>90066</ToZIPCode>
               <ServiceType>US-FC</ServiceType>
               <DeliverDays>3</DeliverDays>
               <PackageType>Letter</PackageType>
               <ShipDate>2014-10-30</ShipDate>
               <DeliveryDate>2014-10-31</DeliveryDate>
               <Zone>8</Zone>
</Rate> ***list continues***
</Rates>
    </CleanseAddressResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Address Address Cleansed address. Only one
object will be returned.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.

AddressMatch xsd:boolean See CleanseAddress web method description on page 25 for processing information. If true, address has been successfully cleansed, but may have been modified.
CityStateZipOK xsd:boolean See CleanseAddress web method description on page 25 for processing information. If true, city, state, and zip have been validated and address may be used even if not successfully cleansed. Only for domestic addresses.
ResidentialDeliveryIndicator
ResidentialDeliveryIndicator Yes
No
Unknown
Unsupported

Supported from swsimv16 onward. Indiciates if the address is a business or residential or of unknown type.
IsPOBox xsd:boolean If AddressMatch=true, then IsPOBox can be either true or false. If AddressMatch=false, then IsPOBox will be null. If IsPOBox=true, the system has identified the matched address as a Post Office Box, otherwise IsPOBox=false
CandidateAddresses Array of Address objects If CleanseAddress does not find an exact match for the given address and one or more matches for the address have been found, the response will contain a list of candidate addresses, up to a maximum of 10. If there are CandidateAddresses, it is recommended that the requestor check the submitted address and add any missing information like Apartment or Suite numbers. Or the requestor can select one of the candidate addresses from the list and retry CleanseAddress making sure to resolve any suite or apartment ranges (by user input) before the retry. Each CandidateAddress contains an Address line, City, State, ZIPCode, ZIPCodeAddOn, and an OverrideHash.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
StatusCodes StatusCodes StatusCodes return additional information regarding the results of cleansing.
StatusCodes Object
Element Data Type Description
DpvFootnotes Array of DpvFootnote objects Array of DPV Footnotes returned by the USPS Address Matching System API. DPV is a USPS product that will help mailers validate the accuracy of their address information, right down to the physical delivery point. Mailers will be able to identify individual addresses within a mailing list that are potentially undeliverable-as-addressed due to an addressing deficiency. For detailed information of DPV footnotes, please refer to the USPS Address Matching System API document, DPV Appendix: https://ribbs.usps.gov/amsapi/documents/tech_guides/AMSAPIUG.PDF
Footnotes Array of Footnote objects Array of Footnotes returned by the USPS Address Matching System API. Footnotes provide additional information returned from the USPS Address Matching System. They identify whether or not any changes were made to the address, including what were the specific changes. For detailed information of footnotes, please refer to the USPS Address Matching System API document, section of Footnote Flags:
ReturnCode xsd:int Return Code from the USPS Address Matching System API. Return Code contains a response code summarizing the inquiry results. For detailed information of the Return Code, please refer to the USPS Address Matching System API document, section of Address Inquiry: https://ribbs.usps.gov/amsapi/documents/tech_guides/AMSAPIUG.PDF
SdcFootnotes Array of xsd:int Reserved for future use.
Rates Array of Rate objects Collection of Rate objects, each one for a possible service type. One or more Rate objects will be returned as part of the response.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.
EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
AddressCleansingResult xsd:string Address Cleansing result – in detail to the extent of cleansing possible.

GetRates

The GetRates method produces a list of rates for all available USPS services based on the ZIP Code or the foreign country being shipped to for a given package weight and size.

See the ServiceType list for a list of all possible rates / services returned. - Add-on Services: All available add-on services are included as part of each rate as a sub-item to the rate (e.g., Signature Confirmation is an optional add-on returned with a USPS Priority Mail rate. - ServiceType and PackageType could be Unknown. If any of them is Unknown the method returns all possible rates with the known parameters. If there is no rate available, the method returns normally but without rates. Note that in this case, there is no exception thrown. - If both ServiceType and PackageType are known but the method cannot found a valid rate, it throws an exception.

GetRates object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/GetRates"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:GetRates>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:Rate>
        <tns:FromZIPCode>90405</tns:FromZIPCode>
        <tns:ToZIPCode>90066</tns:ToZIPCode>
        <tns:WeightLb>12</tns:WeightLb>
        <tns:PackageType>Package</tns:PackageType>
        <tns:ShipDate>2018-01-12</tns:ShipDate>
        <tns:InsuredValue>100.00</tns:InsuredValue>
      </tns:Rate>
    </tns:GetRates>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Rate Rate Rate object, potentially incomplete, that identifies the basic characteristics of the package, such as destination ZIP code and weight.Only one Rate object may be passed per GetRates web method call.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.

GetRatesResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 19:50:19 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetRatesResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
         <Authenticator>***authenticator***</Authenticator>
         <Rates>
            <Rate>
               <FromZIPCode>90405</FromZIPCode>
               <ToZIPCode>90066</ToZIPCode>
               <Amount>10.84</Amount>
               <ServiceType>US-PM</ServiceType>
               <ServiceDescription>USPS Priority Mail</ServiceDescription>
               <DeliverDays>1</DeliverDays>
               <WeightLb>12</WeightLb>
               <PackageType>Package</PackageType>
               <ShipDate>2018-01-12</ShipDate>
               <DeliveryDate>2018-01-13</DeliveryDate>
               <InsuredValue>100</InsuredValue>
               <DimWeighting>N</DimWeighting>
               <AddOns>
                  <AddOnV11>
                     <Amount>2.65</Amount>
                     <AddOnType>US-A-INS</AddOnType>
                     <AddOnDescription>USPS Insurance</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                        <AddOnTypeV11>SC-A-INS</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-COD</AddOnType>
                     <AddOnDescription>Collect on Delivery</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-HFPU</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                     <MissingData>CODValue</MissingData>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-DC</AddOnType>
                     <AddOnDescription>Tracking</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-ASR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-ASRD</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>2.45</Amount>
                     <AddOnType>US-A-SC</AddOnType>
                     <AddOnDescription>Signature Confirmation</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-DC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-ASR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-ASRD</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>3.35</Amount>
                     <AddOnType>US-A-CM</AddOnType>
                     <AddOnDescription>Certified Mail</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                        <AddOnTypeV11>US-A-DC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SH</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>2.75</Amount>
                     <AddOnType>US-A-RR</AddOnType>
                     <AddOnDescription>Return Receipt</AddOnDescription>
                     <RequiresAllOf>
                        <RequiresOneOf>
                           <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                           <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                           <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                           <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                           <AddOnTypeV11>US-A-ASR</AddOnTypeV11>
                           <AddOnTypeV11>US-A-ASRD</AddOnTypeV11>
                           <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                        </RequiresOneOf>
                     </RequiresAllOf>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>11.7</Amount>
                     <AddOnType>US-A-REG</AddOnType>
                     <AddOnDescription>Registered Mail</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>SC-A-INS</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SH</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>4.95</Amount>
                     <AddOnType>US-A-RD</AddOnType>
                     <AddOnDescription>Restricted Delivery</AddOnDescription>
                     <RequiresAllOf>
                        <RequiresOneOf>
                           <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                           <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                           <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                           <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                           <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                        </RequiresOneOf>
                     </RequiresAllOf>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SH</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>2.38</Amount>
                     <AddOnType>SC-A-INS</AddOnType>
                     <AddOnDescription>Insurance</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                        <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>SC-A-HP</AddOnType>
                     <AddOnDescription>Hidden Postage</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-LAWS</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-NND</AddOnType>
                     <AddOnDescription>Notice of Non-Delivery</AddOnDescription>
                     <RequiresAllOf>
                        <RequiresOneOf>
                           <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                        </RequiresOneOf>
                     </RequiresAllOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>4.2</Amount>
                     <AddOnType>US-A-RRM</AddOnType>
                     <AddOnDescription>Return Receipt for Merchandise</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RR</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>1.45</Amount>
                     <AddOnType>US-A-RRE</AddOnType>
                     <AddOnDescription>Electronic Return Receipt</AddOnDescription>
                     <RequiresAllOf>
                        <RequiresOneOf>
                           <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                           <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                           <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                           <AddOnTypeV11>US-A-INS</AddOnTypeV11>
                        </RequiresOneOf>
                     </RequiresAllOf>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-DC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-COM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SH</AddOnTypeV11>
                        <AddOnTypeV11>SC-A-INSRM</AddOnTypeV11>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                        <AddOnTypeV11>US-A-NND</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>5.9</Amount>
                     <AddOnType>US-A-ASR</AddOnType>
                     <AddOnDescription>Adult Signature Required</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-ASRD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-DC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>6.15</Amount>
                     <AddOnType>US-A-ASRD</AddOnType>
                     <AddOnDescription>Adult Signature Restricted Delivery</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-ASR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-DC</AddOnTypeV11>
                        <AddOnTypeV11>US-A-SC</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-HM</AddOnType>
                     <AddOnDescription>Hazardous Materials</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-CR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-LANS</AddOnTypeV11>
                        <AddOnTypeV11>US-A-LAWS</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-LANS</AddOnType>
                     <AddOnDescription>Live Animal</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-CR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-HM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-LAWS</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>2.4</Amount>
                     <AddOnType>US-A-LAWS</AddOnType>
                     <AddOnDescription>Live Animal with Fee</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-CR</AddOnTypeV11>
                        <AddOnTypeV11>US-A-HM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-LANS</AddOnTypeV11>
                        <AddOnTypeV11>SC-A-HP</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <Amount>10.25</Amount>
                     <AddOnType>US-A-SH</AddOnType>
                     <AddOnDescription>Fragile</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-COM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-CM</AddOnTypeV11>
                        <AddOnTypeV11>US-A-REG</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RD</AddOnTypeV11>
                        <AddOnTypeV11>US-A-RRE</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-PR</AddOnType>
                     <AddOnDescription>Perishable</AddOnDescription>
                  </AddOnV11>
                  <AddOnV11>
                     <AddOnType>US-A-HFPU</AddOnType>
                     <AddOnDescription>Hold For Pickup</AddOnDescription>
                     <ProhibitedWithAnyOf>
                        <AddOnTypeV11>US-A-COD</AddOnTypeV11>
                     </ProhibitedWithAnyOf>
                  </AddOnV11>
               </AddOns>
               <EffectiveWeightInOunces>192</EffectiveWeightInOunces>
               <Zone>1</Zone>
               <RateCategory>1000</RateCategory>
               <ToState>CA</ToState>
            </Rate>
             ...
         </Rates>
      </GetRatesResponse>
   </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Rates Array of Rate Collection of Rate objects, each one for a possible service type. One or more Rate objects will be returned as part of the response.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.

CreateIndicium

The CreateIndicium method generates the postage indicium based on the shipping information provided in the request. The SWS API will return a URL that references either an image of the domestic shipping label or a multi-page PDF document for international, APO/FPO or US Territories labels with customs forms.

Special Considerations:

CreateIndicium object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/CreateIndicium"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:CreateIndicium>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:IntegratorTxID>1234567890ABCDEF</tns:IntegratorTxID>
      <tns:TrackingNumber/>
      <tns:Rate>
        <tns:FromZIPCode>90405</tns:FromZIPCode>
        <tns:ToZIPCode>90066</tns:ToZIPCode>
        <tns:Amount>10</tns:Amount>
        <tns:ServiceType>US-PM</tns:ServiceType>
        <tns:DeliverDays>1-1</tns:DeliverDays>
        <tns:WeightLb>12</tns:WeightLb>
        <tns:WeightOz>0</tns:WeightOz>
        <tns:PackageType>Package</tns:PackageType>
        <tns:ShipDate>2009-08-31</tns:ShipDate>
        <tns:InsuredValue>100.00</tns:InsuredValue>
        <tns:RectangularShaped>false</tns:RectangularShaped>
        <tns:AddOns>
          <tns:AddOn>
            <tns:Amount>0</tns:Amount>
            <tns:AddOnType>US-A-DC</tns:AddOnType>
          </tns:AddOn>
          <tns:AddOn>
            <tns:Amount>1.3</tns:Amount>
            <tns:AddOnType>SC-A-INS</tns:AddOnType>
          </tns:AddOn>
        </tns:AddOns>
      </tns:Rate>
      <tns:From>
        <tns:FullName>Some Body</tns:FullName>
        <tns:Address1>3420 Ocean Park Bl</tns:Address1>
        <tns:Address2>Ste 1000</tns:Address2>
        <tns:City>Santa Monica</tns:City>
        <tns:State>CA</tns:State>
        <tns:ZIPCode>90405</tns:ZIPCode>
      </tns:From>
      <tns:To>
        <tns:FullName>GEOFF ANTON</tns:FullName>
        <tns:NamePrefix/>
        <tns:FirstName/>
        <tns:MiddleName/>
        <tns:LastName/>
        <tns:NameSuffix/>
        <tns:Title/>
        <tns:Department/>
        <tns:Company>STAMPS.COM</tns:Company>
        <tns:Address1>12959 CORAL TREE PL</tns:Address1>
        <tns:Address2/>
        <tns:City>LOS ANGELES</tns:City>
        <tns:State>CA</tns:State>
        <tns:ZIPCode>90066</tns:ZIPCode>
        <tns:ZIPCodeAddOn>7020</tns:ZIPCodeAddOn>
        <tns:DPB>59</tns:DPB>
        <tns:CheckDigit>6</tns:CheckDigit>
        <tns:Province/>
        <tns:PostalCode/>
        <tns:Country/>
        <tns:Urbanization/>
        <tns:PhoneNumber/>
        <tns:Extension/>
        <tns:CleanseHash>7SWYAzuNh82cWhIQyRFXRNa71HFkZWFkYmVlZg==20070513</tns:CleanseHash>
      </tns:To>
      </tns:CreateIndicium>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
IntegratorTxID xsd:string
maxLength=128
The IntegratorTxID (Transaction ID) is a unique number from the integrator's system and used to retry a failed CreateIndicium attempt or locate and reconcile any billable transaction ordered from Stamps.com. Stamps.com issues a StampsTxID response which is the Stamps.com counterpart to this number and a unique ID in the Stamps.com system for a transaction.
TrackingNumber xsd:string
maxLength=128
A TrackingNumber is allowed if the integrator has the ability to generate them via a USPS Pub 199 server. This is currently unsupported.
Rate Rate A Rate object previously returned from the GetRates web method. Remove Rate elements not desired for the indicium.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
RateToken xsd:string This feature is for internal use only.
From Address Return address.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
To Address Delivery address. The delivery address provided can optionally not be cleansed. In this case CreateIndicium validates that the City, State and Zip matched the corresponding values in the USPS Address Matching system. If not an InvalidDestinationAddress exception is thrown.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
CustomerID xsd:string
maxLength=64
A customer identifier required for USPS audits, aviation security, and Stamps.com Insurance purchases. Only used if printed postage is being issued to someone other than the Stamps.com user. If a particular customer abuses the system, they may be denied access to the system in the future.
Customs Customs Customs information. Required for International.Default is false.
Customs Object

Element Data Type Description
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
Comments xsd:string
maxLength=76
Comments.
LicenseNumber xsd:string
maxLength=6
License number.
CertificateNumber xsd:string
maxLength=8
Certificate number.
InvoiceNumber xsd:string
maxLength=15
Invoice number.
OtherDescribe xsd:string
maxLength=20
Other description - required when ContentType is Other.
CustomsLines Array of CustomsLine Collection of customslineobjects. Contains 1..n customsline objects. Customs form allows up to 999 lines.
CustomsLine Object
Element Data Type Description
Description xsd:string
maxLength=60
Description.
Quantity xsd:double Quantity.
Value xsd:decimal Value in dollars. Negative values are disallowed. Zero is disallowed for APO/FPO destinations. See Appendix D for more information on this element.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

HSTariffNumber xsd:string
maxLength=6
For commercial items only. If known, the HS tariff number (6-digit) must be based on the Harmonized Commodity Description and Coding System developed by the World Customs Organization.
CountryOfOrigin xsd:string
maxLength=2
For commercial items only. Country of Origin means the country where the goods originated, e.g. were produced, manufactured, or assembled. It is recommended that a shipper supply this information and attach an invoice to the outside of the package to accelerate customs clearance in processing the items. The country name entered must match an entry from the USPS-approved International Index of Countries and Localities or be "US".
CustomsSigner xsd:string
minLength=2
minLength=100
Value that’s populated into the Sender’s Signature field of the customs form. If element is not included, the FullName element value in the From object is used. If the FullName element value is not included, the First and Last element values in the From object are used. If First and Last element values are not included, the Company element value in the From object is used.
SampleOnly xsd:boolean Default is false. If true, generates a sample label without real value. This option is to be used during the testing phase of an integration. It will fully exercise the SWS system, but will not deduct any postage from the meter.
ImageType
ImageType Auto
AZpl
BZpl
EncryptedPngUrl
Epl
Gif
Jpg
Pdf
PrintOncePdf
Png
Zpl
Bmp
BmpMonochrome
PngMonochrome
JpgMonochrome
GifMonochrome
Image type of shipping label. Default is Auto: which generates a Png image.
EltronPrinterDPIType
EltronPrinterDPIType Default
High
Resolution of shipping label for thermal printer.
memo xsd:string
maxLength=150
The memo to print at the bottom of the shipping label. The memo parameter may consist of more than one line separated by the standard carriage return/line feed, use as carriage return and as line feed in the request xml, i.e., tns:memomemo 1 memo 2/tns:memo or tns:memomemo1 memo2/tns:memo If the memo value is prefixed with a tab, or unescaped tab, then the parts of the multi line memo will print side-by-side. Although the API will not return an error when many carriage return and line feed are present in the memo only 1 pair of CR LF is supported due to limited space in a shipping label. For a single line memo, it will print in a single box at the bottom of the label. For a multi-line memo, the first two lines will be put into the two separate boxes of the label If printMemo is set to false
cost_code_id xsd:int Cost code ID. See EnumCostCodes web method for more information.

CreateIndiciumResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 18:58:01 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CreateIndiciumResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <IntegratorTxID>1234567890ABCDEF</IntegratorTxID>
      <TrackingNumber>9101010521290895036903</TrackingNumber>
      <Rate>
        <FromZIPCode>90405</FromZIPCode>
        <ToZIPCode>90066</ToZIPCode>
        <Amount>10.36</Amount>
        <ServiceType>US-PM</ServiceType>
        <DeliverDays>1-3</DeliverDays>
        <WeightLb>12</WeightLb>
        <PackageType>Package</PackageType>
        <ShipDate>2009-08-31</ShipDate>
        <InsuredValue>100.00</InsuredValue>
        <RectangularShaped>false</RectangularShaped>
        <DimWeighting>N</DimWeighting>
        <AddOns>
          <AddOn>
            <AddOnType>US-A-DC</AddOnType>
          </AddOn>
          <AddOn>
            <Amount>1.85</Amount>
            <AddOnType>SC-A-INS</AddOnType>
          </AddOn>
        </AddOns>
      </Rate>
      <StampsTxID>d71c4ade-df96-4b25-b86a-ccda81e63c63</StampsTxID>
      <URL>https://swsim.testing.stamps.com/label/label.ashx/label-200.png?AQAAAGB-i0NN-csIcShCpDSg-K61rleiukS92KSBUEJ4nONMtWIQuOclc33afVXvHVlnbjU-s0kWOCZRMZfnrITj_tWa065sNbzIZ2BmFGxgYGhuYGBmaGzJ5pdflJuYwwTUyxmcn5uq4JSfUvn__38hYxMjAwX_5NTEPIWAxKJsBaccjuCSVAVDAwOD_zzBiXkliQq--XmZyYlMzo6slgYmBqb__zMDTeF2d_V3c1Nw9Avx92Ng4AoOcfQNCNZz9vcVNjSyNLVUcPYPcvRRCAlydVUI8GH4z8Dt4x8MVO3u6uMaDDHKwMyMxdzAyIDJ1JLRjDc0L7MkNUUhuCSxJLWY4f8BhgMMEOsYeVgYkAATA0MkKyOIBfKgdR0zowqTFgNDhQbD-X4jxkvxjAzPdSNNGVjAKpfMZ2IwEOAxUDo6U3WGWDBf2quDF6e8DYwo-bXzddQmfX-3T_Km-2f3xPlu28eq7Gb7kIG1uLw4M1fM0tAABE2NgH4xsLA0NTA2szQwZjggKvf0-2kOhhklp-R_nO5gFFBHddlOBlQ-238GWgFGRkbD0yAaACGfd30=</URL>
      <PostageBalance>
        <AvailablePostage>####.##</AvailablePostage>
        <ControlTotal>####.##</ControlTotal>
      </PostageBalance>
    </CreateIndiciumResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
IntegratorTxID xsd:string
maxLength=128
Integrator-supplied transaction identifier.
TrackingNumber xsd:string
maxLength=128
A confirm number. If First Class the number is an IMB format confirm number. If Priority or Priority Mail Express an IMB encoded POSTNET equivalent number is returned. Neither of these are trackable. The IMB confirm number can be used for performing an e-refund via CancelIndicium.
ReturnTrackingNumber xsd:string Return tracking number for Certified Mail Envelope (SDC-3830) and Certified Mail Envelope (SDC-3930).
Rate Rate The Rate object from the request modified to include actual cost details.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
StampsTxID xsd:string
maxLength=128
Stamps.com transaction identifier.
URL xsd:string A web addresses to the envelope image.
PostageBalance PostageBalance New postage balance, including available postage and control total.
PostageBalance Object
Element Data Type Description
AvailablePostage xsd:decimal Current balance of available postage in the meter.
ControlTotal xsd:decimal Control total to be passed to PurchasePostage web method when purchasing additional postage.
Mac xsd:string For internal use only. Integrations may ignore this value.
PostageHash xsd:string For internal use only. Integrations may ignore this value.
ImageData Array of xsd:base64Binary Image data for the requested indicium or indicia. This value is only available when ReturnImageData is set to true. If the request returns multiple images, each byte array represents an image.
HoldForPickupFacility HoldForPickupFacility Object Specifies the HFPU facility details.
HoldForPickupFacility Object

Element Data Type Description
Id xsd:string Facility Identfier.
Name xsd:string Name of facility.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
Has10AMCommitment xsd:boolean Indicates if packages can be available for pickup at 10:00 am local time.
FormURL xsd:string For internal use only. Integrations may ignore this value.

Manage Labels

CancelIndicium

The CancelIndicium method cancels a previously issued indicium and submits a request for a refund of postage. Upon making a CancelIndicium call, the postage that was printed is invalidated, and in the background, a request for a refund is batched up to be sent later that day to the USPS. The refund requests are then analyzed and processed by the USPS who then reports the results back to Stamps.com. Stamps.com will then credit the user's meter.

CancelIndicium object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/CancelIndicium"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:CancelIndicium>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:StampsTxID> c605aec1-322e-48d5-bf81-b0bb820f9c22</tns:StampsTxID>
    </tns:CancelIndicium>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
StampsTxID xsd:string
maxLength=128
The Stamps.com transaction identifier returned from CreateIndicium. Canceling indicia by StampsTxID instead of by TrackingNumber is highly recommended.
TrackingNumber xsd:string The tracking number returned from CreateIndicium or CreateEnvelopeIndicium. Canceling indicia by StampsTxID instead of by TrackingNumber is highly recommended.
SendEmail xsd:boolean For internal use only. Integrations may ignore this value.

CancelIndiciumResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 19:14:29 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CancelIndiciumResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
    </CancelIndiciumResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.

CreateManifest

The CreateManifest method generates an end of day manifest for previously created indicium (e.g. SCAN form). The SWS API will return a URL or a series of URLs separated by spaces for the manifest. A SCAN form specifically can accept maximum 1,000 labels.

CreateManifest object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/CreateScanForm"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
<tns:CreateManifest>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:StampsTxIDs>
        <tns:guid>A5ED206D-D840-4A40-B314-93021391D9D0</tns:guid>
        <tns:guid>EE1DBEE9-809D-422A-9502-EE9756163619</tns:guid>
      </tns:StampsTxIDs>
      <tns:FromAddress>
        <tns:FullName>Some Body</tns:FullName>
        <tns:Address1>3420 Ocean Park Bl</tns:Address1>
        <tns:City>Santa Monica</tns:City>
        <tns:State>CA</tns:State>
        <tns:ZIPCode>90405</tns:ZIPCode>
      </tns:FromAddress>
      <tns:ImageType>Pdf</tns:ImageType>
      <tns:PrintInstructions>true</tns:PrintInstructions>
      <tns:ManifestType>ScanForm</tns:ManifestType>
    </tns:CreateManifest>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
IntegratorTxID xsd:string
maxLength=128
The IntegratorTxID (Transaction ID) is a unique number from the integrator's system and used to retry a failed CreateIndicium attempt or locate and reconcile any billable transaction ordered from Stamps.com. Stamps.com issues a StampsTxID response which is the Stamps.com counterpart to this number and a unique ID in the Stamps.com system for a transaction.
StampsTxIDs Array of xsd:string Collection of StampsTxID from previous CreateIndicium calls. Can be null if ShipDate is provided.
TrackingNumbers Array of xsd:string Collection of Tracking Numbers from previous CreateIndicium calls. Can be used as an alternative to StampsTxIDs.
ShipDate xsd:date Effective when StampsTxIDs is null. When ShipDate is non-null, all available prints that have not been cancelled from the specified ShipDate are included on SCAN form. Can be null when a non-null StampsTxIDs is passed in.
FromAddress FromAddress The sender’s address.
FromAddress Object
Element Data Type Description
name_ xsd:string Sender's name.
title_ xsd:string A prefix to go before the sender's first name
dept_ xsd:string The department of the company for sender’s address (e.g. Finance).
company_ xsd:string The company of sender’s address (e.g. Stamps.com).
address_1_ address_2_ xsd:string Up to two lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only address_1_ is required.
city_ xsd:string The name of the city for sender's address.
state_ xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for sender's address.

zip_code_ xsd:string The five-digit ZIP Code for sender's address. Only used for domestic addresses.
zip_code_add_on_ xsd:string The "plus 4" portion of the ZIP Code for sender's address. max length 4
phone_number xsd:string The phone number associated with sender's address.

ImageType
ImageType Auto
AZpl
BZpl
EncryptedPngUrl
Epl
Gif
Jpg
Pdf
PrintOncePdf
Png
Zpl
Bmp
BmpMonochrome
PngMonochrome
JpgMonochrome
GifMonochrome

Image type of SCAN form.
PrintInstructions xsd:boolean Indicates if the instruction page is generated.
ManifestType

ManifestType ScanForm
GlobalAdvantage
All

Specifies the manifest that will be generated.
NumberOfLabels xsd:int For internal use only.

CreateManifestResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 18:58:01 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CreateManifestResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <EndOfDayManifests>
        <EndOfDayManifest>
          <PickupCarrier>Usps</PickupCarrier>
          <ManifestType>ScanForm</ManifestType>
          <ManifestId>9150010521297892522640</ManifestId>
          <ManifestUrl> https://swsim.testing.stamps.com/Label/scanform.ashx/scanform-200.pdf?AQAAANClr4GgQswICQCRE25YbbNJoFh3vMorYewstgh4nHWMMQrCQBBFl5VgBCuL1HuEmcmuOlYm1mIgJ1hiCnHdBbHxaF7BQzkm2GjhLz48_uPn_UZNqhDU9hH165nrgWdtuvSmTse7iCxKS2AOXe-jafz1bOogMm99vHmzT_HUeb2rMgYLTkSr34w8HR4LRkJAcITEqzU7CyUzZ4wO8K9g7Ucoxv4ayREtLbwBkhIsSA==</ManifestUrl>
        </EndofDayManifest>
      </EndOfDayManifests>
    </CreateManifestResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
IntegratorTxID xsd:string
maxLength=128
The IntegratorTxID (Transaction ID) is a unique number from the integrator's system and used to retry a failed CreateIndicium attempt or locate and reconcile any billable transaction ordered from Stamps.com. Stamps.com issues a StampsTxID response which is the Stamps.com counterpart to this number and a unique ID in the Stamps.com system for a transaction.
EndOfDayManifests Array of EndOfDayManifest Container for one or more manifest objects.
EndOfDayManifest Object

Element Data Type Description
PickupCarrier
PickupCarrier Usps
None

Indicates the type of pickup to be requested. The only value we will currently support is USPS.
ManifestType
ManifestType ScanForm
GlobalAdvantage
All

Specifies the manifest generated.
ManifestId xsd:string The ID of created Manifest.
ManifestUrl xsd:string Manifest URL. If the ImageType is not PDF, this string could include multiple URLs that separated by spaces.
ContainerLabels Array of ContainerLabel For Internal Use only.
ContainerLabel Object
Element Data Type Description
ContainerTrackingNumber xsd:string Container Tracking Number.
ContainerUrl xsd:string Container URL. If the ImageType is not PDF, this string could include multiple URLs that separated by spaces.
StampsTxId xsd:string Stamps.com transaction identifier.

TrackShipment

The TrackShipment web method is used to get tracking events for a shipment where the postage was obtained through the CreateIndicium web method. Given the StampsTxID or TrackingID for the package, this web method will return a collection of TrackingEvent objects which the integrator can display to the user.

TrackShipment object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/TrackShipment"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:TrackShipment>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:StampsTxID>c605aec1-322e-48d5-bf81-b0bb820f9c22</tns:StampsTxID>
    </tns:TrackShipment>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
StampsTxID xsd:string
maxLength=128
Stamps.com transaction identifier returned from CreateIndicium web method. Only one of StampsTxID or TrackingNumber is necessary.
Authenticator xsd:string
maxLength=128
Tracking number returned from CreateIndicium web method. Only one of StampsTxID or TrackingNumber is necessary.
Note: TrackingNumbers returned from CreateEnvelopeIndicium are not trackable. The only use of those numbers is to perform an e-refund via CancelIndicium.

TrackShipmentResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 20:17:42 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <TrackShipmentResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
            <Authenticator>***authenticator***</Authenticator>
            <TrackingEvents>
                <TrackingEvent>
                    <Timestamp>2008-02-19T10:32:00</Timestamp>
                    <Event>DELIVERED</Event>
                    <TrackingEventType>Delivered</TrackingEventType>
                    <City>FORT WAYNE</City>
                    <State>IN</State>
                    <Zip>46809</Zip>
                    <Country>US</Country>
                    <SignedBy />
                    <AuthorizedAgent>true</AuthorizedAgent>
                </TrackingEvent>
                <TrackingEvent>
                    <Timestamp>2008-02-15T16:58:00</Timestamp>
                    <Event>PROCESSED</Event>
                    <TrackingEventType>Enroute</TrackingEventType>
                    <City>INDIANAPOLIS</City>
                    <State>IN</State>
                    <Zip>46206</Zip>
                    <Country>US</Country>
                    <SignedBy />
                    <AuthorizedAgent>true</AuthorizedAgent>
                </TrackingEvent>
                <TrackingEvent>
                    <Timestamp>2008-02-13T16:09:00</Timestamp>
                    <Event>Electronic Notification</Event>
                    <TrackingEventType>ElectronicNotification</TrackingEventType>
                    <City />
                    <State />
                    <Zip>90066</Zip>
                    <Country>US</Country>
                    <SignedBy />
                    <AuthorizedAgent>true</AuthorizedAgent>
                </TrackingEvent>
            </TrackingEvents>
        </TrackShipmentResponse>
    </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
TrackingEvents Array of TrackingEvent Collection of TrackingEvent objects, each one representing one scan of the package by the USPS. Zero or more TrackingEvent objects will be returned as part of the response.
TrackingEvent Object
Element Data Type Description
Timestamp xsd:datetime Date and time of event.
Event xsd:string Short description of event.
TrackingEventType
TrackingEventType None
ManifestAcknowledgement
ElectronicNotification
Delivered
AttemptedNoticeLeft
AcceptOrPickup
Refused
Undeliverable
Forwarded
ArrivalAtUnit
Missent
ReturnToSender
Enroute
DeadLetter
ArrivalAtPickupPoint
NoSuchNumber
InsufficientAddress
MovedNoForwarding.
ForwardingExpired
AddresseeUnknown
Vacant
Unclaimed
Deceased
ReturnedOtherReason
PickedUpByShippingPartner
ArrivedAtShippingPartner
DepartedFromShippingPartner
UnrecognizedEvent
ErrorDateNotAvailable
ArriveSortFacility_A1
AcceptedAtDestination
ArrivedUSPSSortFacility
Processed_BE
DepartUSPSSortFacility
DeliveryStatusNotUpdated
DispatchedFromSortFacility
ShippingLabelCreated
DepartSortFacility_L1
PickedUpAndProcessedByAgent
OriginAcceptance
ProcessedAtDestinationFacility
OutForDelivery
Sorting_ProcessingComplete
DispatchedToSortFacility
ArriveSortFacility_R1
Processed_RB
DepartSortFacility_T1
ShipmentAcceptance
In_processAcceptance
ArriveSortFacility_U1
Mis_shipped
AvailableForPickup
PickedUpByAgent
ReturnToSender_NotPickedUp
DeadMail_DisposedByPostOffice
DeadMail_SentToRecoveryCenter
Processed_RegisteredMailOnly_35
Processed_RegisteredMailOnly_36
Processed_RegisteredMailOnly_38
Processed_RegisteredMailOnly_39
Processed_RegisteredMailOnly_40
ReceivedAtOpeningUnit
USPSHandoffToShippingPartner
PickedUp
CustomerRecall
DispatchedToMilitary
DuplicateLabelID
BusinessClosed
NoticeLeft
ReceptacleBlocked
ReceptacleFull
NoSecureLocationAvailable
NoAuthorizedRecipientAvailable
TenderedToAgentForFinalDelivery
TenderedToPostalService
ArrivedAgentFacility
DepartedAgentFacility
DeliveredByAgentToMerchant
FinalDispositionByMerchant

Tracking event type.
City xsd:string City where event occurred.
State xsd:string State where event occurred.
Zip xsd:string ZIP code where event occurred.
Country xsd:string Country where event occurred.
SignedBy xsd:string If event is a signature event, name of signer.
AuthorizedAgent xsd:Boolean

GuaranteedDeliveryDate xsd:date USPS provided guaranteed date, if available.
ExpectedDeliveryDate xsd:date USPS provided expected or predicted delivery date.
ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
Carrier xsd:string Specifies carrier of the package.
DestinationInfo DestinationInfo Object Specifies the destination of the package.
DestinationInfo Object
Element Data Type Description
DestinationCity xsd:string Destination City.
DestinationState xsd:string Destination State.
DestinationZip xsd:string Destination Zip.
DestinationCountry xsd:string Destination Country.

Manage Account

RegisterAccount

The RegisterAccount web method is used to register a new account for the SWS/IM system. Users of SWS/IM integrations must have accounts with Stamps.com. These accounts allow the user to make use of the SWS/IM integration as well as the standard Stamps.com service.

This feature is not available for all integrations. Most integrations should simply open the Stamps.com registration web page in a browser window to perform new account registration. For integrations that require additional control over the registration experience, this feature is available. Please contact Stamps.com directly for more information about how to enable this feature for your integration.

RegisterAccount object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/RegisterAccount"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:RegisterAccount>
      <tns:IntegrationID>***integrationid***</tns:IntegrationID>
      <tns:UserName>test</tns:UserName>
      <tns:Password>password1</tns:Password>
      <tns:Codeword1Type>MothersMaidenName</tns:Codeword1Type>
      <tns:Codeword1>Smith</tns:Codeword1>
      <tns:Codeword2Type>StreetName</tns:Codeword2Type>
      <tns:Codeword2>Maple</tns:Codeword2>
      <tns:PhysicalAddress>
        <tns:FirstName>Geoff</tns:FirstName>
        <tns:LastName>Anton</tns:LastName>
        <tns:Address1>12959 Coral Tree Place</tns:Address1>
        <tns:City>Los Angeles</tns:City>
        <tns:State>CA</tns:State>
        <tns:PhoneNumber>1111111111</tns:PhoneNumber>
      </tns:PhysicalAddress>
      <tns:MachineInfo>
        <tns:IPAddress>111.111.111.111</tns:IPAddress>
      </tns:MachineInfo>
      <tns:Email>test@stamps.com</tns:Email>
      <tns:AccountType>Individual</tns:AccountType>
      <tns:CreditCard>
        <tns:CreditCardType>Visa</tns:CreditCardType>
        <tns:AccountNumber>4111111111111111</tns:AccountNumber>
        <tns:ExpirationDate>2009-12-27T20:26:05Z</tns:ExpirationDate>
      </tns:CreditCard>
    </tns:RegisterAccount>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
UserName xsd:string
maxLength=40
Desired user name for new account. User names are unique in the Stamps.com system; the integration must be prepared to allow the user to choose a new user name should their initial choice be taken.
Password xsd:string
minLength=6
maxLength=20
Password for new account. The password must be at least 6 characters long and must contain at least one letter and one number.
Codeword1Type
CodewordType MothersMaidenName
PetsName
BirthCity
HighSchoolMascot
FathersBirthplace
StreetName
FirstSchoolsName
FirstCarsMakeModel
Last4SocialSecurityNumber
Last4DriversLicense
First codeword type. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support. The first and second codeword types must be different.
Codeword1 xsd:string
minLength=2
maxLength=33
First codeword. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support.
Codeword2Type
CodewordType MothersMaidenName
PetsName
BirthCity
HighSchoolMascot
FathersBirthplace
StreetName
FirstSchoolsName
FirstCarsMakeModel
Last4SocialSecurityNumber
Last4DriversLicense
Second codeword type. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support. The first and second codeword types must be different.
Codeword2 xsd:string
minLength=2
maxLength=33
Second codeword. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support.
PhysicalAddress Address The physical address for the account. This must be a fully cleansed address, and may not be a PO Box. The contact information for the account (name, company name, phone number) are obtained from this address object.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.

MailingAddress Address The mailing address for the account. This element is optional and if not provided, the mailing address for the account will be set equal to the physical address. Usually, this is omitted, but a typical usage of this is when a user wants to use a PO Box for any necessary correspondence from Stamps.com.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
MachineInfo MachineInfo Contains information identifying the end-users computer.
Email xsd:string
maxLength=41
E-mail address for new account.
AccountType
AccountType Individual
HomeOffice
HomeBasedBusiness
OfficeBasedBusiness

Type of account: personal, home office, etc.
PromoCode xsd:string
maxLength=50
The promo code chooses a billing plan and account features for the new account. This can be omitted, in which case the new account will receive the standard billing plan and features associated with the integration ID.
CreditCard CreditCard Credit card details for payment of postage and billing fees. Required when no AchAccount
CreditCard Object

Element Data Type Description
CreditCardType
CreditCardType Visa
MasterCard
AmericanExpress
Discover

Visa, Mastercard, etc.
AccountNumber xsd:string
maxLength=20
Credit card number.
CVN xsd:string
maxLength=3
Credit card verification number.
ExpirationDate xsd:date The expiration date of the credit card. Only the month and year of this date are relevant.
BillingAddress Address If not specified, the billing address will default to the mailing address (which in turn defaults to the physical address if not specified). The name portion of this address is used as the “cardholder name”, so this address object should be specified even if just the cardholder name differs from the name on the mailing address.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
AchAccount AchAccount Bank Account details for payment of postage and billing fees. Required when no CreditCard
AchAccount Object
SendEmail xsd:boolean For internal use only. Integrations may ignore this value.

RegisterAccountResponse object

HTTP 200
Date: Wed, 02 Sep 2009 23:06:40 GMT
Server: Microsoft-IIS/6.0
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <RegisterAccountResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <RegistrationStatus>Success</RegistrationStatus>
      <SuggestedUserName />
    </RegisterAccountResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
RegistrationStatus
RegistrationStatus Success
Fail
Either Success or Fail. Most failure cases will take the form of a SOAP fault, but if the desired username is already in use, the web method will succeed with this value set to Fail, and a new suggested user name will also be returned.
SuggestedUserName xsd:string When RegistrationStatus is Fail, this will have a new user name, based on the original requested user name that can be suggested to the end-user.

GetAccountInfo

The GetAccountInfo web method is used to get information about the user's account, including the postage balance and the operations the user is allowed to invoke. The integration will likely call this immediately after authenticating the user to tailor the integration to the capabilities of the user and display the available postage balance.

GetAccountInfo object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/GetAccountInfo"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:GetAccountInfo>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
    </tns:GetAccountInfo>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.

GetAccountInfoResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 20:27:41 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetAccountInfoResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <AccountInfo>
        <CustomerID>####</CustomerID>
        <MeterNumber>####</MeterNumber>
        <UserID>####</UserID>
        <PostageBalance>
          <AvailablePostage>####.##</AvailablePostage>
          <ControlTotal>####.##</ControlTotal>
        </PostageBalance>
        <MaxPostageBalance>250</MaxPostageBalance>
        <LPOCity>Los Angeles</LPOCity>
        <LPOState>CA</LPOState>
        <LPOZip>90066</LPOZip>
        <Capabilities>
          <CanPrintShipping>true</CanPrintShipping>
          <CanUseCostCodes>true</CanUseCostCodes>
          <CanUseHiddenPostage>true</CanUseHiddenPostage>
          <CanPurchaseSDCInsurance>true</CanPurchaseSDCInsurance>
          <CanPrintMemoOnShippingLabel>true</CanPrintMemoOnShippingLabel>
          <CanPrintInternational>true</CanPrintInternational>
          <CanPurchasePostage>true</CanPurchasePostage>
          <CanEditCostCodes>true</CanEditCostCodes>
          <MustUseCostCodes>false</MustUseCostCodes>
          <CanViewOnlineReports>true</CanViewOnlineReports>
          <PerPrintLimit>922337203685477.5807</PerPrintLimit>
        </Capabilities>
      </AccountInfo>
    </GetAccountInfoResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
AccountInfo AccountInfo Account information, including postage balance and user capabilities.
AccountInfo Object

Element Data Type Description
CustomerID xsd:int Stamps.com customer ID.
MeterNumber xsd:int USPS meter number.
UserID xsd:int Stamps.com user ID. Note: Stamps.com supports multiple-user accounts – several users may share the same customer ID and meter number, but each will have a unique user ID.
PostageBalance PostageBalance Postage balance, including available balance and control total.
PostageBalance Object
Element Data Type Description
AvailablePostage xsd:decimal Current balance of available postage in the meter.
ControlTotal xsd:decimal Control total to be passed to PurchasePostage web method when purchasing additional postage.
MaxPostageBalance xsd:decimal Maximum amount that can ever be stored in the meter.
LPOCity xsd:string
maxLength=29
Licensing Post Office city.
LPOState xsd:string
maxLength=3
Licensing Post Office state.
LPOZip xsd:string
maxLength=6
Licensing Post Office ZIP code.
AccountId xsd:long Account ID.
CorpID xsd:int Corporation ID.
StoreID xsd:string Online store ID.
CostCodeLimit xsd:int Maximum number of cost codes.
MeterBalanceLimit xsd:int Maximum balance for meter.
MonthlyPostagePurchaseLimit xsd:int Maximum monthly postage purchase amount.
MaxUsers xsd:int Maximum number of users. 1 = single-user.
Capabilities Capabilities User capabilities. Determines which operations the user should have the rights to perform.
Capabilities Object
Element Data Type Description
CanPrintShipping xsd:boolean True if user can print shipping labels.
CanUseCostCodes xsd:boolean True if user can use cost codes.
CanUseHiddenPostage xsd:boolean True if user can print shipping labels with hidden postage.
CanPurchaseSDCInsurance xsd:boolean True if user can purchase Stamps.com insurance.
CanPrintMemoOnShippingLabel xsd:boolean True if user can print shipping labels with memo fields.
CanPrintInternational xsd:boolean True if user can print International shipping labels.
CanPurchasePostage xsd:boolean True if user can purchase postage.
CanEditCostCodes xsd:boolean True if user can edit cost codes.
MustUseCostCodes xsd:boolean True if user must use a cost code when printing.
CanViewOnlineReports xsd:boolean True if user can view online reports via Stamps.com hosted web pages.
PerPrintLimit xsd:decimal Default: 922337203685477.5807 (unlimited) Maximum amount user can print in a single indicium. The default value is a special value, 922337203685477.5807, reserved to mean unlimited.
AllowAllMailClasses xsd:boolean True if user is allowed to print all possible mail classes. Some accounts are restricted to printing the premium mail classes (Priority Mail and Priority Mail Express) only.
CanPrintReturnShippingLabel xsd:boolean True if user can print return shipping labels.
CanManageUsers xsd:boolean True if user can manage other users on a multi-user account.
CanPrintNetStamps xsd:boolean True if user can print NetStamps.
CanEmailNotifications xsd:boolean True if user can request e-mail notifications for shipments.
CanViewReports xsd:boolean True if user can view reports.
CanCreateSCANForm xsd:boolean True if user can create SCAN forms.
AllowRestrictedSheets xsd:boolean True if user can use restricted NetStamps sheets.
HideUnavailableFeatures xsd:boolean True if user should not be able to see unavailable features.
WebPostage xsd:boolean True if user can print via the web-based postage printing website.
CanViewInsuranceHistory xsd:boolean True if user can view insurance history.
CanChangeServicePlan xsd:boolean True if user can change service plans.
HideEstimatedDeliveryTime xsd:boolean True if user should not be able to see estimated delivery times.
CanPurchaseFromStore xsd:boolean True if user can purchase from the online store.
CanChangePhysicalAddress xsd:boolean True if user can change the physical address of their meter.
CanChangePaymentMethod xsd:Boolean True if user can change payment methods.
CanChangeContactInfo xsd:boolean True if user can change contact information.
CanViewAdvancedReporting xsd:boolean True if user can view advanced reports.
CanCreateCriticalMail xsd:boolean True if user is allowed to print Critical Mail.
CanUseInvoicing xsd:boolean True if user uses invoicing billing method. Invoicing billing method allows user to print but not to purchase any postage beforehand. User will be billed at the end of billing cycle based on the used postage.
CanUseCertifiedMail xsd:boolean True if user is allowed to print Certified Mail.
CanPrintAllIndiciumValues xsd:boolean True if user is allowed to print indicium with any postage value. False if user is only allowed to print one ounce First Class Letter. This constraint applies to CreateNetStampsIndicia and CreateMailingLabelIndicia.
CanPrintCubic xsd:boolean True if user is eligible to print labels with cubic pricing.
CanPrintGP xsd:boolean For internal use only. Integrations may ignore this value.
GPShipToConsolidator xsd:boolean For internal use only. Integrations may ignore this value.
CanCreateUnlimitedStores xsd:boolean True if use can create unlimited stores in batch printing.
CanPrintGPSmartSaver xsd:boolean For internal use only. Integrations may ignore this value.

MeterPhysicalAddress Address Physical address of meter.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
ResubmitStatus

This value is not intended to be used by integrators.
ResubmitCookie

This value is not intended to be used by integrators.
PlanID xsd:int The Stamps.com Plan that the account is on.
PendingPlanID xsd:int The Stamps.com Plan that the account has been upgraded or downgraded to.
Username xsd:string User name of the account.
AutoBuySettings AutoBuySettings An AutoBuySettings object
AutoBuySettings Object
Element Data Type Description
AutoBuyEnabled xsd:boolean Indicates whether the Users’ Auto Buy setting is turned on/off.
PurchaseAmount xsd:decimal Indicates the amount to purchase postage for when the Users’ Postage Balance reaches the trigger amount.
TriggerAmount xsd:decimal Indicates the trigger amount at which the Auto Buy is initiated.

CustomerData xsd:string This feature is for internal use only.
RateToken xsd:string This feature is for internal use only.
Terms Terms A Terms object indicates which terms and conditions the user has agreed upon.
Terms Object
Element Data Type Description
TermsAR xsd:boolean Indicates whether the user accepted Stamps.com AR Terms.
TermsGP xsd:boolean Indicates whether the user accepted Stamps.com GPP Terms.
TermsSL xsd:boolean Indicates whether the user accepted Stamps.com SL Terms.
TermsFX xsd:boolean Indicates whether the user accepted Stamps.com FX Terms.

OutstandingLabelBalance xsd:decimal This feature is not available for all integrations.
MaxOutstandingLabelBalance xsd:decimal This feature is not available for all integrations.
CanAddImage xsd:boolean True if the user can add image to shipping labels
MaxImageCount xsd:int Number of images the account is allowed to upload
Address Address Address for account.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
CustomerEmail xsd:string E-mail address for account.

AuthenticateUser

The AuthenticateUser web method is used to start a session between the integration and the SWS server. Unlike the other web methods, this web method requires a Credentials object as input and will not accept an Authenticator. An Authenticator string will be returned on success.

AuthenticateUser Object

Request:

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/AuthenticateUser"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:AuthenticateUser>
      <tns:Credentials>
        <tns:IntegrationID>***integrationid***</tns:IntegrationID>
        <tns:Username>test</tns:Username>
        <tns:Password>password1</tns:Password>
      </tns:Credentials>
    </tns:AuthenticateUser>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

AuthenticateUserResponse Object

Response

HTTP 200
Server: ASP.NET Development Server/8.0.0.0
Date: Sat, 29 Aug 2009 00:17:20 GMT
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####
Connection: Close

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <AuthenticateUserResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
    </AuthenticateUserResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string that is to be used in subsequent web method requests in lieu of a Credentials object. While the SWS API allows full Credentials to be supplied in every request, it is preferred to use an Authenticator string to avoid passing sensitive information on every request and to allow the SWS server to detect when messages are lost due to network problems.
LastLoginTime xsd:datetime The last login time for this user.
ClearCredential xsd:boolean Indicates, if the credentials are not to be saved locally. Value is dependant on the security policy associated with the account.
LoginBannerText xsd:string The banner text if any that should be displayed upon authentication. This is set at the Corp level.
PasswordExpired xsd:boolean True if the user’s password has expired, in which case ChangePassword or StartPasswordReset can be used to reset password. Default security policy has no finite password expiry duration.
CodewordStatusSet xsd:boolean True if codewords have been set for the user. For the user who has not yet set codewords, the call will succeed but this variable will be set to false. In that case, the user must set codewords before other methods will succeed.

ChangePassword

The ChangePassword web method is used to change a user’s password. The integration can call ChangePassword with either credentials or authenticator. If used with an authenticator OldPassword (which is the current password) should be provided.

ChangePassword object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/ChangePassword"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
  <soap:Body>
    <tns:ChangePassword>
   <tns:Credentials>
      <tns:IntegrationID>>***integrationid***</tns:IntegrationID>
        <tns:Username>test</tns:Username>
        <tns:Password>pwd1</tns:Password>
   </tns:Credentials>
    </tns:ChangePassword>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
NewPassword xsd:string The new password for this user.

ChangePasswordResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 05 Mar 2011 20:17:42 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <ChangePasswordResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
       <Authenticator>***authenticator***</Authenticator>
    </ChangePasswordResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
StampsTxID xsd:string
maxLength=128
The Stamps.com transaction identifier returned from CreateIndicium. Canceling indicia by StampsTxID instead of by TrackingNumber is highly recommended.
TrackingNumber xsd:string The tracking number returned from CreateIndicium or CreateEnvelopeIndicium. Canceling indicia by StampsTxID instead of by TrackingNumber is highly recommended.
SendEmail xsd:boolean For internal use only. Integrations may ignore this value.

GetURL

There are several account management operations that are available to Stamps.com customers on the Stamps.com website. Rather than duplicate all that functionality in the form of SWS web services and putting an additional burden on integrators to create a user interface for it, the SWS API allows the integrator to obtain the URL of Stamps.com hosted web pages to perform these operations. The GetURL web method does this.

The URLs returned from this web method are specific to the user and session, allowing the Stamps.com website to display information tailored for the user without requiring the user to re-authenticate. The URL is only valid for one request, so the URL should be immediately navigated to in a browser and not stored by the integration.

URLs to the following Stamps.com web pages are available through this web method: Home, Account Settings, Edit Cost Codes, Online Reports, and Help.

The Stamps.com website will also know which integration was used to obtain the URL, obtained from the IntegrationID element in the Credentials object. Through special arrangement with Stamps.com, the web pages hosted by Stamps.com may be co-branded for the integrator. When this is done, an additional element of the request, ApplicationContext, can be set to control the behavior of the customized web page.

GetURL object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/GetURL"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:GetURL>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:URLType>AccountSettingsPage</tns:URLType>
      <tns:ApplicationContext/>
    </tns:GetURL>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
URLType
URLType HomePage
AccountSettingsPage
EditCostCodesPage
OnlineReportsPage
HelpPage
OnlineReportingHistory
OnlineReportingRefund
OnlineReportingPickup
OnlineReportingSCAN
OnlineReportingClaim
StoreChangePlan
WebClientHome
ReportsBalances
ReportsExpenses
ReportsPrints
StoreBuyPostage
StoreMeters
StoreUsers
StorePaymentMethods
StoreCorpContactInfo
StoreMeterUsers
StoreMeterSettings
StoreMeterAddress
StoreShippingAddresses
StoreReferAFriend
StoreAccountCredit
StoreReorder
StoreMyProfile
StorePassword
StoreCommPreferences
StoreNetStampsLabels
StoreShippingLabels
StoreMailingLabels
StoreScalesAndPrinters
StoreFreeUSPSSupplies
StoreBubbleMailers
StoreShippingSupplies
StoreScales
StoreAveryNetStampsLabels
StoreAveryMailingLabels
StoreMeterContactInfo
StoreEditMeterAddress
StoreHome
StoreAccount
StoreCostCode
StoreHistory
StoreFaq
StoreCustomerHome
StoreGetAccountInfoJSon
StoreSetAccountInfoJSon
StoreUserCategories
StoreCategory
StoreUpdatePaymentMethodResubmit
StoreDefaultPaymentMethods
StoreSignOut
WebClientDefault
WebClientPreferences
SetTermsGeneralAdvancedTermsAndConditionsIPA
UploadImage
Type of URL to get (e.g., Home page or Account Settings page).
ApplicationContext xsd:string If Stamps.com has provided customized web pages for the integration, this can provide additional information to those web pages. Specifics will vary based on the integration.

GetURLResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 23:00:35 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetURLResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
      <URL>https://store.stamps.com/myaccount?auth=***authenticator***</URL>
    </GetURLResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
URL xsd:string URL to requested page. The URL will contain appropriate authentication information such that the user will not have to re-authenticate on the Stamps.com hosted web page.

SetAutoBuy

The SetAutoBuy web method is used to turn Auto-Buy on/off and set the Auto-Buy Trigger and Purchase Amount for any user.

SetAutoBuy object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/SetAutoBuy
Content-Length: ####

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Header/>
  <soap:Body>
    <SetAutoBuy>
      <Authenticator>***authenticator***</Authenticator>
      <AutoBuySettings>
        <AutoBuyEnabled>true</AutoBuyEnabled>
        <PurchaseAmount>100</PurchaseAmount>
        <TriggerAmount>90</TriggerAmount>
      </AutoBuySettings>
    </SetAutoBuy>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
AutoBuySettings AutoBuySettings Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
AutoBuySettings Object
Element Data Type Description
AutoBuyEnabled xsd:boolean Indicates whether the Users’ Auto Buy setting is turned on/off.
PurchaseAmount xsd:decimal Indicates the amount to purchase postage for when the Users’ Postage Balance reaches the trigger amount.
TriggerAmount xsd:decimal Indicates the trigger amount at which the Auto Buy is initiated.

SetAutoBuyResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 22 Dec 2014 20:17:42 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <SetAutoBuyResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Authenticator>***authenticator***</Authenticator>
    </SetAutoBuyResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.

Other Calls

CreateEnvelopeIndicium

CreateEnvelopeIndicium object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/CreateEnvelopeIndicium"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
  <soap:Body>
    <tns:CreateEnvelopeIndicium>
      <tns:Authenticator>***authenticator***</tns:Authenticator>
      <tns:IntegratorTxID>1234567890ABCDEF</tns:IntegratorTxID>
      <tns:Rate>
        <tns:FromZIPCode>90405</tns:FromZIPCode>
        <tns:ToZIPCode>90066</tns:ToZIPCode>
        <tns:Amount>0.0</tns:Amount>
        <tns:ServiceType>US-FC</tns:ServiceType>
        <tns:DeliverDays/>
        <tns:WeightLb>0</tns:WeightLb>
        <tns:WeightOz>1</tns:WeightOz>
        <tns:PackageType>Letter</tns:PackageType>
        <tns:ShipDate>2011-03-08</tns:ShipDate>
        <tns:RectangularShaped>true</tns:RectangularShaped>
      </tns:Rate>
      <tns:From>
        <tns:FullName>Some Body</tns:FullName>
        <tns:Address1>3420 Ocean Park Bl</tns:Address1>
        <tns:Address2>Ste 1000</tns:Address2>
        <tns:City>Santa Monica</tns:City>
        <tns:State>CA</tns:State>
        <tns:ZIPCode>90405</tns:ZIPCode>
      </tns:From>
      <tns:To>
        <tns:FullName>GEOFF ANTON</tns:FullName>
        <tns:NamePrefix/>
        <tns:FirstName/>
        <tns:MiddleName/>
        <tns:LastName/>
        <tns:NameSuffix/>
        <tns:Title/>
        <tns:Department/>
        <tns:Company>STAMPS.COM</tns:Company>
        <tns:Address1>12959 CORAL TREE PL</tns:Address1>
        <tns:Address2/>
        <tns:City>LOS ANGELES</tns:City>
        <tns:State>CA</tns:State>
        <tns:ZIPCode>90066</tns:ZIPCode>
        <tns:ZIPCodeAddOn>7020</tns:ZIPCodeAddOn>
        <tns:DPB>59</tns:DPB>
        <tns:CheckDigit>6</tns:CheckDigit>
        <tns:Province/>
        <tns:PostalCode/>
        <tns:Country/>
        <tns:Urbanization/>
        <tns:PhoneNumber/>
        <tns:Extension/>
        <tns:CleanseHash>7SWYAzuNh82cWhIQyRFXRNa71HFkZWFkYmVlZg==20070513</tns:CleanseHash>
      </tns:To>
   <tns:Mode>Normal</tns:Mode>
   <tns:ImageType>Png</tns:ImageType>
      <tns:HideFIM>false</tns:HideFIM>
      </tns:CreateEnvelopeIndicium>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
IntegratorTxID xsd:string
maxLength=128
The IntegratorTxID (Transaction ID) is a unique number from the integrator's system and used to retry a failed CreateIndicium attempt or locate and reconcile any billable transaction ordered from Stamps.com. Stamps.com issues a StampsTxID response which is the Stamps.com counterpart to this number and a unique ID in the Stamps.com system for a transaction.
Rate Rate A Rate object previously returned from the GetRates web method. Remove Rate elements not desired for the indicium.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
RateToken xsd:string This feature is for internal use only.
From Address Return address.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
To Address Delivery address. The delivery address provided can optionally not be cleansed. In this case CreateIndicium validates that the City, State and Zip matched the corresponding values in the USPS Address Matching system. If not an InvalidDestinationAddress exception is thrown.
Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
CustomerID xsd:string
maxLength=64
A customer identifier required for USPS audits, aviation security, and Stamps.com Insurance purchases. Only used if printed postage is being issued to someone other than the Stamps.com user. If a particular customer abuses the system, they may be denied access to the system in the future.
Mode
CreateIndiciumMode Normal
Sample
NoPostage
Preview
The manner in which the envelope image is created. Default is Normal.
ImageType
ImageType Auto
AZpl
BZpl
EncryptedPngUrl
Epl
Gif
Jpg
Pdf
PrintOncePdf
Png
Zpl
Bmp
BmpMonochrome
PngMonochrome
JpgMonochrome
GifMonochrome
Image type of shipping label. Default is Auto: which generates a Png image.
cost_code_id xsd:int Cost code ID. See EnumCostCodes web method for more information.
HideFIM xsd:boolean Indicates if the generated image should have a FIM (Facing Idententification Mark). If the generated image is going to be printed on an envelope that already has a FIM, then this value should be true. The default value is false.
OrderId xsd:string maxLength=100 Caller defined data. Order ID associates to this print.
Memo xsd:string maxLength=150 Caller defined data. Memo associated to this print.
ImageId xsd:int Image Identifier of uploaded image or logo that will be added to the left side of the return address
ImageId2 xsd:int Image Identifier of uploaded image or logo that will be added to the right side of the return address

CreateEnvelopeIndiciumResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 18:58:01 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CreateEnvelopeIndiciumResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
      <Authenticator>***authenticator***</Authenticator>
      <IntegratorTxID>1234567890ABCDEF</IntegratorTxID>
      <TrackingNumber>40003605381686</TrackingNumber>
      <Rate>
        <FromZIPCode>90405</FromZIPCode>
        <ToZIPCode>90066</ToZIPCode>
        <Amount>0.45</Amount>
        <ServiceType>US-FC</ServiceType>
        <DeliverDays>1</DeliverDays>
        <WeightOz>1</WeightOz>
        <PackageType>Letter</PackageType>
        <ShipDate>2012-03-08</ShipDate>
        <DimWeighting>N</DimWeighting>
        <EffectiveWeightInOunces>1</EffectiveWeightInOunces>
     <IsIntraBMC

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
TrackingNumber xsd:string
maxLength="128"
A confirm number. If First Class the number is an IMB format confirm number. If Priority or Priority Mail Express an IMB encoded POSTNET equivalent number is returned. Neither of these are trackable. The IMB confirm number can be used for performing an e-refund via CancelIndicium.
Rate Rate The Rate object from the request modified to include actual cost details.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
StampsTxID xsd:string
maxLength=128
Stamps.com transaction identifier.
URL xsd:string A web addresses to the envelope image.
PostageBalance PostageBalance New postage balance, including available postage and control total.
PostageBalance Object
Element Data Type Description
AvailablePostage xsd:decimal Current balance of available postage in the meter.
ControlTotal xsd:decimal Control total to be passed to PurchasePostage web method when purchasing additional postage.
Mac xsd:string For internal use only. Integrations may ignore this value.
PostageHash xsd:string For internal use only. Integrations may ignore this value.

CreateMailingLabelIndicia

The CreateMailingLabelIndicia method generates the postage indicia based on the shipping information provided in the request. Note that CreateMailingLabelIndicia is used to generate multiple indicia while CreateIndicium is used to generate a single indicium. The SWS API will return a URL that references the image of the labels.

Special Considerations:

CreateMailingLabelIndicia object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/CreateMailingLabelIndicia"
Content-Length: ####

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
    <SOAP-ENV:Body>
        <ns1:CreateMailingLabelIndicia>
            <ns1:Authenticator>***authenticator***</ns1:Authenticator>
            <ns1:IntegratorTxId>5243822d90796</ns1:IntegratorTxId>
            <ns1:Layout>Avery5160</ns1:Layout>
            <ns1:PrintAddress>true</ns1:PrintAddress>
            <ns1:StartRow>0</ns1:StartRow>
            <ns1:StartColumn>0</ns1:StartColumn>
            <ns1:IndiciumInfo>
                <ns1:IndiciumInfoV3>
                    <ns1:Rate>
                        <ns1:FromZIPCode>90245</ns1:FromZIPCode>
                        <ns1:ToZIPCode>14203</ns1:ToZIPCode>
                        <ns1:ServiceType>US-FC</ns1:ServiceType>
                        <ns1:WeightOz>1</ns1:WeightOz>
                        <ns1:PackageType>Letter</ns1:PackageType>
                        <ns1:ShipDate>2013-09-25</ns1:ShipDate>
                        <ns1:AddOns/>
                    </ns1:Rate>
                    <ns1:To>
                        <ns1:FullName>Kyle Radner</ns1:FullName>
                        <ns1:Address1>123 Main St</ns1:Address1>
                        <ns1:City>Buffalo</ns1:City>
                        <ns1:State>NY</ns1:State>
                        <ns1:ZIPCode>14203</ns1:ZIPCode>
                    </ns1:To>
                </ns1:IndiciumInfoV3>
            </ns1:IndiciumInfo>
            <ns1:ImageType>Pdf</ns1:ImageType>
        </ns1:CreateMailingLabelIndicia>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
IntegratorTxID xsd:string
maxLength=128
The IntegratorTxID (Transaction ID) is a unique number from the integrator's system and used to retry a failed CreateIndicium attempt or locate and reconcile any billable transaction ordered from Stamps.com. Stamps.com issues a StampsTxID response which is the Stamps.com counterpart to this number and a unique ID in the Stamps.com system for a transaction.
Layout xsd:string
maxLength=128
Layout name of the sheet.
Avery5160: An Avery 5160 sheet.
Avery5163: An Avery 5163 sheet.
PrintAddress xsd:boolean true or false to determine if delivery address is printed. Default is false.
StartRow xsd:int The input parameters of starting row and column define the location of the first label to be generated. If destination address is not printed, which is determined by the first label, the start location could be anywhere in the sheet. If destination address is printed, the start location must be validated according to sheet layout, for example, for Avery 5160 it cannot start at second row, first column. All labels will be put on a sheet from left to right sequentially. If one row is not enough they will go to next row; If one sheet is not enough, they will flow to next sheet. Default value is 0.
StartColumn xsd:int See the description for StartRow above. Default value is 0.
IndiciumInfo Array of IndiciumInfoV3 Each element in this array describe a mailing label to be printed. The labels will be sequentially printed from left to right on the sheet, starting from StartRow and StartColumn.
IndiciumInfo Object

Element Data Type Description
Rate Rate The Rate object for the indicium to be printed.
Rate Object

Element Data Type Description
FromZipCode xsd:string
minLength=3
maxLength=10
The shipper's ZIP Code. This is required to accurately calculate some rates. Only first 3 digits are required. Only required for CreateIndicium methods.
ToZIPCode xsd:string
minLength=3
maxLength=10
The destination or recipients ZIP Code. Only first 3 digits required. Required for domestic CreateIndicium methods.
ToCountry xsd:string
maxLength=2
The destination or recipient’s country. The country code entered must match any entries returned by the GetSupportedCountries Web Method be "US". Required for international.
Amount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the rate cost for the particular shipment option. If this is blank or missing, check the error attribute for a reason. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
MaxAmount xsd:decimal Format: Decimal with up to three digits to the right of the decimal point This is the maximum rate cost for the particular shipment option. When the exact rate can be calculated, MaxAmount will be equal to Amount. If there is not enough information in the input Rate object to calculate an exact amount, Amount will be set to the lower bound of the known range and MaxAmount will be set to the upper bound. For example, if the the ToZipCode is omitted and the Rate is for a zone-based service, Amount will be the amount for the closest zone (1) and MaxAmount will be the amount for the furthest zone (8). In this case, some other elements of the Rate object may not apply in all cases. For example, when Amount and MaxAmount indicate a range of possible amounts, DimWeighting may only apply for the furthest zones (5-8).
ServiceType
ServiceType US-FC
US-MM
US-PP
US-PM
US-XM
US-EMI
US-PMI
US-FCI
US-PS
US-LM
DHL-PE
DHL-PG
DHL-PPE
DHL-PPG
DHL-BPME
DHL-BPMG
DHL-MPE
DHL-MPG
AS-IPA
AS-ISAL
AS-EPKT
DHL-PIPA
DHL-PISAL
GG-IPA
GG-ISAL
GG-EPKT
IBC-IPA
IBC-ISAL
IBC-EPKT
RRD-IPA
RRD-ISAL
RRD-EPKT
AS-GNRC
GG-GNRC
RRD-GNRC
SC-GPE
SC-GPP
SC-GPESS
SC-GPPSS
DHL-EWW
FX-GD
FX-HD
FX-2D
FX-ES
FX-SO
FX-PO
FX-GDI
FX-EI
FX-PI

Format: Decimal with up to three digits to the right of the decimal point

Required for CreateIndicium web method.

Not required for GetRates web method. If not specified in GetRates, the <rate> object in the response will include rates for all ServiceTypes.

ServiceDescription xsd:string A plain language description of the service returned, i.e. “USPS Priority Mail”
PrintLayouts xsd:string The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method See Valid Print Layouts.
DeliverDays xsd:string Format: Character string in the format "n-m", n being minimum number of days, m being maximum number of days. Blank if no delivery time estimates are available.
Error xsd:string If an amount isn't returned for this rate, there will be an error code. Only the first reason will be listed. E.g. Over maximum weight, oversize, etc.
WeightLb xsd:double The pounds portion of the weight with a precision of up to hundredths of a pound. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces * Must be specified if WeightOz is blank or 0. See Appendix D for more information on this element.

WeightOz xsd:double The ounces portion of the weight with a precision of up to hundredths of an ounce. The final weight used to calculate the rate will be WeightLb times 16 plus WeightOz ounces. * Must be specified if WeightLb is blank. See Appendix D for more information on this element.

PackageType
PackageType Unknown
Postcard
Letter
Large Envelope or Flat
Thick Envelope
Package
Small Flat Rate Box
Flat Rate Box
Large Flat Rate Box
Flat Rate Envelope
Flat Rate Padded Envelope
Large Package
Oversized Package
Regional Rate Box A
Regional Rate Box B
Regional Rate Box C
Legal Flat Rate Envelope
Express Envelope
Documents
Envelope
Pak

When PackageType is submitted, the GetRates web method will respond with the rate based on the specified package. However, if PackageType is omitted, the GetRates web method will respond with rates for all of the possible package types for the given ServiceType.

PackageType is required for CreateIndicium web method.

RequiresAllOf Array of RequiresOneOf

Collection of one or more <requiresoneof> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <requiresallof> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.

RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
Length xsd:double Represents the length in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Width xsd:double Represents the width in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Height xsd:double Represents the height in inches and tenths of an inch. Dimensions are required for proper rating whenever a <rate> object in a response to the GetRates web method has DimWeighting = "Y"
Shipdate xsd:date This is the date the package will be picked up or officially enter the mail system. This date can be upto 3 days in the future for any international mail service and domestic Priority Mail Express. For all other domestic mail services the date can be upto 7 days in the future. For ServiceType US-MM, US-PP and US-FC with no US-A-DC or US-A-SC this date can be upto 30 days in the future. The calculated rate will be based on this date.
DeliveryDate xsd:date The estimated delivery date. This value is returned from GetRates web method. The date is calculated under the consideration of ship date, USPS holidays and weekends. This element is removed from GetRates if delivery date is unknown.
InsuredValue xsd:decimal The amount to insure this shipment for, in dollars and cents. If a value is specified, insurance add-ons will be returned.
RegisteredValue xsd:decimal The registered value for this shipment, in dollars and cents.
CODValue xsd:decimal The collect on delivery value for this shipment, in dollars and cents.
DeclaredValue xsd:decimal The amount to declare for this shipment, in dollars and cents. Required for International.
NonMachinable xsd:boolean Default: false This is used to calculate a potential additional handling surcharge for certain types of items being sent. See DMM 401 for what qualifies.
RectangularShaped xsd:boolean Default: true Represents whether or not the parcel being sent is rectangular-shaped, or box-like. For dim-weight-based rates (Priority Mail), non-rectangular-shaped parcels may lower the effective weight.
Prohibitions xsd:string List of items prohibited from mailing based on country of destination. Only used for International.
Restrictions xsd:string Restrictions on items being shipped based on country of destination. Only used for International.
Observations xsd:string Additional mailing information based on country of destination. Only used for International.
Regulations xsd:string Additional regulations for shipping to destination country. Only used for International.
GEMNotes xsd:string Notes specific to Priority Mail Express International service. Only used for international when ServiceType is US-GEM.
MaxDimensions xsd:string Only returned for international mail classes, this field explains the maximum package dimensions for this mail class and destination country.
DimWeighting xsd:boolean If a <Rate> object is returned from a GetRates call with DimWeighting = "Y", this indicates that the dimensions of the package may have an impact on the rate. Be sure to also include the Length, Width and Height for proper rating whenever DimWeighting = "Y".
AddOns Array of AddOn Collection of one or more <AddOn> objects One or more <AddOn> objects will be returned for each add-on for a given ServiceType. <AddOn>s are passed as part of the CreateIndicium web method request to select the add-ons to be included in the postage printing. Returned in the <GetRatesResponse> object.
AddOn Object

Element Data Type Description
Amount xsd:decimal This is the amount / surcharge for this add on.
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
RequiresAllOf Array of RequiresOneOf Collection of one or more <RequiresOneOf> objects. This value is a hint to the integration that there are required add-ons to go with this add-on. If this add-on is selected, the integration must also choose exactly one add-on from each set of add-ons listed in the <RequiresAllOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
ProhibitedWithAnyOf Array of AddOnType Collection of one or more AddOnType objects. This value is a hint to the integration that there are add-ons that are prohibited to be used this add-on. If this add-on is selected, the integration must not choose any of the add-ons listed in the <ProhibitedWithAnyOf> element in order to form a valid rate to be passed to CreateIndicium. The integration may use this hint in preparing a user interface with pre-validation for its users.
RequiresOneOf Object
Element Data Type Description
AddOnType
AddonType SC-A-HP
SC-A-INS
SC-A-INSRM
SC-A-POU
US-A-CM
US-A-COD
US-A-DC
US-A-ESH
US-A-INS
US-A-NDW
US-A-RD
US-A-REG
US-A-RR
US-A-RRM
US-A-SC
US-A-SH
US-A-WDS
US-A-SR
US-A-ESH
US-A-NND
US-A-RRE
US-A-LANS
US-A-LAWS
US-A-HM
US-A-CR
US-A-1030
US-A-ASR
US-A-ASRD
US-A-PR
US-A-HFPU
SC-A-POU
CAR-A-SAT
CAR-A-RES
CAR-A-NSP CAR-A-ISR
CAR-A-DSR
CAR-A-ASR

The type of add-on rate / service.
MissingData xsd:string Describes data missing from the input to the GetRates web method that prevents an amount from being associated with this add-on. For example, the US-A-INS add-on may be listed as an available add-on with no amount if the insured value was not given in the GetRates call. In this case, the MissingData value will identify that the insured value should be provided.
Surcharges Array of Surcharge Collection of one or more Surcharge objects. Only appear when a surcharge applies.
Surcharge Object

Element Data Type Description
Amount xsd:decimal The cost of the surcharge, if applicable.
SurchargeType
SurchargeType SUR-A-ER
SUR-A-EV
SUR-A-FUEL
SUR-A-OS
SUR-A-OW
SUR-A-RAD
SUR-A-RD
SUR-A-AHS
SUR-A-NCS

The type of surcharge.

EffectiveWeightInOunces xsd:int Effective weight, which is calculated based on weight and dimensions of the mail piece, in ounces. Returned in the <GetRatesResponse> object.
Zone xsd:int Zone number of the mail piece. Returned in the <GetRatesResponse> object.
RateCategory xsd:int Rate Category of the mail piece. Returned in the <GetRatesResponse> object.
ToCity xsd:string Destination City name.
ToState xsd:string Destination State name. If it is specified, <GetRates> object detects whether the destination is supported by USPS.
CubicPricing xsd:boolean Cubic Pricing is available only for Priority Mail with PackageType “Large Envelope or Flat”, “Package”, “Large Package” or “Oversized Package”. If PackageType in <Rate> object is “Large Envelope or Flat”, Length and Width are prerequisites to determine eligibility for cubic pricing. If Length and Width were provided, and Height is less than or equal to ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for soft-pack or padded envelope cubic pricing. If Length and Width were provided, and Height is greater than ¾”, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length and Width were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for soft-pack or padded envelope cubic pricing or parcel cubic pricing. If PackageType of <Rate> object is “Package”, “Large Package” or “Oversized Package”, Length, Width and Height are prerequisites to determine eligibility for parcel cubic pricing. If Length, Width and Height were provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package qualifies the package for parcel cubic pricing. If Length, Width and Height were not provided, and a <Rate> object is returned from a GetRates call with CubicPricing = "Y", it indicates that the dimensions of the package may qualify the package for parcel cubic pricing
ContentType
ContentType Commercial Sample
Gift
Document
Returned Goods
Other
Merchandise
Humanitarian Donation
Dangerous Goods

Content type. One of: Commercial Sample, Dangerous Goods, Document, Gift, Humanitarian Donation, Merchandise, Returned Goods, or Other.
To Address The destination address to be printed on label. If destination address is not provided, only the indicium portion will be printed. If destination address is provided, the labels will have two portions on two separated stickers for address and indicium respectively.

Address Object
Element Data Type Description
FullName xsd:string Only required if not using the separate name fields: NamePrefix, FirstName, MiddleName, LastName, NameSuffix, or Title.
NamePrefix xsd:string A prefix to go before the person's first name Example: Mr., Ms., Mrs., Misses, Dr., etc. Only used if not using the FullName field.
FirstName xsd:string The person's first name. For RegisterAccount call the maximum size is 10. * Only required if not using the FullName field.
MiddleName xsd:string The person's middle name. For RegisterAccount call the maximum size is 1. Only used if not using the FullName field.
LastName xsd:string The person's last name. For RegisterAccount call the maximum size is 40. * Only required if not using the FullName field.
NameSuffix xsd:string A suffix to go after the person's last name Example: Jr., MD, PhD, etc. Only used if not using the FullName field.
Title xsd:string The person's title, per 'functional title'. USPS publication 28. For RegisterAccount call the maximum size is 30.
Department xsd:string The department of the company for this address (e.g. Finance).
Company xsd:string
maxLength=50*
The company for this address (e.g. Stamps.com). Max length 50 for domestic, 32 for International and 40 for RegisterAccount call.
Address1 Address2 Address3 xsd:string Up to three lines of address information. An address line may contain the street address as well as delivery unit (Apt, Ste, etc), separated by a comma. * Only Address1 is required. Max length 50
City xsd:string
maxLength=50
The name of the city for this address. *For RegisterAccount call the maximum size is 28.
State xsd:string maxLength=30 The two-character abbreviation of the state or fully spelled name of the state with maximum length of 30 characters for this address.

ZIPCode xsd:string The five-digit ZIP Code for this address. Only used for domestic addresses.
ZIPCodeAddOn xsd:string The "plus 4" portion of the ZIP Code for this address. max length 4 Only used for domestic addresses.
DPB xsd:string The two-digit delivery point code portion of the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
CheckDigit xsd:string The one-digit check digit for the ZIP Code for this address. Only used for domestic addresses, and obtained from the CleanseAddress method.
Province xsd:string The province portion of this address. Only used for international addresses.
PostalCode xsd:string The postal code portion of this address. Only used for international addresses.
Country xsd:string The country portion of this address. Must exactly match one of the supported country names. * Only required for international addresses.
Urbanization xsd:string The urbanization portion of this address. max length 28 Only used for addresses in Puerto Rico.
PhoneNumber xsd:string The phone number associated with this address. * Required in the following cases: - The From address for domestic Priority Mail Express - The To address for all international addresses - The From address for all international addresses For RegisterAccount call the maximum size is 10.
Extension xsd:string The extension of the phone number associated with this address.
FromZIPCode xsd:string The shipper's ZIP Code. CleanseAddress method uses for determining the DeliveryDate, DeliverDays and Zone. * Only first 3 digits are required.
CleanseHash xsd:string Returned from the CleanseAddress process. Store the cleanse hash with a cleansed address to allow re-use of this address without requiring another cleanse.
OverrideHash xsd:string Returned from the CleanseAddress process. If the user chooses not to use the modifications made to an address when a match is found, or if only the city, state, and ZIP Code are OK, the address may still be used to create an indicium by including the OverrideHash with the address.
EmailAddress Xsd:string The EmailAddress associated with this address. This is currently used in CreateIndicium and CreateUnfundedIndicium in To Address object when used with US-A-HFPU AddOn. In other cases, the EmailAddress is ignored.
FullAddress Xsd:string The FullAdress associated with this address.
CostCodeId xsd:int For internal use only. Integrations may ignore this value or pass in zero. Default is zero.

Mode
CreateIndiciumMode Normal
Sample
NoPostage
Preview
The manner in which the envelope image is created. Default is Normal.
ImageType
ImageType Auto
AZpl
BZpl
EncryptedPngUrl
Epl
Gif
Jpg
Pdf
PrintOncePdf
Png
Zpl
Bmp
BmpMonochrome
PngMonochrome
JpgMonochrome
GifMonochrome
Image type of shipping label. Default is Auto: which generates a Png image.
RateToken xsd:string This feature is for internal use only.
Memo xsd:string
maxLength=150
Caller defined data. Memo associated to this print.

CreateMailingLabelIndiciaResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 18:58:01 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <CreateMailingLabelIndiciaResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
            <Authenticator>***authenticator***</Authenticator>
            <StampsTxId>701f0bc7-a813-4809-9466-fa991e1abf1e</StampsTxId>
            <Url>https://swsim.testing.stamps.com/Label/mailinglabels.ashx/label-200.pdf?AQAAAMBygB0xidAI9x2wyIL-k7Ew9sBPA38YiNZI4LpGhti50onkT7XKvlx9pXWD</Url>
            <ConfirmationNumbers>
                <string />
            </ConfirmationNumbers>
            <PostageBalance>
                <AvailablePostage>####.##</AvailablePostage>
                <ControlTotal>####.##</ControlTotal>
            </PostageBalance>
            <IssuedLabelCount>1</IssuedLabelCount>
            <ErrorReason />
            <Mac>b0ovI0Bmsb5togznyjFznpmqYfQ=</Mac>
        </CreateMailingLabelIndiciaResponse>
    </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
StampsTxID xsd:string
maxLength=128
Stamps.com transaction identifier.
Url xsd:string A web addresses to the envelope image.
ConfirmationNumbers Array of xsd:string The confirmation number generated for each label. If the label does not have confirmation number, the corresponding element will be empty string.
PostageBalance PostageBalance New postage balance, including available postage and control total.
PostageBalance Object
Element Data Type Description
AvailablePostage xsd:decimal Current balance of available postage in the meter.
ControlTotal xsd:decimal Control total to be passed to PurchasePostage web method when purchasing additional postage.
IssuedLabelCount xsd:int The total number of generated labels. In general, this number should be same as the number of elements in IndiciumInfo in requests. If in case some errors occur during the middle of generation process, server will return the indicia that have already generated and terminate the process, which will cause this number to be less than requested.
ErrorReason xsd:string Description of the error if there is any.
Mac xsd:string For internal use only. Integrations may ignore this value.

GetCarrierPickupList

The GetCarrierPickupList Web Method is used to list the currently scheduled carrier pickups.

GetCarrierPickupList object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/SetCodeWords"
Content-Length: ####

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
   <soapenv:Header/>
   <soapenv:Body>
      <sws:GetCarrierPickupList>
         <sws:Credentials>             <sws:IntegrationID>XXX</sws:IntegrationID>
            <sws:Username>USER</sws:Username>
            <sws:Password>password</sws:Password>
         </sws:Credentials>
      </sws:GetCarrierPickupList>
   </soapenv:Body>
</soapenv:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.

GetCarrierPickupListResponse object

X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetCarrierPickupListResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
         <Authenticator>***authenticator***</Authenticator>
         <Pickups>
            <CarrierPickupInformation>
               <ConfirmationNumber>WTC199750252</ConfirmationNumber>
               <Carrier>Usps</Carrier>
               <PickupDate>2017-06-21T00:00:00</PickupDate>
               <PickUpDayOfWeek>Wednesday</PickUpDayOfWeek>
               <ContactInformation>
                  <FirstName>First</FirstName>
                  <LastName>Last</LastName>
                  <PhoneNumber>5555555555</PhoneNumber>
               </ContactInformation>
               <Address>
                  <Address>1990 Grand Ave</Address>
                  <City>El Segundo</City>
                  <State>CA</State>
                  <ZIP>90245</ZIP>
               </Address>
               <PackageInformation>
                  <NumberOfExpressMailPieces>1</NumberOfExpressMailPieces>
                  <NumberOfFirstClassPieces>4</NumberOfFirstClassPieces>
                  <NumberOfOtherPieces>6</NumberOfOtherPieces>
                  <TotalWeightOfPackagesLbs>30</TotalWeightOfPackagesLbs>
                  <PackageLocation>FrontDoor</PackageLocation>
                  <SpecialInstruction/>
               </PackageInformation>
            </CarrierPickupInformation>
         </Pickups>
      </GetCarrierPickupListResponse>
   </soap:Body> </soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Pickups Array of CarrierPickupInformation The list of pickups that have been scheduled for the authenticated user
CarrierPickupInformation Object

Element Data Type Description
ConfirmationNumber xsd:string The carrier pickup confirmation number provided by <CarrierPickupResponse>
Carrier
Carrier Usps
Dhl

Indicates the type of pickup to be requested. The only value we will currently support is USPS. Note that the default value when null is USPS.

PickupDate xsd:datetime

PickUpDayOfWeek xsd:string

ContactInformation CarrierPickupContactInformation

CarrierPickupContactInformation Object
Element Data Type Description
FirstName xsd:string The person's first name.
LastName xsd:string The person's last name.
PhoneNumber xsd:string The phone number associated with this pickup.
PhoneExt xsd:string The extension of the phone number associated with this pickup.

Address CarrierPickupAddress

CarrierPickupAddress Object
Element Data Type Description
Company xsd:string
maxLength=50
Company name.
Address xsd:string
maxLength=50
Street address.
SuiteOrApt xsd:string
maxLength=10
Suite or apartment number.
City xsd:string
maxLength=30
City name.
State xsd:string
maxLength=2
Two-character State name.
ZIP xsd:string
maxLength=5
Zip code.
ZIP4 xsd:string
maxLength=4
Zip-4 code.
PackageInformation CarrierPickupPackageInformation

CarrierPickupPackageInformation Object
Element Data Type Description
NumberOfExpressMailPieces xsd:int Number of Priority Mail Express pieces.
NumberOfPriorityMailPieces xsd:int Number of Priority Mail pieces.
NumberOfInternationalPieces xsd:int Number of International Mail pieces.
NumberOfFirstClassPackagePieces xsd:int Number of First Class Package Mail pieces.
NumberOfParcelSelectPieces xsd:int Number of Parcel Select Mail pieces.
NumberOfOtherPieces xsd:int Number of mail pieces not included in above categories.
TotalWeightOfPackagesLbs xsd:int

PackageLocation
CarrierPickupLocation FrontDoor
BackDoor
SideDoor
KnockOnDoorOrRingBell
MailRoom
Office
Reception
InOrAtMailbox
Other

Indicates where the packages are placed at pickup location.
SpecialInstruction xsd:string Special instructions about how to pick up the packages. Required if PackageLocation is set to Other.

GetSupportedCountries

The GetSupportedCountries method produces a list of countries that international mails can be sent to.

GetSupportedCountries object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: " http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/GetSupportedCountries"
Content-Length: ####

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
   <soapenv:Header/>
   <soapenv:Body>
      <sws:GetSupportedCountries>
   <sws:Authenticator>***authenticator***</sws:Authenticator>
      </sws:GetSupportedCountries>
   </soapenv:Body>
</soapenv:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.

GetSupportedCountriesResponse object

Server: Microsoft-IIS/5.1
Date: Fri, 29 Mar 2013 19:50:19 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetSupportedCountriesResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
         <Authenticator>***authenticator***</Authenticator>
         <CountryInfo>
            <CountryInfo>
               <Name>No Country</Name>
               <IsoCode>0</IsoCode>
            </CountryInfo>
            <CountryInfo>
               <Name>Andorra</Name>
              <IsoCode>AD</IsoCode>
            </CountryInfo>
            <CountryInfo>
               <Name>United Arab Emirates</Name>
               <IsoCode>AE</IsoCode>
            </CountryInfo><CountryInfo>
               <Name>Timor Leste</Name>
               <IsoCode>TL</IsoCode>
            </CountryInfo>
         </CountryInfo>
      </GetSupportedCountriesResponse>
   </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
CountryInfo Array of CountryInfo Collection of CountryInfo objects.
CountryInfo Object
Element Data Type Description
Name xsd:string Full name of the country.
IsoCode xsd:string The two-letter ISO code that can be put in ToCountry element in an international address.

ModifyCarrierPickup

The ModifyCarrierPickup Web Method is used to modify scheduled carrier pickups before they occur.

ModifyCarrierPickup object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/SetCodeWords"
Content-Length: ####

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
   <soapenv:Header/>
   <soapenv:Body>
      <sws:ModifyCarrierPickup>
         <sws:Credentials>
            <sws:IntegrationID>XXX</sws:IntegrationID>
            <sws:Username>USER</sws:Username>
            <sws:Password>password</sws:Password>
         </sws:Credentials>
         <sws:ContactInformation>
            <sws:FirstName>First</sws:FirstName>
            <sws:LastName>Last</sws:LastName>
            <sws:PhoneNumber>3105555555</sws:PhoneNumber>
         </sws:ContactInformation>
         <sws:ConfirmationNumber>WTC199750252</sws:ConfirmationNumber>
         <sws:Carrier>Usps</sws:Carrier>
      </sws:ModifyCarrierPickup>
   </soapenv:Body> </soapenv:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
CarrierPickupContactInformation `CarrierPickupContactInformation`
CarrierPickupContactInformation Object
Element Data Type Description
FirstName xsd:string The person's first name.
LastName xsd:string The person's last name.
PhoneNumber xsd:string The phone number associated with this pickup.
PhoneExt xsd:string The extension of the phone number associated with this pickup.

CarrierPickupAddress CarrierPickupAddress

CarrierPickupAddress Object
Element Data Type Description
Company xsd:string
maxLength=50
Company name.
Address xsd:string
maxLength=50
Street address.
SuiteOrApt xsd:string
maxLength=10
Suite or apartment number.
City xsd:string
maxLength=30
City name.
State xsd:string
maxLength=2
Two-character State name.
ZIP xsd:string
maxLength=5
Zip code.
ZIP4 xsd:string
maxLength=4
Zip-4 code.
CarrierPickupPackageInformation CarrierPickupPackageInformation

CarrierPickupPackageInformation Object
Element Data Type Description
NumberOfExpressMailPieces xsd:int Number of Priority Mail Express pieces.
NumberOfPriorityMailPieces xsd:int Number of Priority Mail pieces.
NumberOfInternationalPieces xsd:int Number of International Mail pieces.
NumberOfFirstClassPackagePieces xsd:int Number of First Class Package Mail pieces.
NumberOfParcelSelectPieces xsd:int Number of Parcel Select Mail pieces.
NumberOfOtherPieces xsd:int Number of mail pieces not included in above categories.
TotalWeightOfPackagesLbs xsd:int

PackageLocation
CarrierPickupLocation FrontDoor
BackDoor
SideDoor
KnockOnDoorOrRingBell
MailRoom
Office
Reception
InOrAtMailbox
Other

Indicates where the packages are placed at pickup location.
SpecialInstruction xsd:string Special instructions about how to pick up the packages. Required if PackageLocation is set to Other.
Carrier
Carrier Usps
Dhl

Indicates the type of pickup to be requested. The only value we will currently support is ‘USPS’. Note that the default value when null is ‘USPS’.
ConfirmationNumber xsd:string The carrier pickup confirmation number provided by CarrierPickupResponse.

ModifyCarrierPickupResponse object

X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ModifyCarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
         <Authenticator>***authenticator***</Authenticator>
         <PickupDate>06/21/2017</PickupDate>
         <PickUpDayOfWeek>Wednesday</PickUpDayOfWeek>
         <ConfirmationNumber>WTC199750252</ConfirmationNumber>
         <PickupStatus>Update successful</PickupStatus>
      </ModifyCarrierPickupResponse>
    </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
ErrorMsg xsd:string Error message if anything is wrong.
PickupDate xsd:date Pickup date.
PickUpDayOfWeek xsd:string Pickup day of week.
ConfirmationNumber xsd:string Confirmation number provided by USPS.

ScheduleCarrierPickup

ScheduleCarrierPickup object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/SetCodeWords"
Content-Length: ####

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
   <soapenv:Header/>
   <soapenv:Body>
      <sws:ScheduleCarrierPickup>
         <sws:Credentials>
            <sws:IntegrationID>XXX</sws:IntegrationID>
            <sws:Username>USER</sws:Username>
            <sws:Password>password</sws:Password>
         </sws:Credentials>
         <sws:ContactInformation>
            <sws:FirstName>First</sws:FirstName>
            <sws:LastName>Last</sws:LastName>
            <sws:PhoneNumber>5555555555</sws:PhoneNumber>
         </sws:ContactInformation>
         <sws:Address>
            <sws:Address>1990 Grand Ave</sws:Address>
            <sws:City>El Segundo</sws:City>
            <sws:State>CA</sws:State>
            <sws:ZIP>90245</sws:ZIP>
         </sws:Address>
         <sws:PackageInformation>
            <sws:NumberOfFirstClassPieces>4</sws:NumberOfFirstClassPieces>
            <sws:NumberOfOtherPieces>6</sws:NumberOfOtherPieces>
            <sws:TotalWeightOfPackagesLbs>9</sws:TotalWeightOfPackagesLbs>
            <sws:PackageLocation>FrontDoor</sws:PackageLocation>
         </sws:PackageInformation>
         <sws:Carrier>Usps</sws:Carrier>
      </sws:ScheduleCarrierPickup>    </soapenv:Body>
</soapenv:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
CarrierPickupContactInformation `CarrierPickupContactInformation`
CarrierPickupContactInformation Object
Element Data Type Description
FirstName xsd:string The person's first name.
LastName xsd:string The person's last name.
PhoneNumber xsd:string The phone number associated with this pickup.
PhoneExt xsd:string The extension of the phone number associated with this pickup.

CarrierPickupAddress CarrierPickupAddress

CarrierPickupAddress Object
Element Data Type Description
Company xsd:string
maxLength=50
Company name.
Address xsd:string
maxLength=50
Street address.
SuiteOrApt xsd:string
maxLength=10
Suite or apartment number.
City xsd:string
maxLength=30
City name.
State xsd:string
maxLength=2
Two-character State name.
ZIP xsd:string
maxLength=5
Zip code.
ZIP4 xsd:string
maxLength=4
Zip-4 code.
CarrierPickupPackageInformation CarrierPickupPackageInformation

CarrierPickupPackageInformation Object
Element Data Type Description
NumberOfExpressMailPieces xsd:int Number of Priority Mail Express pieces.
NumberOfPriorityMailPieces xsd:int Number of Priority Mail pieces.
NumberOfInternationalPieces xsd:int Number of International Mail pieces.
NumberOfFirstClassPackagePieces xsd:int Number of First Class Package Mail pieces.
NumberOfParcelSelectPieces xsd:int Number of Parcel Select Mail pieces.
NumberOfOtherPieces xsd:int Number of mail pieces not included in above categories.
TotalWeightOfPackagesLbs xsd:int

PackageLocation
CarrierPickupLocation FrontDoor
BackDoor
SideDoor
KnockOnDoorOrRingBell
MailRoom
Office
Reception
InOrAtMailbox
Other

Indicates where the packages are placed at pickup location.
SpecialInstruction xsd:string Special instructions about how to pick up the packages. Required if PackageLocation is set to Other.
Carrier
Carrier Usps
Dhl

Indicates the type of pickup to be requested. The only value we will currently support is ‘USPS’. Note that the default value when null is ‘USPS’.

ScheduleCarrierPickupResponse object

X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ScheduleCarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2018/03/swsim/swsimv71">
         <Authenticator>***authenticator***</Authenticator>
         <PickupDate>06/21/2017</PickupDate>
         <PickUpDayOfWeek>Wednesday</PickUpDayOfWeek>
         <ConfirmationNumber>WTC199744224</ConfirmationNumber>
      </ScheduleCarrierPickupResponse>
   </soap:Body> </soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
ErrorMsg xsd:string Error message if anything is wrong.
PickupDate xsd:date Pickup date.
PickUpDayOfWeek xsd:string Pickup day of week.
ConfirmationNumber xsd:string Confirmation number provided by USPS.

GetCodewordQuestions

The GetCodewordQuestions web method is used to get the codeword questions to ask the user in order to start the password reset process with the StartPasswordReset web method. If the user indicates to the integration that they have forgotten their password, the integration should call this web method to get two questions to ask the user. The answer to these questions is required in order to reset the password to a temporary password and have that temporary password sent to the user by e-mail.

GetCodewordQuestions object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/GetCodewordQuestions"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:GetCodewordQuestions>
      <tns:Username>test</tns:Username>
    </tns:GetCodewordQuestions>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Username xsd:string
maxLength=40
Username of the user who has forgotten their password.
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration. Required only for reseller integrations.

GetCodewordQuestionsResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 20:11:45 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetCodewordQuestionsResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      <Codeword1Question>What is your mother's maiden name?</Codeword1Question>
      <Codeword2Question>What are the last four digits of your SSN?</Codeword2Question>
    </GetCodewordQuestionsResponse>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Codeword1Question xsd:string First codeword question (e.g., "What is your mother's maiden name?").
Codeword2Question xsd:string Second codeword question (e.g., " What is your pet’s name?").

RecoverUsername

The RecoverUsername web method is used to retrieve the user name if a user accidentally forgets it. Caller needs to provide the email address that matches the one stored in the account. An email with the user name will be sent to that email address. This web method does not require authentication.

RecoverUsername object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/RecoverUsername"
Content-Length: ####

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
   <soapenv:Header/>
   <soapenv:Body>
      <sws:RecoverUsername>
         <sws:EmailAddress>test@stamps.com</sws:EmailAddress>
      </sws:RecoverUsername>
   </soapenv:Body>
</soapenv:Envelope>

Element Data Type Description
EmailAddress xsd:string Email address of the account. An email with user name will be sent to this address.

RecoverUsernameResponse object

HTTP 200
Date: Wed, 02 Sep 2009 23:06:40 GMT
Server: Microsoft-IIS/6.0
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <RecoverUsernameResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
      </RecoverUsernameResponse>
   </soap:Body>
</soap:Envelope>

This object contains no elements.

SetCodeWords

The SetCodeWords Web Method is used to set security questions and answers with valid credentials or a valid authenticator token. Questions and answers will be validated by the system.

SetCodeWords object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/SetCodeWords"
Content-Length: ####

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sws=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
   <soapenv:Header/>
   <soapenv:Body>
      <sws:SetCodeWords>
         <sws:Credentials>
            <sws:IntegrationID>XXX</sws:IntegrationID>
            <sws:Username>USER</sws:Username>
            <sws:Password>password</sws:Password>
         </sws:Credentials>
         <sws:Codeword1Type>MothersMaidenName</sws:Codeword1Type>
         <sws:Codeword1>Smith</sws:Codeword1>
         <sws:Codeword2Type>PetsName</sws:Codeword2Type>
         <sws:Codeword2>Fido</sws:Codeword2>
      </sws:SetCodeWords>
   </soapenv:Body>
</soapenv:Envelope>

Element Data Type Description
Credentials Credentials Container for credentials used to authenticate a user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Credentials Object
Element Data Type Description
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.
Username xsd:string
maxLength=40
Username of user logging in or for whom the web method is being called.
Password xsd:string Password of user.

Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Codeword1Type
CodewordType MothersMaidenName
PetsName
BirthCity
HighSchoolMascot
FathersBirthplace
StreetName
FirstSchoolsName
FirstCarsMakeModel
Last4SocialSecurityNumber
Last4DriversLicense
First codeword type. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support. The first and second codeword types must be different.
Codeword1 xsd:string
minLength=2
maxLength=33
First codeword. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support.
Codeword2Type
CodewordType MothersMaidenName
PetsName
BirthCity
HighSchoolMascot
FathersBirthplace
StreetName
FirstSchoolsName
FirstCarsMakeModel
Last4SocialSecurityNumber
Last4DriversLicense
Second codeword type. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support. The first and second codeword types must be different.
Codeword2 xsd:string
minLength=2
maxLength=33
Second codeword. Every account has two codewords associated with it that are used during password recovery and when identifying oneself for customer support.

SetCodeWordsResponse object

X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SetCodeWordsResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
         <Authenticator>***authenticator***</Authenticator>
      </SetCodeWordsResponse>
   </soap:Body>
</soap:Envelope>

Element Data Type Description
Authenticator xsd:string An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.

StartPasswordReset

The StartPasswordReset web method is used to start a password reset process when the user indicates that they have forgotten their password. The integration must call the GetCodewordQuestions web method and ask the user the returned questions. With those answers, the integration can call StartPasswordReset, and if the codeword answers are correct, a temporary password will be sent to the user by e-mail.

StartPasswordReset object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/StartPasswordReset"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:StartPasswordReset>
      <tns:Username>test</tns:Username>
      <tns:Codeword1>Smith</tns:Codeword1>
      <tns:Codeword2>1111</tns:Codeword2>
    </tns:StartPasswordReset>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Username xsd:string
maxLength=40
An opaque string obtained in the response of the previous web method call used to authenticate the user. Only one of Credentials or Authenticator is allowed, and Authenticator is preferred.
Codeword1 xsd:string
maxLength=40
Answer to first codeword question.
Codeword2 xsd:string
maxLength=40
Answer to second codeword question.
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration.

StartPasswordResetResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 20:17:42 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <StartPasswordResetResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71” />
  </soap:Body>
</soap:Envelope>


This object contains no elements.

FinishPasswordReset

The FinishPasswordReset web method is used to complete the password reset process that was started with StartPasswordReset. When AuthenticateUser or any other web method returns error 0x002b0605, it indicates that the supplied Credentials object contained a valid temporary password for the user. The integration must at that point prompt the user for a new password and complete the password reset process with the FinishPasswordReset web method.

The integration should prompt the user to enter the password twice using an input field that masks the password. The integration should verify that the same password is entered both times.

Unlike other web methods, this web method does not return an Authenticator string. After the password reset is finished, a new session should be started with the new password via the AuthenticateUser web method.

FinishPasswordReset object

User-Agent: Crosscheck Networks SOAPSonar
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://stamps.com/xml/namespace/2018/03/swsim/swsimv71/FinishPasswordReset"
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:tns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71”>
  <soap:Body>
    <tns:FinishPasswordReset>
      <tns:Username>test</tns:Username>
      <tns:TempPassword>***temppassword***</tns:TempPassword>
      <tns:NewPassword>password1</tns:NewPassword>
    </tns:FinishPasswordReset>
  </soap:Body>
</soap:Envelope>

Element Data Type Description
Username xsd:string
maxLength=40
Username of user completing the password reset process.
TempPassword xsd:string Temporary password obtained from user, who in turn received it via e-mail from StartPasswordReset web method.
NewPassword xsd:string
maxLength=20
New password. Integrator should ask for password twice in a field that does not display its text to the user and validate user entered it the same both times. Password must be between 6 and 20 characters and contain at least one letter and one number.
IntegrationID xsd:string
maxLength=128
Stamps.com-assigned integration ID. This value is given to the integrator when licensed to create an integration. Required only for reseller integrations.

FinishPasswordResetResponse object

HTTP 200
Server: Microsoft-IIS/5.1
Date: Mon, 31 Aug 2009 20:17:42 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 2.0.50727
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: ####

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <FinishPasswordResetResponse xmlns=“http://stamps.com/xml/namespace/2018/03/swsim/swsimv71” />
  </soap:Body>
</soap:Envelope>

This object contains no elements.

Appendices

VERSION NOTES

The specifications in this document refer to the latest version of SWS/IM, Version 51. Care has been taken to ensure that integrators using earlier versions of the SWS/IM interface are not affected by new features that are added to SWS/IM over time. However, in rare cases, based on feedback from integrators or the United States Postal Service, it is necessary to change the underlying behavior of certain web methods from their behavior in earlier versions. An enumeration of such changes follows in this Appendix. Note: For more information on new features available for SWS/IM or to suggest enhancements to SWS/IM, please contact your account representative.

<CustomsLine> Elements

SWS/IM calculates customs lines on a by-item basis. A Quantity of 2 items with a WeightOz of 9.0 and a Value of $40 would be shown on the international label as having a weight of 1 lb 2 oz. and a value of $80. methodology applies to both international labels and customs forms produced for APO/FPO addresses. Note that in ALL interfaces, the rated weight of the package is based on the WeightLb and WeightOz provided in the object, not the WeightLb and WeightOz provided in the object. The object values are used for display purposes on the forms only.

ServiceType US-PP

From Version 26 US-PP is no longer supported as a service type and is replaced with US-PS (Parcel Select). For version 25 and below US-PP will be translated to a US-PS service type.

AddOn US-A-WDS

Waive Delivery Signature addon is depcreated from SWS/IM Version 26 onwards. This has been done in accordance with USPS requirement of making Signature requirement for Priority Mail Express the default option. Developer can use the new US-A-SR addon to indicate that Signature is required for delivery of an Priority Mail Express item. Signature required is the default for legacy interfaces up to Version 25.

The value specified will determine the format of the label image that is generated by the CreateIndicium web method or the envelope image that is generated by the CreateEnvelopeIndicium web method Available options are:

Stamps.com Certified Mail form SDC-3510, SDC-3520, SDC-3530, SDC-3610, SDC-3710, SDC-3810, SDC-3820 and SDC-3910. ( See Appendix G – Best Practices to Print on Certified Mail Forms )

Envelope PrintLayouts suppored by CreateEnvelopeIndicium include:

Notes:

[1] This option is for APO/FPO addresses only.

[2] Those layouts contain multiple labels per sheet. Integrators can add a switch to the label URL to control the position a label is rendered. For example, https://host/Label/label.ashx/label-200-p1,3.png?xxxxxxxx, where -p1,3 indicates the label will be rendered at the first row,third column on the sheet.

[3] Starting from SWSIM v42, for those layouts, if the destination country is Australia, Canada, or Costa Rica, a single ply PS Form 2976-A CP72 (Standard) will be generated.

[4] Starting from SWSIM v50, Customs Forms will conform to USPS Guidelines for Privately Printed Customs Declaration Forms, version v1.0, March 31, 2015

[5] Starting from SWSIM v50, PrintLayout values containing CP72 (e.g., Normal6X4CP72) will result in a CP72, and PrintLayout values containing CN22 (e.g., Normal6X4CN22) will result in a CN22, where possible. If Customs information is included in the request, then where PrintLayout values do not contain a CN22 or CP72 designation (e.g., Normal4x6), a CN22 will be returned, unless a CP72 is required per USPS rules.

BEST PRACTICES TO PRINT ON CERTIFIED MAIL FORMS

Certified Mail forms are generated in letter size (8.5x11) and are printed on pre-printed labels of the same size. Most consumer type printers (laser and ink jet) cannot print edge to edge. There is a unprintable margin around the paper. The printable area is smaller than the paper size. Also, the margins and printable area will vary from printer to printer (and driver to driver). In cases such as this, the full size image must either be scaled into the printable area or part of the image clipped. Scaling the image into a unknown printable area with unknown margins would be a problem. Items would be incorrectly placed and content could be oddly scaled. The only option is to offset the image on the paper so the upper left of the image is at the top left of the paper. In addition, the image is printed un-scaled. This results in part of the image being clipped, the parts that are in the unprintable area of the printer. The pre-printed certified labels have been designed with this in mind. The closest content is about 1/4" from the left/right edge. Top and bottom have about 1/2". To offset and clip should be fine.

BEST PRACTICES TO PRINT EPL/ZPL

Starting with swsimv37 there are 2 new ImageType's. AZpl and BZpl. AZpl generates ZPL with the binary data encoded as ASCII characters. BZpl generates ZPL with the binary data encoded as binary data. Zpl and BZpl are equivalent. Existing Zpl behavior are unchanged. The default behavior before swsimv37 is the same as BZpl. The is no EPL equivalent to AZpl/BZpl.

ImageType BZpl, Epl, and Zpl

The EPL/ZPL data generated by a Stamps.com URL or ImageData returned in a CreateIndiciumResponse using ImageType BZpl or Zpl must be retrieved and sent to the printer without modification in either step. The EPL/ZPL data is printer specific code to draw the label. It must not be printed using the "Normal" printing methods. Instead the data must be sent directly to the printer (example link for Windows OS's follows). The EPL/ZPL data may contain binary data with bytes outside the normal printable ASCII range. It should not be treated as if it were ASCII text, instead, it should be treated as binary. Code that treats the EPL/ZPL as ASCII text will often interpret non-printable characters as if they were UNICODE. The resulting labels will often contain readable text, but the barcodes and images will be distorted. USPS may reject such labels. The following Microsoft web page has example code on how to send binary data to a printer; http://support.microsoft.com/kb/322091. The example function RawPrinterHelper.SendFileToPrinter(PrinterName, LabelPath)will correctly send EPL/ZPL data from a file to the printer.

ImageType AZpl

AZpl may make it easier to avoid problems saving and printing the ZPL data. However, the ZPL data should still be treated as if it were binary and should not be modified.

INTERNATIONAL ADDRESS CLEANSING

This feature is not available for all integrations. Domestic Address Cleansing is available for all integrators and AddressCleansingResult will be populated as per below possible results based on the conditions for domestic address. For internationa address, AddressCleansingResult will be returned with the result such as below. Please contact Stamps.com directly for more information about how to enable this feature for your integration.

Domestic

Condition Text to return
Z4 ReturnCode = 10 “City, State, and Zip are valid, but the Street could not be verified.”
Z4 ReturnCode = 11 “City, State, or Zip is invalid. The address provided cannot be shipped to.”
Z4 ReturnCode = 12 “The State could not be verified. The address provided cannot be shipped to.”
Z4 ReturnCode = 13 “The City could not be verified. The address provided cannot be shipped to.”
Z4 ReturnCode = 21 and CandidateAddress is null “City, State, and Zip are valid, but the Street could not be verified.”
Z4 ReturnCode = 22 and CandidateAddress is null “Street, City, State, and Zip are valid, but the Street Number could not be verified.”
CandidateAddress is not null AND Z4 Footnote = H “Street Address, City, State, and Zip are valid, but a suite or apt number may be missing.”
CandidateAddress is not null AND Z4 Footnote is not H “Street, City, State, and Zip are valid, but the Street Number could not be verified.”
Z4 ReturnCode = 31 “Full Address Verified.”
Z4 ReturnCode = 32 “City, State, and Zip are valid, but address information may be missing.”

International

Condition Text to return
AE Code = AE01 OR there are no AV Codes returned “The Address provided could not be verified.”
AV Code = AV11 OR AV 21; AND AE Code is not AE01 “Province and Postal Code are valid, but City and Street could not be verified.”
AV Code = AV12 OR AV 22; AND AE Code is not AE01 “City, Province, and Postal Code are valid, but the Street could not be verified.”
AV Code = AV13 OR AV 23; AND AE Code is not AE01 “Street, City, Province, and Postal Code are valid, but the Street Number could not be verified.”
AV Code = AV 14; AND AE Code is not AE01 “Street Address, City, Province, and Postal Code are valid, but a suite or apt number may be missing.”
AV Code = AV24 OR AV25; AND AE Code is not AE01 “Full Address Verified.”
If this is not enabled for the integrator “To Country Verified.”