USPSShipIntl Control

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

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 USPSUserId to the UserId provided by USPS.
• Set USPSPassword to the password provided by USPS.
• Set USPSServer 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 USPSAccountNumber to your production account number (provided by Endicia).
• Set USPSPassword 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 control will send requests to the correct server without setting USPSServer.

ppStamps

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

• Set PostageProvider to ppStamps.
• Set USPSUserId to the sandbox or production user provided by Stamps.com.
• Set USPSAccountNumber to the sandbox or production account number provided by Stamps.com.
• Set USPSPassword to the sandbox or production password provided by Stamps.com.
• Set USPSServer to either the test or production server.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

BarcodeNumber Property (USPSShipIntl Control)

Barcode number associated with label's barcode.

Syntax

uspsshipintlcontrol.BarcodeNumber

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.

Data Type

String

CertificateNumber Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.CertificateNumber[=string]

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.

Data Type

String

Comments Property (USPSShipIntl Control)

Comments on the package being shipped.

Syntax

uspsshipintlcontrol.Comments[=string]

Default Value

""

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

Data Type

String

CommodityCount Property (USPSShipIntl Control)

The number of records in the Commodity arrays.

Syntax

uspsshipintlcontrol.CommodityCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityHarmonizedCode
• CommodityManufacturer
• CommodityQuantity
• CommodityValue
• CommodityWeight

The array indices start at 0 and end at CommodityCount - 1.

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (USPSShipIntl Control)

Complete and accurate description of this commodity line item.

Syntax

uspsshipintlcontrol.CommodityDescription(CommodityIndex)[=string]

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

It is applicable to all international forms. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

For FedEx, if the shipment contains documents only (i.e., Documents is set to True), then the CommodityDescription has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityHarmonizedCode Property (USPSShipIntl Control)

Unique code representing this commodity line item (for imports only).

Syntax

uspsshipintlcontrol.CommodityHarmonizedCode(CommodityIndex)[=string]

Default Value

""

Remarks

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in CommodityDescription, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityHarmonizedCode is required for each commodity line item for shipments to EU countries.

At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityManufacturer Property (USPSShipIntl Control)

Country code where the contents of this commodity line were produced, manufactured or grown in their final form.

Syntax

uspsshipintlcontrol.CommodityManufacturer(CommodityIndex)[=string]

Default Value

"US"

Remarks

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the CommodityManufacturer is required to be entered.

In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the CommodityManufacturer and CommodityDescription are required to be provided in the request. If the CommodityManufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The CommodityManufacturer has to be provided for each commodity item included in that international shipment.

In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.

In USPS, the value of this property is optional, and is only used by commercial shippers. If PostageProvider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.).

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityQuantity Property (USPSShipIntl Control)

Number of units contained in this commodity line item measured in units specified by the QuantityUnit .

Syntax

uspsshipintlcontrol.CommodityQuantity(CommodityIndex)[=integer]

Default Value

1

Remarks

Number of units contained in this commodity line item measured in units specified by the CommodityQuantityUnit. This is used in conjunction with the CommodityQuantityUnit and CommodityUnitPrice.

For FedEx, if the Documents is set to False in ship request, the CommodityQuantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

For UPS, these are all required for Invoice form type and optional for Partial Invoice (not applicable to other international form types).

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityValue Property (USPSShipIntl Control)

The value of an individual item being shipped.

Syntax

uspsshipintlcontrol.CommodityValue(CommodityIndex)[=string]

Default Value

""

Remarks

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

This property is only applicable to USPS and UPS freight.

Note: For USPS, the maximum value for this property is "99999.99".

Note: For UPS freight, the maximum value for this property is "99999999999999.99".

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityWeight Property (USPSShipIntl Control)

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.

Syntax

uspsshipintlcontrol.CommodityWeight(CommodityIndex)[=string]

Default Value

"0.00"

Remarks

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityWeight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, this is required and applicable to CO and SED forms only .

