USPSShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode. Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS International Label API lets customers generate eVS labels with integrated customs declaration forms.

Syntax

dshippingsdk.Uspsshipintl

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Return Shipment, etc.), and any other specific information on international shipments.

Postage Provider Notes

ppNone

When using USPS as the PostageProvider (i.e. ppNone) you will need to...

• Set PostageProvider to ppNone (default).
• Set UserId to the UserId provided by USPS.
• Set Password to the password provided by USPS.
• Set Server to either the test or production server.

ppEndicia

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set PostageProvider to ppEndicia.
• Set AccountNumber to your production account number (provided by Endicia).
• Set Password to your production password (provided by Endicia).

Testing

The components come with a built in sandbox account for your use. To use that account with the components...

• Set PostageProvider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

In all cases the class will send requests to the correct server without setting Server.

ppStamps

When using Stamps.com as the PostageProvider you will need to...

• Set PostageProvider to ppStamps.
• Set UserId to the sandbox or production user provided by Stamps.com.
• Set AccountNumber to the sandbox or production account number provided by Stamps.com.
• Set Password to the sandbox or production password provided by Stamps.com.
• Set Server to either the test or production server.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

BarcodeNumber Property (USPSShipIntl Class)

Barcode number associated with label's barcode.

Syntax

public String getBarcodeNumber();

Default Value

""

Remarks

The value of this property is filled after a call to the GetPackageLabel method when using the eVS Label API (in other words PostageProvider is set to ppNone).

This property is read-only.

CertificateNumber Property (USPSShipIntl Class)

Certificate number (if known or included in the package).

Syntax

public String getCertificateNumber();


public void setCertificateNumber(String certificateNumber);

Default Value

""

Remarks

Some countries require a Certificate of Origin in order for certain items to be imported. (for example, fruits and vegetables). Restrictions as to what items require a Certificate Of Origin are returned in the Restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

Comments Property (USPSShipIntl Class)

Comments on the package being shipped.

Syntax

public String getComments();


public void setComments(String comments);

Default Value

""

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

Commodities Property (USPSShipIntl Class)

Items being shipped inside this package.

Syntax

public CommodityDetailList getCommodities();


public void setCommodities(CommodityDetailList commodities);

Remarks

This property should be set to the commodity types that are inside the package. Each commodity has a Description, HarmonizedCode, Manufacturer, Quantity, UnitPrice, and Weight.

For instance, to send a package containing 20 wheel bearings and 15 fork seals: class.Commodities.Add(new CommodityDetail()); class.Commodities.Add(new CommodityDetail()); class.Commodities[0].Description = "Wheel bearings"; class.Commodities[0].Quantity = 20; class.Commodities[0].Value = "100.00"; // 20 bearings at $5 each class.Commodities[0].Weight = "10 lbs 0 oz"; // each wheel bearing is .5 lbs class.Commodities[1].Description = "Fork seals"; class.Commodities[1].Quantity = 15; class.Commodities[1].Value = "375.00"; // 15 seals at $25 each class.Commodities[1].Weight = "3 lbs 8 oz"; // Total weight of all fork seals in the package.

Please note that Manufacturer and HarmonizedCode are only valid for commercial shippers, and may be left out. The remaining fields are all required.

This property is not available at design time.

Please refer to the CommodityDetail type for a complete list of fields.

Contents Property (USPSShipIntl Class)

Type of the contents in the package.

Syntax

public int getContents();


public void setContents(int contents);


Enumerated values:
  public final static int ctSample = 0;
  public final static int ctGift = 1;
  public final static int ctDocuments = 2;
  public final static int ctReturn = 3;
  public final static int ctOther = 4;
  public final static int ctMerchandise = 5;
  public final static int ctHumanitarianDonation = 6;
  public final static int ctDangerousGoods = 7;
  public final static int ctCrematedRemains = 8;
  public final static int ctNonNegotiableDocument = 9;
  public final static int ctPharmaceuticals = 10;
  public final static int ctMedicalSupplies = 11;
  public final static int ctHAZMAT = 12;
  public final static int ctLives = 13;
  public final static int ctPerishable = 14;

Default Value

0

Remarks

You can set this property when generating labels to indicate the content type in the package.

Possible values are as follows:

Note that if Contents is set to ctOther, you may be required to set the OtherContents configuration setting with a description of the contents. For example:

