USPSAccount Type

Represents the details of a USPS account.

Remarks

This type contains data describing the USPS server and login information.

Example: Setting the fields of an account

USPSAccount account = new USPSAccount
account.Server = "http://production.shippingapis.com";
account.Password = "my_password";
account.UserId = "my_username";

The fields contained by this type are listed below.

Fields

AccountNumber
String

The shipper's Endicia account number.

This field describes the shipper's Account Id, and is only valid when the PostageProvider is set to ppEndicia.

Password
String

Password to use for logging in to the USPS Server.

This password is provided to you by USPS when you register for service. The password is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Note, the Password property has been depreciated by USPS, and remains only for backwards compatibility.

When PostageProvider has been set to ppEndicia, this must be the pass phrase associated with your postage account that was supplied to you by Endicia upon registration.

Server
String

URL for the USPS server where the requests are sent.

There are two different live and test URLs that have been provided by the US Postal service for use with the Webtools APIs (and these beans). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the beans that use them.

Live Servers:


Server	Used by
http://production.shippingapis.com/ShippingAPI.dll	USPSAddress, USPSRates, and USPSTrack
https://secure.shippingapis.com/ShippingAPI.dll	USPSShip and USPSShipIntl

Test Servers:


Server	Used by
http://testing.shippingapis.com/ShippingAPITest.dll	USPSAddress, USPSRates, and USPSTrack
https://secure.shippingapis.com/ShippingAPITest.dll	USPSShip and USPSShipIntl

These test servers return CANNED RESPONSES. They will only accept a specific set of data, and will only return one pre-formed response. Any transaction that does not contain the exact data they expect will cause an error to be generated. Because of these limitations we strongly recommend you test using a live account.

Note that the label components must use the live server for testing, but with the Certify configuration setting set to True.

When PostageProvider has been set to ppEndicia, the live production URL is "https://labelserver.endicia.com/LabelService/EwsLabelService.asmx".

UserId
String

User Id for logging in to the USPS Server.

This User Id is provided to you by USPS when you register for service. The UserId is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

When PostageProvider has been set to ppEndicia, this must be the Requester Id (also called the Partner Id) associated with your postage account that was supplied to you by Endicia upon registration.

Constructors

public USPSAccount();