When using USPS and PostageProvider is set to ppNone, the format of this property must be "XX lbs YY oz", where XX is the number of pounds and YY is the number of ounces.

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

Contents Property (USPSShipIntl Control)

Type of the contents in the package.

Syntax

uspsshipintlcontrol.Contents[=integer]

Possible Values

ctSample(0), 
ctGift(1), 
ctDocuments(2), 
ctReturn(3), 
ctOther(4), 
ctMerchandise(5), 
ctHumanitarianDonation(6), 
ctDangerousGoods(7), 
ctCrematedRemains(8), 
ctNonNegotiableDocument(9), 
ctPharmaceuticals(10), 
ctMedicalSupplies(11), 
ctHAZMAT(12), 
ctLives(13), 
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:

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

Data Type

Integer

CustomerId Property (USPSShipIntl Control)

User-assigned number for internal use.

Syntax

uspsshipintlcontrol.CustomerId[=string]

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.

Data Type

String

ExtraServices Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.ExtraServices[=long64]

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:

Data Type

Long64

FirewallAutoDetect Property (USPSShipIntl Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

uspsshipintlcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (USPSShipIntl Control)

This property determines the type of firewall to connect through.

Syntax

uspsshipintlcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (USPSShipIntl Control)

This property contains the name or IP address of firewall (optional).

Syntax

uspsshipintlcontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (USPSShipIntl Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

uspsshipintlcontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (USPSShipIntl Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

uspsshipintlcontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (USPSShipIntl Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

uspsshipintlcontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

ImageLayout Property (USPSShipIntl Control)

Determines how the labels will be formatted for printing.

Syntax

uspsshipintlcontrol.ImageLayout[=integer]

Possible Values

ilOnePerFile(0), 
ilAllInOneFile(1), 
ilTrimOnePerFile(2), 
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 PackageShippingLabelFile is specified, these additional pages will be saved with the page number appended to the PackageShippingLabelFile you supplied.

For instance, if the PackageShippingLabelFile 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.

Data Type

Integer

ImportersEmail Property (USPSShipIntl Control)

Identifies the contact person's email address.

Syntax

uspsshipintlcontrol.ImportersEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

ImportersFax Property (USPSShipIntl Control)

Recipient's fax number.

Syntax

uspsshipintlcontrol.ImportersFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

ImportersPhone Property (USPSShipIntl Control)

Identifies the contact person's phone number.

Syntax

uspsshipintlcontrol.ImportersPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

IndemnityCoverage Property (USPSShipIntl Control)

Indicates the indemnity coverage for the package.

Syntax

uspsshipintlcontrol.IndemnityCoverage

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.

Data Type

String

InsurancePolicy Property (USPSShipIntl Control)

Insurance number, if known.

Syntax

uspsshipintlcontrol.InsurancePolicy[=string]

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.

Data Type

String

InvoiceNumber Property (USPSShipIntl Control)

Invoice number if known or included in the package.

Syntax

uspsshipintlcontrol.InvoiceNumber[=string]

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 PackageType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

Data Type

String

LabelImageType Property (USPSShipIntl Control)

Type of label image.

Syntax

uspsshipintlcontrol.LabelImageType[=integer]

Possible Values

sitNone(0), 
sitTIF(1), 
sitJPG(2), 
sitPDF(3), 
sitGIF(4), 
sitEPL(5), 
sitPNG(6), 
sitZPL(7), 
sitPDFVector(8), 
sitPDFVectorWithFonts(9), 
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)

Data Type

Integer

LicenseNumber Property (USPSShipIntl Control)

Import License number if known, or included in package.

Syntax

uspsshipintlcontrol.LicenseNumber[=string]

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.

Data Type

String

Machinable Property (USPSShipIntl Control)

Indicates if shipment is machinable or not.

Syntax

uspsshipintlcontrol.Machinable[=integer]

Possible Values

moTrue(0), 
moFalse(1), 
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:

Data Type

Integer

MailingLocation Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.MailingLocation[=string]

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 (SenderZipCode), 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.

Data Type

String

NonDeliveryOption Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.NonDeliveryOption[=integer]

Possible Values

ndoReturn(0), 
ndoRedirect(1), 
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) ).

Data Type

Integer

Notes Property (USPSShipIntl Control)

Additional information returned by the USPS Server .

Syntax

uspsshipintlcontrol.Notes

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

Observations Property (USPSShipIntl Control)

Additional mailing information based on country of destination.

Syntax

uspsshipintlcontrol.Observations

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

PackageCount Property (USPSShipIntl Control)

The number of records in the Package arrays.

Syntax

uspsshipintlcontrol.PackageCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageCODAmount
• PackageCODType
• PackageDescription
• PackageGirth
• PackageHeight
• PackageId
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSize
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

The array indices start at 0 and end at PackageCount - 1.

This property is not available at design time.

Data Type

Integer

PackageCODAmount Property (USPSShipIntl Control)

The COD monetary value for the package.

Syntax

uspsshipintlcontrol.PackageCODAmount(PackageIdx)[=string]

Default Value

""

Remarks

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in PackageCODLabel).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the PackageCODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the PackageCODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackageType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by PackageSignatureType) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageCODType Property (USPSShipIntl Control)