class.Contents = ctOther class.Config("OtherContents=Livestock")

CustomerId Property (USPSShipIntl Class)

User-assigned number for internal use.

Syntax

public String getCustomerId();


public void setCustomerId(String customerId);

Default Value

""

Remarks

You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.

Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.

For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.

ExtraServices Property (USPSShipIntl Class)

Contains the collection of extra services offered by USPS on shipment level.

Syntax

public long getExtraServices();


public void setExtraServices(long extraServices);

Default Value

0

Remarks

To request any of the extra services offered by USPS, you must set the ExtraServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

Firewall Property (USPSShipIntl Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

ImageLayout Property (USPSShipIntl Class)

Determines how the labels will be formatted for printing.

Syntax

public int getImageLayout();


public void setImageLayout(int imageLayout);


Enumerated values:
  public final static int ilOnePerFile = 0;
  public final static int ilAllInOneFile = 1;
  public final static int ilTrimOnePerFile = 2;
  public final static int ilTrimAllInOneFile = 3;

Default Value

0

Remarks

The LabelImageType property indicates the file type of the label that USPS returns. ImageLayout dictates how the label looks in that file. The labels returned by USPS measure 8.5" x 5.5", or exactly one half of a sheet of regular 8.5" x 11" paper. The layouts available are listed below:

For the ilAllInOneFile and ilTrimAllInOneFile ImageLayouts, only one file will be written. However, for the ilOnePerFile and ilTrimOnePerFile ImageLayouts, more than one shipping label may be returned, up to a maximum of 6 total pages. If ShippingLabelFile is specified, these additional pages will be saved with the page number appended to the ShippingLabelFile you supplied.

For instance, if the ShippingLabelFile is "c:\expresslabel.pdf", the following files will be created: "expresslabel.pdf", "expresslabel.page2.pdf", "expresslabel.page3.pdf", etcetera.

Note that for the stUSPSFirstClass ServiceType, only ilOnePerFile and ilAllInOneFile are supported. Using any of the Trim-values will result in an error from USPS.

ImportersContact Property (USPSShipIntl Class)

Identifies the importer's contact info.

Syntax

public ContactDetail getImportersContact();


public void setImportersContact(ContactDetail importersContact);

Remarks

The ImportersContact represents contact data identifying the importer. It can be provided in an international ship request only when the ServiceType is stUSPSExpressMailInternational (82) or stUSPSPriorityMailInternational (84).

The only necessary fields to be set for this type are the Email, Fax, and Phone.

This must be set to an instance of the ContactDetail type. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

IndemnityCoverage Property (USPSShipIntl Class)

Indicates the indemnity coverage for the package.

Syntax

public String getIndemnityCoverage();

Default Value

""

Remarks

This property is returned only for International Priority Mail packages, and only when the InsuredValue property was set to an amount greater than "0.00".

This property is read-only.

InsurancePolicy Property (USPSShipIntl Class)

Insurance number, if known.

Syntax

public String getInsurancePolicy();


public void setInsurancePolicy(String insurancePolicy);

Default Value

""

Remarks

If insurance has been purchased, this property should be set to the policy number.

This property is not applicable for International First Class mail.

InvoiceNumber Property (USPSShipIntl Class)

Invoice number if known or included in the package.

Syntax

public String getInvoiceNumber();


public void setInvoiceNumber(String invoiceNumber);

Default Value

""

Remarks

This property may contain an invoice number if it is known or included in the package. Maximum length is 24 characters. This property is ignored when PackagingType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

LabelImageType Property (USPSShipIntl Class)

Type of label image.

Syntax

public int getLabelImageType();


public void setLabelImageType(int labelImageType);


Enumerated values:
  public final static int sitNone = 0;
  public final static int sitTIF = 1;
  public final static int sitJPG = 2;
  public final static int sitPDF = 3;
  public final static int sitGIF = 4;
  public final static int sitEPL = 5;
  public final static int sitPNG = 6;
  public final static int sitZPL = 7;
  public final static int sitPDFVector = 8;
  public final static int sitPDFVectorWithFonts = 9;
  public final static int sitAZPL = 10;

Default Value

0

Remarks

The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:

Valid values for USPS (eVSLabels):

• sitTIF (1)
• sitPDF (3)

Valid values for Endicia:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitPDFVector (8)
• sitPDFVectorWithFonts (9)

Valid values for Stamps.com:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitAZPL (10)

LicenseNumber Property (USPSShipIntl Class)

Import License number if known, or included in package.

Syntax

public String getLicenseNumber();


public void setLicenseNumber(String licenseNumber);

Default Value

""

Remarks

Many countries require the sender to obtain a license in order to import certain items (for example, drugs or medical equipment). Restrictions as to what items require a license are returned in the Restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

Machinable Property (USPSShipIntl Class)

Indicates if shipment is machinable or not.

Syntax

public int getMachinable();


public void setMachinable(int machinable);


Enumerated values:
  public final static int moTrue = 0;
  public final static int moFalse = 1;
  public final static int moIrregular = 2;

Default Value

0

Remarks

The default value for this property is moTrue (0).

Note: The value moIrregular (2) is valid only when ServiceType is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).

Possible values are as follows:

MailingLocation Property (USPSShipIntl Class)

Postal Office Zip Code where the item will be mailed (if different from ZipCode ).

Syntax

public String getMailingLocation();


public void setMailingLocation(String mailingLocation);

Default Value

""

Remarks

The value of this property is optional.

If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (ZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

This way, you convey this difference to the USPS Server.

This property is not applicable for International First Class mail.

NonDeliveryOption Property (USPSShipIntl Class)

Indicates what to do with the package in case it is undeliverable.

Syntax

public int getNonDeliveryOption();


public void setNonDeliveryOption(int nonDeliveryOption);


Enumerated values:
  public final static int ndoReturn = 0;
  public final static int ndoRedirect = 1;
  public final static int ndoAbandon = 2;

Default Value

0

Remarks

In case the package is undeliverable, the package may be Returned, Redirected, or Abandoned.

This property is not applicable for International First Class mail (stUSPSFirstClassMailInternational (83) ).

Notes Property (USPSShipIntl Class)

Additional information returned by the USPS Server .

Syntax

public String getNotes();

Default Value

""

Remarks

This property may contain additional notes pertaining to the shipment of goods to the destination country (CountryCode).

This property is read-only.

Observations Property (USPSShipIntl Class)

Additional mailing information based on country of destination.

Syntax

public String getObservations();

Default Value

""

Remarks

Additional information that may be important to the sender. Returned by the USPS Server

This property is read-only.

Packages Property (USPSShipIntl Class)

A collection of packages contained in the shipment.

Syntax

public PackageDetailList getPackages();


public void setPackages(PackageDetailList packages);

Remarks

At least one package must be specified.

This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.

For USPS, the PackagingType, Size, and Weight fields are required. Length, Width, Height, and Girth are all conditionally required, and more information may be found in the individual field definitions.

Note: USPS only supports one package per shipment.

This property is not available at design time.

Please refer to the PackageDetail type for a complete list of fields.

PermitNumber Property (USPSShipIntl Class)

Permit number to print Postage Due labels.

Syntax

public String getPermitNumber();


public void setPermitNumber(String permitNumber);

Default Value

""

Remarks

Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.

PostageProvider Property (USPSShipIntl Class)

The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.

Syntax

public int getPostageProvider();


public void setPostageProvider(int postageProvider);


Enumerated values:
  public final static int ppNone = 0;
  public final static int ppEndicia = 1;
  public final static int ppStamps = 2;

Default Value

0

Remarks

When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.

• Set UserId
• Set Password
• Set Server

When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.

For Production

• Set AccountNumber
• Set Password

For Testing

• Set EndiciaTestMode

When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.

• Set UserId
• Set AccountNumber
• Set Password
• Set Server

PriceOption Property (USPSShipIntl Class)

Indicates pricing that should be returned (i.e. Commercial Base).

Syntax

public int getPriceOption();


public void setPriceOption(int priceOption);


Enumerated values:
  public final static int poRetail = 0;
  public final static int poCommercialPlus = 1;
  public final static int poCommercialBase = 2;

Default Value

2

Remarks

The default value for this property is poCommercialBase (2).

Note: When ServiceType is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).

Note: The value poRetail (0) is valid only when ServiceType is stUSPSPriorityMailInternational (84).

Possible values are as follows:

Prohibitions Property (USPSShipIntl Class)

List of items prohibited from mailing to the destination country.