The code that indicates the type of funds that will be used for the COD payment for this package.

Syntax

uspsshipintlcontrol.PackageCODType(PackageIdx)[=integer]

Possible Values

codtpAny(0), 
codtpCash(1), 
codtpGuaranteedFunds(2), 
codtpCompanyCheck(3), 
codtpPersonalCheck(4)

Default Value

0

Remarks

The code that indicates the type of funds that will be used for the COD payment for this package.

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., PackageCODAmount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageDescription Property (USPSShipIntl Control)

For FedEx, this is the description that appears in the email to identify this package.

Syntax

uspsshipintlcontrol.PackageDescription(PackageIdx)[=string]

Default Value

""

Remarks

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageGirth Property (USPSShipIntl Control)

Measurement around the widest part of the package, perpendicular to the Length .

Syntax

uspsshipintlcontrol.PackageGirth(PackageIdx)[=integer]

Default Value

0

Remarks

Measurement around the widest part of the package, perpendicular to the PackageLength.

This property is only applicable when requesting rates for USPS packages.

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageHeight Property (USPSShipIntl Control)

The height of the package to be shipped.

Syntax

uspsshipintlcontrol.PackageHeight(PackageIdx)[=integer]

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the PackageHeight is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageWidth are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set). For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageId Property (USPSShipIntl Control)

An 8-digit Unique Parcel Identification Number.

Syntax

uspsshipintlcontrol.PackageId(PackageIdx)[=string]

Default Value

""

Remarks

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageInsuredValue Property (USPSShipIntl Control)

Amount of insurance requested for this package.

Syntax

uspsshipintlcontrol.PackageInsuredValue(PackageIdx)[=string]

Default Value

""

Remarks

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageLength Property (USPSShipIntl Control)

The length of the package to be shipped.

Syntax

uspsshipintlcontrol.PackageLength(PackageIdx)[=integer]

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the PackageLength is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageWidth and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, the PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageNetCharge Property (USPSShipIntl Control)

Actual Net Charge applicable to this package.

Syntax

uspsshipintlcontrol.PackageNetCharge(PackageIdx)[=string]

Default Value

""

Remarks

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl controls only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageType Property (USPSShipIntl Control)

The packaging type of the package being rated and/or shipped.

Syntax

uspsshipintlcontrol.PackageType(PackageIdx)[=integer]

Possible Values