Syntax

public String getProhibitions();

Default Value

""

Remarks

Articles that are prohibited by the destination country are non-mailable. These prohibitions are based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific prohibitions as a country may return or seize mail containing articles prohibited within that country, whether or not notice of such prohibitions has been provided to or published by the Postal Service.

This property is read-only.

Proxy Property (USPSShipIntl Class)

This property includes a set of properties related to proxy access.

Syntax

public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

RecipientAddress Property (USPSShipIntl Class)

Identifies the recipient's address.

Syntax

public AddressDetail getRecipientAddress();


public void setRecipientAddress(AddressDetail recipientAddress);

Remarks

The RecipientAddress is required to be provided in a ship request.

This must be set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.

Please refer to the AddressDetail type for a complete list of fields.

RecipientContact Property (USPSShipIntl Class)

Identifies the recipient's contact info.

Syntax

public ContactDetail getRecipientContact();


public void setRecipientContact(ContactDetail recipientContact);

Remarks

The RecipientContact is required to be provided in a ship request.

The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

RecipientCustomsReference Property (USPSShipIntl Class)

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

public String getRecipientCustomsReference();


public void setRecipientCustomsReference(String recipientCustomsReference);

Default Value

""

Remarks

This field may contain any reference number that the person wishes to use.

Regulations Property (USPSShipIntl Class)

Additional regulations for shipping to the destination country.

Syntax

public String getRegulations();

Default Value

""

Remarks

Any additional regulations not covered under Restrictions, Observations, or Prohibitions will be listed here after a successful transaction. The returned data might include information such as: country code, required Customs Forms, special notes when shipping certain items, areas served, etc.

This property is read-only.

Restrictions Property (USPSShipIntl Class)

Restrictions on items being shipped based on country of destination.

Syntax

public String getRestrictions();

Default Value

""

Remarks

This property will contain information indicating mail articles which are restricted by the destination country, Any packages sent are subject to the import requirements of that country. The contents of this property is based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific restrictions as a country may return or seize mail containing articles prohibited or restricted within that country, whether or not notice of such restriction has been provided to or published by the Postal Service.

This property is read-only.

SDRValue Property (USPSShipIntl Class)

Special Drawing Right calculated on TotalValue .

Syntax

public String getSDRValue();

Default Value

""

Remarks

The Special Drawing Right (SDR) is an artificial currency unit based on a collection of major world currencies. The SDRValue is the calculated TotalValue in this artificial currency.

This property is read-only.

SenderAddress Property (USPSShipIntl Class)

Identifies the sender's address.

Syntax

public AddressDetail getSenderAddress();


public void setSenderAddress(AddressDetail senderAddress);

Remarks

The SenderAddress is required to be provided in a ship request when the GetPackageLabel method is called.

This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.

Please refer to the AddressDetail type for a complete list of fields.

SenderContact Property (USPSShipIntl Class)

Identifies the sender's contact info.

Syntax

public ContactDetail getSenderContact();


public void setSenderContact(ContactDetail senderContact);

Remarks

The SenderContact is required to be provided in a ship request, when the GetPackageLabel method is called.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

SenderCustomsReference Property (USPSShipIntl Class)

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

public String getSenderCustomsReference();


public void setSenderCustomsReference(String senderCustomsReference);

Default Value

""

Remarks

This field may contain any reference number that the person wishes to use.

ServiceType Property (USPSShipIntl Class)

The mail service type when shipping to the CountryCode .

Syntax

public int getServiceType();


public void setServiceType(int serviceType);