ptNone(0), 
ptPostcards(1), 
ptLetter(2), 
ptLargeEnvelope(3), 
ptFlatRateEnvelope(4), 
ptFlatRateLegalEnvelope(5), 
ptFlatRatePaddedEnvelope(6), 
ptFlatRateGiftCardEnvelope(7), 
ptFlatRateWindowEnvelope(8), 
ptFlatRateCardboardEnvelope(9), 
ptSmallFlatRateEnvelope(10), 
ptPak(11), 
ptBox(12), 
pt10kgBox(13), 
pt25kgBox(14), 
ptSmallExpressBox(15), 
ptMediumExpressBox(16), 
ptLargeExpressBox(17), 
ptFlatRateBox(18), 
ptSmallFlatRateBox(19), 
ptMediumFlatRateBox(20), 
ptLargeFlatRateBox(21), 
ptDVDFlatRateBox(22), 
ptLargeVideoFlatRateBox(23), 
ptRegionalRateBoxA(24), 
ptRegionalRateBoxB(25), 
ptRectangular(26), 
ptNonRectangular(27), 
ptTube(28), 
ptMatterForTheBlind(29), 
ptPallet(30), 
ptYourPackaging(31), 
ptDocument(32), 
ptFlats(33), 
ptParcels(34), 
ptBPM(35), 
ptFirstClass(36), 
ptPriority(37), 
ptMachinables(38), 
ptIrregulars(39), 
ptParcelPost(40), 
ptBPMParcel(41), 
ptMediaMail(42), 
ptBPMFlat(43), 
ptStandardFlat(44), 
ptRegionalRateBoxC(45), 
ptThickEnvelope(46), 
ptSmallBox(47), 
ptMediumBox(48), 
ptLargeBox(49), 
ptExtraLargeBox(50), 
ptPackageService(51), 
ptCubicParcels(52), 
ptCubicSoftPack(53)

Default Value

0

Remarks

The packaging type of the package being rated and/or shipped.

Possible values are:

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagePackagingType for the first package is used in label requests.

If the PackagePackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackageLength, PackageWidth, and PackageHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagePackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagePackagingType make sure this is valid for all the following: SenderCountryCode, RecipientCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageShippingLabel Property (USPSShipIntl Control)

Image of the shipping label for this package returned by the Server upon a successful ship response.

Syntax

uspsshipintlcontrol.PackageShippingLabel(PackageIdx)

Default Value

""

Remarks

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the PackageShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .PackageShippingLabelB.

This property is read-only and not available at design time.

Data Type

Binary String

PackageShippingLabelFile Property (USPSShipIntl Control)

Filename and location to save the ShippingLabel of this package to.

Syntax

uspsshipintlcontrol.PackageShippingLabelFile(PackageIdx)[=string]

Default Value

""

Remarks

Filename and location to save the PackageShippingLabel of this package to. When the PackageShippingLabelFile is set to a valid path and filename, the contents of the PackageShippingLabel are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then PackageShippingLabelFile has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageSignatureType Property (USPSShipIntl Control)

Specifies one of the Delivery Signature Options requested for this package.

Syntax

uspsshipintlcontrol.PackageSignatureType(PackageIdx)[=integer]

Possible Values

stServiceDefault(0), 
stAdult(1), 
stDirect(2), 
stIndirect(3), 
stNoSignatureRequired(4), 
stUSPSDeliveryConfirmation(5), 
stAdult19(6)

Default Value

0

Remarks

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

• Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
• Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
• Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
• Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the PackageSignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageSize Property (USPSShipIntl Control)

Size of the package being mailed.

Syntax

uspsshipintlcontrol.PackageSize(PackageIdx)[=integer]

Possible Values

psRegular(0), 
psLarge(1), 
psOversize(2), 
psIrregular(3)

Default Value

0

Remarks

Size of the package being mailed.

This property is only used by USPS and is required for the GetRates method call.

See below for valid entries:

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the PackageLength, PackageHeight, PackageWidth and optionally PackageGirth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageTrackingNumber Property (USPSShipIntl Control)

Tracking number assigned to this package.

Syntax

uspsshipintlcontrol.PackageTrackingNumber(PackageIdx)

Default Value

""

Remarks

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is read-only and not available at design time.

Data Type

String

PackageWeight Property (USPSShipIntl Control)

Weight of this package.

Syntax