Enumerated values:
  public final static int stUnspecified = 0;
  public final static int stFedExPriorityOvernight = 10;
  public final static int stFedExStandardOvernight = 11;
  public final static int stFedExFirstOvernight = 12;
  public final static int stFedEx2Day = 13;
  public final static int stFedExExpressSaver = 14;
  public final static int stFedExGround = 15;
  public final static int stFedExGroundHomeDelivery = 16;
  public final static int stFedEx1DayFreight = 17;
  public final static int stFedEx2DayFreight = 18;
  public final static int stFedEx3DayFreight = 19;
  public final static int stFedExInternationalPriority = 20;
  public final static int stFedExInternationalEconomy = 21;
  public final static int stFedExInternationalFirst = 22;
  public final static int stFedExInternationalPriorityFreight = 23;
  public final static int stFedExInternationalEconomyFreight = 24;
  public final static int stFedExEuropeFirstInternationalPriority = 25;
  public final static int stFedExSmartPost = 26;
  public final static int stFedEx2DayAM = 27;
  public final static int stFedExFirstFreight = 28;
  public final static int stFedExInternationalGround = 29;
  public final static int stFedExFreightEconomy = 30;
  public final static int stFedExFreightPriority = 31;
  public final static int stFedExInternationalPriorityExpress = 32;
  public final static int stFedExInternationalConnectPlus = 33;
  public final static int stUPSFirstClass = 35;
  public final static int stUPSPriorityMail = 36;
  public final static int stUPSExpeditedMailInnovations = 37;
  public final static int stUPSPriorityMailInnovations = 38;
  public final static int stUPSEconomyMailInnovations = 39;
  public final static int stUPSNextDayAir = 40;
  public final static int stUPSExpress = 41;
  public final static int stUPS2ndDayAir = 42;
  public final static int stUPSGround = 43;
  public final static int stUPSWorldwideExpress = 44;
  public final static int stUPSWorldwideExpedited = 45;
  public final static int stUPSExpedited = 46;
  public final static int stUPSStandard = 47;
  public final static int stUPS3DaySelect = 48;
  public final static int stUPSNextDayAirSaver = 49;
  public final static int stUPSSaver = 50;
  public final static int stUPSNextDayAirEarlyAM = 51;
  public final static int stUPSExpressEarlyAM = 52;
  public final static int stUPSWorldwideExpressPlus = 53;
  public final static int stUPSExpressPlus = 54;
  public final static int stUPS2ndDayAirAM = 55;
  public final static int stUPSTodayStandard = 56;
  public final static int stUPSTodayCourrier = 57;
  public final static int stUPSTodayInterCity = 58;
  public final static int stUPSTodayExpress = 59;
  public final static int stUPSTodayExpressSaver = 60;
  public final static int stUPSWorldwideExpressFreight = 61;
  public final static int stUPSSurePostLessThan1LB = 62;
  public final static int stUPSSurePost1LBOrGreater = 63;
  public final static int stUPSSurePostBPM = 64;
  public final static int stUPSSurePostMedia = 65;
  public final static int stUSPSExpress = 70;
  public final static int stUSPSFirstClass = 71;
  public final static int stUSPSPriority = 72;
  public final static int stUSPSParcelPost = 73;
  public final static int stUSPSBPM = 74;
  public final static int stUSPSMedia = 75;
  public final static int stUSPSLibrary = 76;
  public final static int stUSPSOnline = 77;
  public final static int stUSPSGlobalExpress = 78;
  public final static int stUSPSParcelSelect = 79;
  public final static int stUSPSCriticalMail = 80;
  public final static int stUSPSStandardMail = 81;
  public final static int stUSPSExpressMailInternational = 82;
  public final static int stUSPSFirstClassMailInternational = 83;
  public final static int stUSPSPriorityMailInternational = 84;
  public final static int stUSPSPriorityExpress = 85;
  public final static int stUSPSRetailGround = 86;
  public final static int stUSPSFirstClassPackageInternationalService = 87;
  public final static int stUSPSPriorityMailExpressInternational = 88;
  public final static int stCanadaRegularParcel = 90;
  public final static int stCanadaExpeditedParcel = 91;
  public final static int stCanadaXpresspost = 92;
  public final static int stCanadaLibrary = 93;
  public final static int stCanadaPriority = 94;
  public final static int stCanadaPriorityEnvelopeUSA = 95;
  public final static int stCanadaPriorityPakUSA = 96;
  public final static int stCanadaPriorityParcelUSA = 97;
  public final static int stCanadaXpresspostUSA = 98;
  public final static int stCanadaExpeditedParcelUSA = 99;
  public final static int stCanadaSmallPacketAirUSA = 100;
  public final static int stCanadaTrackedPacketUSA = 101;
  public final static int stCanadaTrackedPacketLVMUSA = 102;
  public final static int stCanadaPriorityEnvelopeInternational = 103;
  public final static int stCanadaPriorityPakInternational = 104;
  public final static int stCanadaPriorityParcelInternational = 105;
  public final static int stCanadaXpresspostInternational = 106;
  public final static int stCanadaSmallPacketAirInternational = 107;
  public final static int stCanadaSmallPacketLandInternational = 108;
  public final static int stCanadaParcelAirInternational = 109;
  public final static int stCanadaParcelLandInternational = 110;
  public final static int stCanadaTrackedPacketInternational = 111;
  public final static int stFedExDistanceDeferred = 120;
  public final static int stFedExNextDayAfternoon = 121;
  public final static int stFedExNextDayEarlyMorning = 122;
  public final static int stFedExNextDayEndOfDay = 123;
  public final static int stFedExNextDayFreight = 124;
  public final static int stFedExNextDayMidMorning = 125;
  public final static int stFedExSameDay = 126;
  public final static int stFedExSameDayCity = 127;
  public final static int stFedExSameDayMetroAfternoon = 128;
  public final static int stFedExSameDayMetroMorning = 129;
  public final static int stFedExSameDayMetroRush = 130;
  public final static int stUPSWorldwideEconomyDDU = 131;
  public final static int stUPSWorldwideEconomyDDP = 132;
  public final static int stUSPSParcelSelectGround = 133;
  public final static int stUSPSPriorityMailCubic = 134;
  public final static int stUSPSGroundAdvantage = 135;
  public final static int stUSPSGroundAdvantageCubic = 136;
  public final static int stFedExFirst = 140;
  public final static int stFedExPriority = 141;
  public final static int stFedExPriorityExpress = 142;
  public final static int stFedExPriorityExpressFreight = 143;
  public final static int stFedExPriorityFreight = 144;

Default Value

0

Remarks

This property is required to be provided in a ship request when the GetPackageLabel method is called.

Possible values are:

This property is not available at design time.

ShipDate Property (USPSShipIntl Class)

Date package will be mailed.

Syntax

public String getShipDate();


public void setShipDate(String shipDate);

Default Value

""

Remarks

You can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. For USPS, the ship date may be today plus 0 to 3 days in advance. Enter the date in either format: yyyy-MM-dd, such as 2022-08-14, or MM/dd/yyyy, such as 08/14/2022.

This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.

Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.

This property is also returned after the following carrier pickup methods are called:

• PickupAvailability
• SchedulePickup
• ChangePickup
• PickupInquiry

This indicates the date on which the packages will be picked up from the specified location.

ShipmentSpecialServices Property (USPSShipIntl Class)

Contains the collection of special services offered by USPS on shipment level.

Syntax

public long getShipmentSpecialServices();


public void setShipmentSpecialServices(long shipmentSpecialServices);

Default Value

0

Remarks

To request any of the special services offered by USPS, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

SSLAcceptServerCert Property (USPSShipIntl Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (USPSShipIntl Class)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (USPSShipIntl Class)

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (USPSShipIntl Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

Timeout Property (USPSShipIntl Class)

A timeout for the class.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TotalValue Property (USPSShipIntl Class)

Total value of all items being shipped.

Syntax

public String getTotalValue();

Default Value

""

Remarks

This is the total value of all items in the package. It should match the sum of all individual UnitPrices.

This property is read-only.

TransactionId Property (USPSShipIntl Class)

The transaction Id.

Syntax

public String getTransactionId();


public void setTransactionId(String transactionId);

Default Value

""

Remarks

This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.

USPSAccount Property (USPSShipIntl Class)

Login information for USPS.

Syntax

public USPSAccount getUSPSAccount();


public void setUSPSAccount(USPSAccount USPSAccount);

Remarks

This property must be set when connecting to USPS servers. It contains server and login information.

Please refer to the USPSAccount type for a complete list of fields.

CancelPackage Method (Uspsshipintl Class)

Cancels a single package by deleting it from the eVS shipping log.

Syntax

public String cancelPackage(String barcodeNumber);

Remarks

The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.

The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the TrackingNumber assigned to the package by USPS server when the GetPackageLabel method was called.

If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.

Config Method (Uspsshipintl Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetPackageLabel Method (Uspsshipintl Class)

Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.

Syntax

public void getPackageLabel();

Remarks

When this method is called, the following properties are used to construct the request:

• UserId (required for API authentication)
• FirstName (required unless Company is provided)
• MiddleInitial (optional)
• LastName (required unless Company is provided)
• Company (optional if FirstName and LastName are provided)
• Phone (required)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode (required)
• SenderUrbanization (optional)
• SenderCustomsReference (optional)
• FirstName (you must send either a name or Company (or both))
• LastName (you must send either a name or Company (or both))
• Company (optional if name is provided)
• Phone (optional)
• Fax (optional)
• Email (optional)
• Address1 (at least one address line is required)
• Address2
• RecipientAddress3
• City (required)
• State (Province, optional)
• CountryCode (required)
• ZipCode (Postal Code, required)
• AddressFlags (required)
• RecipientCustomsReference (optional)
• NonDeliveryOption (if this is set to "REDIRECT" provide the return address via Config)
• RedirectName (optional)
• RedirectEmail (optional)
• RedirectSMS (optional)
• RedirectAddress (optional)
• RedirectCity (optional)
• RedirectState (optional)
• RedirectZipCode (optional)
• RedirectZip4 (optional)
• PackagingType (optional)
• Description (required)
• Quantity (required)
• Value (required)
• Weight (required)
• HarmonizedCode (optional)
• Manufacturer (optional)
• UseInsurance (optional)
• InsurancePolicy (optional)
• InsuredValue (optional)
• NetCharge (optional - if left blank the server will return the postage cost here)
• Weight (required)
• Length (optional)
• Width (optional)
• Height (optional)
• Machinable (optional)
• Contents (required - if set to ctOther OtherContents must be set)
• Comments (optional)
• LicenseNumber (optional)
• CertificateNumber (optional)
• InvoiceNumber (optional)
• LabelImageType (required)
• ImageLayout (optional)
• CustomerId (optional)
• CustomerId2 (optional)
• MailingLocation (optional)
• ShipDate (optional. If specified must be within 3 days)
• HoldForManifest (optional)
• EELPFC (optional)
• PriceOption (optional)
• MeterPayment (optional)
• ExtraServices (optional)
• ActionCode (optional)
• OptOutOfSPE (optional)
• PermitNumber (optional)
• ImportersReferenceType (optional)
• ImportersContact (optional - Phone, Fax, Email)
• DestinationRateIndicator (optional)
• MID (optional)
• LogisticsManagerMID (optional)
• CRID (optional)
• VendorCode (optional)
• VendorProductVersionNumber (optional)
• ShippingLabelFile (optional if you wish to save the labels to disk)

Please be aware of the maximum character amounts allowed for certain properties. If you enter more than those amounts, an error will not be generated; the API will simply pass in the characters up to the maximum amount allowed, and disregard the rest. This is important since the resulting value could prevent delivery.

This method fills the following properties:

• TrackingNumber
• BarcodeNumber
• ShippingLabel
• NetCharge
• TotalValue
• SDRValue
• IndemnityCoverage (Priority Mail only)
• Prohibitions
• Observations
• Restrictions
• Regulations
• Notes

If ShippingLabelFile was specified with a path and filename, all of the returned label images will also be saved to disk.

Reset Method (Uspsshipintl Class)

Resets the internal state of the class and all properties to their default values.

Syntax

public void reset();

Remarks

The Reset method does not have any parameters and does not return any value.

Error Event (Uspsshipintl Class)

Information about errors during data delivery.

Syntax

public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener {
  ...
  public void error(UspsshipintlErrorEvent e) {}
  ...
}

public class UspsshipintlErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (Uspsshipintl Class)

Notification returned by the server upon successful request (if applicable).

Syntax

public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener {
  ...
  public void notification(UspsshipintlNotificationEvent e) {}
  ...
}

public class UspsshipintlNotificationEvent {
  public String message;
}

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (Uspsshipintl Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener {
  ...
  public void SSLServerAuthentication(UspsshipintlSSLServerAuthenticationEvent e) {}
  ...
}

public class UspsshipintlSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Uspsshipintl Class)

Shows the progress of the secure connection.

Syntax

public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener {
  ...
  public void SSLStatus(UspsshipintlSSLStatusEvent e) {}
  ...
}

public class UspsshipintlSSLStatusEvent {
  public String message;
}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

This type contains descriptive data of physical location of a sender or recipient.

Example: Setting the fields of a sender SenderAddress addr = new SenderAddress addr.Address1 = "100 Somewhere St." addr.Address2 = "Ste 100" addr.City = "Raleigh" addr.State = "NC" addr.ZipCode = "27154" addr.CountryCode = "US"

The fields contained by this type are listed below.

Fields

Constructors

public AddressDetail();

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

CommodityDetail Type

Represents a single commodity line item.

Remarks

This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

Example: Setting the fields for a commodity line item CommodityDetail commodity = new CommodityDetail(); commodity.Description = "Computer software" commodity.Manufacturer = "US" commodity.Weight = "1.0" commodity.QuantityUnit = "EA" commodity.UnitPrice = "99.99" commodity.HarmonizedCode = "9031.80.90"

Note: The following fields are applicable to UPS Freight services.

The fields contained by this type are listed below.

Fields

Constructors

public CommodityDetail();

public CommodityDetail( description,  manufacturer,  harmonizedCode,  scheduleBCode,  weight,  quantity,  quantityUnit,  unitPrice,  numberOfPieces,  exportType);

public CommodityDetail( description,  manufacturer,  harmonizedCode,  scheduleBCode,  weight,  quantity,  quantityUnit,  unitPrice,  numberOfPieces);

public CommodityDetail( description,  manufacturer,  harmonizedCode,  scheduleBCode,  weight,  quantity,  quantityUnit,  unitPrice);

public CommodityDetail( description,  manufacturer,  harmonizedCode,  scheduleBCode,  quantity,  quantityUnit,  unitPrice);

public CommodityDetail( description,  manufacturer,  harmonizedCode,  quantity,  quantityUnit,  unitPrice);

public CommodityDetail( description,  manufacturer,  weight);

ContactDetail Type

Represents the contact information.

Remarks

This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).

Example: Setting the fields of the sender ContactDetail senderContact = new ContactDetail senderContact.Company = "Anything Anywhere" senderContact.FirstName = "John" senderContact.LastName = "Doe" senderContact.Phone = "1234567890" senderContact.Email = "test@test.com"

The fields contained by this type are listed below.

Fields

Constructors

public ContactDetail();

public ContactDetail( firstName,  lastName,  phone);

public ContactDetail( firstName,  lastName,  phone,  email);

public ContactDetail( firstName,  lastName,  phone,  email,  company);

Firewall Type

This is the firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

public Firewall();

PackageDetail Type

Represents a single package contained in shipment.

Remarks

This type contains specific information on the package that is part of the whole shipment.

Example: Setting the package elements PackageDetail pckg = new PackageDetail pckg.Weight = "2.0" pckg.Description = "Your order for the 4D Shipping SDK" pckg.ShippingLabelFile = "shipping label for package# 1.pdf"

The fields contained by this type are listed below.

Fields

Constructors

public PackageDetail();

public PackageDetail( packagingType,  weight);

public PackageDetail( length,  width,  height);

public PackageDetail( packagingType,  length,  width,  height);

public PackageDetail( packagingType,  weight,  length,  width,  height);

public PackageDetail( packagingType,  weight,  length,  width,  height,  specialServices,  insuredValue,  CODAmount,  CODType,  signatureType);

public PackageDetail( weight,  length,  width,  height,  specialServices,  insuredValue,  CODAmount,  dangerousGoodsAccessible,  signatureType);

public PackageDetail( weight,  length,  width,  height,  description,  reference,  specialServices,  insuredValue,  CODAmount,  dangerousGoodsAccessible,  signatureType,  shippingLabelFile,  CODFile);

public PackageDetail( packagingType,  weight,  length,  width,  height,  description,  reference,  specialServices,  insuredValue,  CODAmount,  CODType,  signatureType,  shippingLabelFile,  returnReceiptFile);

Proxy Type

This is the proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

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 = "https://secure.shippingapis.com/ShippingAPI.dll"; account.Password = "my_password"; account.UserId = "my_username";

The fields contained by this type are listed below.

Fields

Constructors

public USPSAccount();

Config Settings (Uspsshipintl Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

USPSShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (Uspsshipintl Class)

USPSShipIntl Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.
	529   Bad Label Format. (Possibly corrupt encoding)

SOAP Errors

	169   Invalid param index (out of range).
	170   Invalid namespace index (out of range).
	171   Method not found. Please specify a valid Method.
	172   No method URI. Please specify a valid MethodURI.
	173   SOAP Fault. See FaultCode and/or FaultString for details.

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	303   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.