uspsshipintlcontrol.PackageWeight(PackageIdx)[=string]

Default Value

"0.0"

Remarks

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagePackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagePackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageWidth Property (USPSShipIntl Control)

The width of the package to be shipped.

Syntax

uspsshipintlcontrol.PackageWidth(PackageIdx)[=integer]

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the PackageWidth is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PermitNumber Property (USPSShipIntl Control)

Permit number to print Postage Due labels.

Syntax

uspsshipintlcontrol.PermitNumber[=string]

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.

Data Type

String

PostageProvider Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.PostageProvider[=integer]

Possible Values

ppNone(0), 
ppEndicia(1), 
ppStamps(2)

Default Value

0

Remarks

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

• Set USPSUserId
• Set USPSPassword
• Set USPSServer

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

For Production

• Set USPSAccountNumber
• Set USPSPassword

For Testing

• Set EndiciaTestMode

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

• Set USPSUserId
• Set USPSAccountNumber
• Set USPSPassword
• Set USPSServer

Data Type

Integer

PriceOption Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.PriceOption[=integer]

Possible Values

poRetail(0), 
poCommercialPlus(1), 
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:

Data Type

Integer

Prohibitions Property (USPSShipIntl Control)

List of items prohibited from mailing to the destination country.

Syntax

uspsshipintlcontrol.Prohibitions

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.

Data Type

String

ProxyAuthScheme Property (USPSShipIntl Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

uspsshipintlcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (USPSShipIntl Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

uspsshipintlcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (USPSShipIntl Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

uspsshipintlcontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (USPSShipIntl Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

uspsshipintlcontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (USPSShipIntl Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

uspsshipintlcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (USPSShipIntl Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

uspsshipintlcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (USPSShipIntl Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

uspsshipintlcontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (USPSShipIntl Control)

Street name.

Syntax

uspsshipintlcontrol.RecipientAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (USPSShipIntl Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

uspsshipintlcontrol.RecipientAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientAddressFlags Property (USPSShipIntl Control)

Various flags that denote information about the address.

Syntax

uspsshipintlcontrol.RecipientAddressFlags[=integer]

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (USPSShipIntl Control)

Name of city, town, etc.

Syntax

uspsshipintlcontrol.RecipientCity[=string]

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (USPSShipIntl Control)

Country code.

Syntax

uspsshipintlcontrol.RecipientCountryCode[=string]

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (USPSShipIntl Control)

State or province code.

Syntax

uspsshipintlcontrol.RecipientState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (USPSShipIntl Control)

Postal code.

Syntax

uspsshipintlcontrol.RecipientZipCode[=string]

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

RecipientCompany Property (USPSShipIntl Control)

Identifies the contact person's company name.

Syntax

uspsshipintlcontrol.RecipientCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either RecipientFirstName and RecipientLastName or RecipientCompany are required to be provided.

Data Type

String

RecipientEmail Property (USPSShipIntl Control)

Identifies the contact person's email address.

Syntax

uspsshipintlcontrol.RecipientEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

RecipientFax Property (USPSShipIntl Control)

Recipient's fax number.

Syntax

uspsshipintlcontrol.RecipientFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

RecipientFirstName Property (USPSShipIntl Control)

Sender's first name.

Syntax

uspsshipintlcontrol.RecipientFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either RecipientFirstName and RecipientLastName or RecipientCompany must be sent.

Data Type

String

RecipientLastName Property (USPSShipIntl Control)

Person's last name.

Syntax

uspsshipintlcontrol.RecipientLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either RecipientFirstName and RecipientLastName or RecipientCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

RecipientMiddleInitial Property (USPSShipIntl Control)

Middle initial.

Syntax

uspsshipintlcontrol.RecipientMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (USPSShipIntl Control)

Identifies the contact person's phone number.

Syntax

uspsshipintlcontrol.RecipientPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

RecipientCustomsReference Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.RecipientCustomsReference[=string]

Default Value

""

Remarks

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

Data Type

String

Regulations Property (USPSShipIntl Control)

Additional regulations for shipping to the destination country.

Syntax

uspsshipintlcontrol.Regulations

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.

Data Type

String

Restrictions Property (USPSShipIntl Control)

Restrictions on items being shipped based on country of destination.

Syntax

uspsshipintlcontrol.Restrictions

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.

Data Type

String

SDRValue Property (USPSShipIntl Control)

Special Drawing Right calculated on TotalValue .

Syntax

uspsshipintlcontrol.SDRValue

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.

Data Type

String

SenderAddress1 Property (USPSShipIntl Control)

Street name.

Syntax

uspsshipintlcontrol.SenderAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.

Data Type

String

SenderAddress2 Property (USPSShipIntl Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

uspsshipintlcontrol.SenderAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.

Data Type

String

SenderCity Property (USPSShipIntl Control)

Name of city, town, etc.

Syntax

uspsshipintlcontrol.SenderCity[=string]

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

SenderState Property (USPSShipIntl Control)

State or province code.

Syntax

uspsshipintlcontrol.SenderState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

SenderZipCode Property (USPSShipIntl Control)

Postal code.

Syntax

uspsshipintlcontrol.SenderZipCode[=string]

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

SenderCompany Property (USPSShipIntl Control)

Identifies the contact person's company name.

Syntax

uspsshipintlcontrol.SenderCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either SenderFirstName and SenderLastName or SenderCompany are required to be provided.

Data Type

String

SenderEmail Property (USPSShipIntl Control)

Identifies the contact person's email address.

Syntax

uspsshipintlcontrol.SenderEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

SenderFax Property (USPSShipIntl Control)

Recipient's fax number.

Syntax

uspsshipintlcontrol.SenderFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

SenderFirstName Property (USPSShipIntl Control)

Sender's first name.

Syntax

uspsshipintlcontrol.SenderFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent.

Data Type

String

SenderLastName Property (USPSShipIntl Control)

Person's last name.

Syntax

uspsshipintlcontrol.SenderLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

SenderMiddleInitial Property (USPSShipIntl Control)

Middle initial.

Syntax

uspsshipintlcontrol.SenderMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (USPSShipIntl Control)

Identifies the contact person's phone number.

Syntax

uspsshipintlcontrol.SenderPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

SenderCustomsReference Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.SenderCustomsReference[=string]

Default Value

""

Remarks

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

Data Type

String

ServiceType Property (USPSShipIntl Control)

The mail service type when shipping to the CountryCode .

Syntax

uspsshipintlcontrol.ServiceType[=integer]

Possible Values

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

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.

Data Type

Integer

ShipDate Property (USPSShipIntl Control)

Date package will be mailed.

Syntax

uspsshipintlcontrol.ShipDate[=string]

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.

Data Type

String

ShipmentSpecialServices Property (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.ShipmentSpecialServices[=long64]

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:

Data Type

Long64

SSLAcceptServerCertEncoded Property (USPSShipIntl Control)

This is the certificate (PEM/Base64 encoded).

Syntax

uspsshipintlcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (USPSShipIntl Control)

This is the certificate (PEM/Base64 encoded).

Syntax

uspsshipintlcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (USPSShipIntl Control)

This is the name of the certificate store for the client certificate.

Syntax

uspsshipintlcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (USPSShipIntl Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

uspsshipintlcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (USPSShipIntl Control)

This is the type of certificate store for this certificate.

Syntax

uspsshipintlcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (USPSShipIntl Control)

This is the subject of the certificate used for client authentication.

Syntax

uspsshipintlcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (USPSShipIntl Control)

This specifies the SSL/TLS implementation to use.

Syntax

uspsshipintlcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
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 control 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 control 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.

Data Type

Integer

SSLServerCertEncoded Property (USPSShipIntl Control)

This is the certificate (PEM/Base64 encoded).

Syntax

uspsshipintlcontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (USPSShipIntl Control)

A timeout for the control.

Syntax

uspsshipintlcontrol.Timeout[=integer]

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 control will wait for the operation to complete before returning control.

The control 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 control fails with an error.

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.

Data Type

Integer

TotalValue Property (USPSShipIntl Control)

Total value of all items being shipped.

Syntax

uspsshipintlcontrol.TotalValue

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

TransactionId Property (USPSShipIntl Control)

The transaction Id.

Syntax

uspsshipintlcontrol.TransactionId[=string]

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.

Data Type

String

USPSAccountNumber Property (USPSShipIntl Control)

The shipper's Endicia account number.

Syntax

uspsshipintlcontrol.USPSAccountNumber[=string]

Default Value

""

Remarks

The shipper's Endicia account number.

This property is only used when shipping with Endicia and will take a production account number. During testing please set EndiciaTestMode which will automatically use a sandbox account. During testing this property does not need to be set.

Data Type

String

USPSPassword Property (USPSShipIntl Control)

Password to use for logging in to the USPS Server .

Syntax

uspsshipintlcontrol.USPSPassword[=string]

Default Value

""

Remarks

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.

Data Type

String

USPSServer Property (USPSShipIntl Control)

URL for the USPS server where the requests are sent.

Syntax

uspsshipintlcontrol.USPSServer[=string]

Default Value

"https://secure.shippingapis.com/ShippingAPI.dll"

Remarks

URL for the USPS server where the requests are sent.

When PostageProvider has been set to ppEndicia, the live production URL will be set automatically. For testing please set EndiciaTestMode.

When PostageProvider has been set to ppStamps, the live production URL will be set automatically. For testing please set StampsTestMode.

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 controls). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the controls that use them.

Live Servers:

Test Servers:

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. There is no need to set Certify with Endicia or Stamps.com. Set EndiciaTestMode or StampsTestMode instead.

Data Type

String

USPSUserId Property (USPSShipIntl Control)

User Id for logging in to the USPS WebTools or Stamps.

Syntax

uspsshipintlcontrol.USPSUserId[=string]

Default Value

""

Remarks

User Id for logging in to the USPS WebTools or Stamps.com Server.

This User Id is provided to you by USPS or Stamps.com 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. During testing set StampsTestMode to use the built-in sandbox account. This field is not used by Endicia.

Data Type

String

CancelPackage Method (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.CancelPackage 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 PackageTrackingNumber 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 Control)

Sets or retrieves a configuration setting.

Syntax

uspsshipintlcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)

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

uspsshipintlcontrol.GetPackageLabel 

Remarks

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

• USPSUserId (required for API authentication)
• SenderFirstName (required unless SenderCompany is provided)
• SenderMiddleInitial (optional)
• SenderLastName (required unless SenderCompany is provided)
• SenderCompany (optional if SenderFirstName and SenderLastName are provided)
• SenderPhone (required)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode (required)
• SenderUrbanization (optional)
• SenderCustomsReference (optional)
• RecipientFirstName (you must send either a name or RecipientCompany (or both))
• RecipientLastName (you must send either a name or RecipientCompany (or both))
• RecipientCompany (optional if name is provided)
• RecipientPhone (optional)
• RecipientFax (optional)
• RecipientEmail (optional)
• RecipientAddress1 (at least one address line is required)
• RecipientAddress2
• RecipientAddress3
• RecipientCity (required)
• RecipientState (Province, optional)
• RecipientCountryCode (required)
• RecipientZipCode (Postal Code, required)
• RecipientAddressFlags (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)
• PackageType (optional)
• CommodityDescription (required)
• CommodityQuantity (required)
• CommodityValue (required)
• CommodityWeight (required)
• CommodityHarmonizedCode (optional)
• CommodityManufacturer (optional)
• UseInsurance (optional)
• InsurancePolicy (optional)
• PackageInsuredValue (optional)
• PackageNetCharge (optional - if left blank the server will return the postage cost here)
• PackageWeight (required)
• PackageLength (optional)
• PackageWidth (optional)
• PackageHeight (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)
• PackageShippingLabelFile (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:

• PackageTrackingNumber
• BarcodeNumber
• PackageShippingLabel
• PackageNetCharge
• TotalValue
• SDRValue
• IndemnityCoverage (Priority Mail only)
• Prohibitions
• Observations
• Restrictions
• Regulations
• Notes

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

Reset Method (USPSShipIntl Control)

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

Syntax

uspsshipintlcontrol.Reset 

Remarks

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

Error Event (USPSShipIntl Control)

Information about errors during data delivery.

Syntax

Sub uspsshipintlcontrol_Error(ErrorCode As Integer, Description As String)

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 Control)

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

Syntax

Sub uspsshipintlcontrol_Notification(Message As String)

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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub uspsshipintlcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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 Control)

Fired when secure connection progress messages are available.

Syntax

Sub uspsshipintlcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (USPSShipIntl Control)

The control 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 control, 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 Control)

USPSShipIntl Errors

	20302    Operation interrupted (or timeout).
	20433    Invalid index.
	20528    Server Error Response.
	20529    Property set with invalid data.
	20530    Bad Label Format. (Possibly corrupt encoding)

The control may also return one of the following error codes, which are inherited from other controls.

SOAP Errors

	20170    Invalid param index (out of range).
	20171    Invalid namespace index (out of range).
	20172    Method not found. Please specify a valid Method.
	20173    No method URI. Please specify a valid MethodURI.
	20174    SOAP Fault. See FaultCode and/or FaultString for details.

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

	20119    Firewall Error. Error description contains detailed message.
	20144    Busy executing current method.
	20152    HTTP protocol error. The error message has the server response.
	20153    No server specified in URL
	20154    Specified URLScheme is invalid.
	20156    Range operation is not supported by server.
	20157    Invalid cookie index (out of range).
	20302    Interrupted.
	20303    Can't open AttachedFile.

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

	20101    You cannot change the RemotePort at this time. A connection is in progress.
	20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103    The RemoteHost address is invalid (0.0.0.0).
	20105    Already connected. If you want to reconnect, close the current connection first.
	20107    You cannot change the LocalPort at this time. A connection is in progress.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20113    You cannot change MaxLineLength at this time. A connection is in progress.
	20117    RemotePort cannot be zero. Please specify a valid service port number.
	20118    You cannot change the UseConnection option while the control is active.
	20136    Operation would block.
	20202    Timeout.
	20212    Action impossible in control's present state.
	20213    Action impossible while not connected.
	20214    Action impossible while listening.
	20302    Timeout.
	20303    Could not open file.
	20435    Unable to convert string to selected CodePage.
	21106    Already connecting. If you want to reconnect, close the current connection first.
	21118    You need to connect first.
	21120    You cannot change the LocalHost at this time. A connection is in progress.
	21121    Connection dropped by remote host.

SSL Errors

	20271    Cannot load specified security library.
	20272    Cannot open certificate store.
	20273    Cannot find specified certificate.
	20274    Cannot acquire security credentials.
	20275    Cannot find certificate chain.
	20276    Cannot verify certificate chain.
	20277    Error during handshake.
	20281    Error verifying certificate.
	20282    Could not find client certificate.
	20283    Could not find server certificate.
	20284    Error encrypting data.
	20285    Error decrypting data.

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).

XML Errors

	20102    Invalid attribute index.
	20103    No attributes available.
	20104    Invalid namespace index.
	20105    No namespaces available.
	20106    Invalid element index.
	20107    No elements available.
	20108    Attribute does not exist.
	20202    Unbalanced element tag.
	20203    Unknown element prefix (can't find namespace).
	20204    Unknown attribute prefix (can't find namespace).
	20205    Invalid XML markup.
	20206    Invalid end state for parser.
	20207    Document contains unbalanced elements.
	20208    Invalid XPath.
	20209    No such child.
	20210    Top element does not match start of path.
	20211    DOM tree unavailable (set BuildDOM to true and reparse).
	20303    Can't open file.
	20402    Invalid XML would be generated.
	20403    An invalid XML name has been specified.