USPSShipIntl Component

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 is set to ppNone the method will generate an eVS label. The eVS International Label API lets customers generate eVS labels with integrated customs declaration forms.

Syntax

DPayments.DShippingSDK.Uspsshipintl

Remarks

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

Postage Provider Notes

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

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

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

Production

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

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

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.

ppStamps

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

BarcodeNumber Property (USPSShipIntl Component)

Barcode number associated with label's barcode.

Syntax

• C#
• VB.NET

public string BarcodeNumber { get; }

Public ReadOnly Property BarcodeNumber As String

Default Value

""

Remarks

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

This property is read-only.

CertificateNumber Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public string CertificateNumber { get; set; }

Public Property CertificateNumber As 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.

Comments Property (USPSShipIntl Component)

Comments on the package being shipped.

Syntax

• C#
• VB.NET

public string Comments { get; set; }

Public Property Comments As String

Default Value

""

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

Commodities Property (USPSShipIntl Component)

Items being shipped inside this package.

Syntax

• C#
• VB.NET

public CommodityDetailList Commodities { get; }

Public Property Commodities As CommodityDetailList

Remarks

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

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

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

This property is not available at design time.

Contents Property (USPSShipIntl Component)

Type of the contents in the package.

Syntax

• C#
• VB.NET

public UspsshipintlContents Contents { get; set; }

enum UspsshipintlContents {
  ctSample,
  ctGift,
  ctDocuments,
  ctReturn,
  ctOther,
  ctMerchandise,
  ctHumanitarianDonation,
  ctDangerousGoods,
  ctCrematedRemains,
  ctNonNegotiableDocument,
  ctPharmaceuticals,
  ctMedicalSupplies,
  ctHAZMAT,
  ctLives,
  ctPerishable
}

Public Property Contents As UspsshipintlContents

Enum UspsshipintlContents
  ctSample
  ctGift
  ctDocuments
  ctReturn
  ctOther
  ctMerchandise
  ctHumanitarianDonation
  ctDangerousGoods
  ctCrematedRemains
  ctNonNegotiableDocument
  ctPharmaceuticals
  ctMedicalSupplies
  ctHAZMAT
  ctLives
  ctPerishable
End Enum

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:

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

CustomerId Property (USPSShipIntl Component)

User-assigned number for internal use.

Syntax

• C#
• VB.NET

public string CustomerId { get; set; }

Public Property CustomerId As 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.

ExtraServices Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public long ExtraServices { get; set; }

Public Property ExtraServices As Long

Default Value

0

Remarks

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

Firewall Property (USPSShipIntl Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

ImageLayout Property (USPSShipIntl Component)

Determines how the labels will be formatted for printing.

Syntax

• C#
• VB.NET

public UspsshipintlImageLayouts ImageLayout { get; set; }

enum UspsshipintlImageLayouts {
  ilOnePerFile,
  ilAllInOneFile,
  ilTrimOnePerFile,
  ilTrimAllInOneFile
}

Public Property ImageLayout As UspsshipintlImageLayouts

Enum UspsshipintlImageLayouts
  ilOnePerFile
  ilAllInOneFile
  ilTrimOnePerFile
  ilTrimAllInOneFile
End Enum

Default Value

0

Remarks

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

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

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

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

ImportersContact Property (USPSShipIntl Component)

Identifies the importer's contact info.

Syntax

• C#
• VB.NET

public ContactDetail ImportersContact { get; set; }

Public Property ImportersContact As ContactDetail

Remarks

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

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

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

IndemnityCoverage Property (USPSShipIntl Component)

Indicates the indemnity coverage for the package.

Syntax

• C#
• VB.NET

public string IndemnityCoverage { get; }

Public ReadOnly Property IndemnityCoverage As String

Default Value

""

Remarks

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

This property is read-only.

InsurancePolicy Property (USPSShipIntl Component)

Insurance number, if known.

Syntax

• C#
• VB.NET

public string InsurancePolicy { get; set; }

Public Property InsurancePolicy As 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.

InvoiceNumber Property (USPSShipIntl Component)

Invoice number if known or included in the package.

Syntax

• C#
• VB.NET

public string InvoiceNumber { get; set; }

Public Property InvoiceNumber As 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 PackagingType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

LabelImageType Property (USPSShipIntl Component)

Type of label image.

Syntax

• C#
• VB.NET

public UspsshipintlLabelImageTypes LabelImageType { get; set; }

enum UspsshipintlLabelImageTypes {
  sitNone,
  sitTIF,
  sitJPG,
  sitPDF,
  sitGIF,
  sitEPL,
  sitPNG,
  sitZPL,
  sitPDFVector,
  sitPDFVectorWithFonts,
  sitAZPL
}

Public Property LabelImageType As UspsshipintlLabelImageTypes

Enum UspsshipintlLabelImageTypes
  sitNone
  sitTIF
  sitJPG
  sitPDF
  sitGIF
  sitEPL
  sitPNG
  sitZPL
  sitPDFVector
  sitPDFVectorWithFonts
  sitAZPL
End Enum

Default Value

0

Remarks

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

Valid values for USPS (eVSLabels):

• sitTIF (1)
• sitPDF (3)

Valid values for Endicia:

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

Valid values for Stamps.com:

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

LicenseNumber Property (USPSShipIntl Component)

Import License number if known, or included in package.

Syntax

• C#
• VB.NET

public string LicenseNumber { get; set; }

Public Property LicenseNumber As 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.

Machinable Property (USPSShipIntl Component)

Indicates if shipment is machinable or not.

Syntax

• C#
• VB.NET

public UspsshipintlMachinables Machinable { get; set; }

enum UspsshipintlMachinables {
  moTrue,
  moFalse,
  moIrregular
}

Public Property Machinable As UspsshipintlMachinables

Enum UspsshipintlMachinables
  moTrue
  moFalse
  moIrregular
End Enum

Default Value

0

Remarks

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

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

Possible values are as follows:

MailingLocation Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public string MailingLocation { get; set; }

Public Property MailingLocation As 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 (ZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

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

This property is not applicable for International First Class mail.

NonDeliveryOption Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public UspsshipintlNonDeliveryOptions NonDeliveryOption { get; set; }

enum UspsshipintlNonDeliveryOptions {
  ndoReturn,
  ndoRedirect,
  ndoAbandon
}

Public Property NonDeliveryOption As UspsshipintlNonDeliveryOptions

Enum UspsshipintlNonDeliveryOptions
  ndoReturn
  ndoRedirect
  ndoAbandon
End Enum

Default Value

0

Remarks

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

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

Notes Property (USPSShipIntl Component)

Additional information returned by the USPS Server .

Syntax

• C#
• VB.NET

public string Notes { get; }

Public ReadOnly Property Notes As String

Default Value

""

Remarks

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

This property is read-only.

Observations Property (USPSShipIntl Component)

Additional mailing information based on country of destination.

Syntax

• C#
• VB.NET

public string Observations { get; }

Public ReadOnly Property Observations As String

Default Value

""

Remarks

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

This property is read-only.

Packages Property (USPSShipIntl Component)

A collection of packages contained in the shipment.

Syntax

• C#
• VB.NET

public PackageDetailList Packages { get; }

Public Property Packages As PackageDetailList

Remarks

At least one package must be specified.

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

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

Note: USPS only supports one package per shipment.

This property is not available at design time.

PermitNumber Property (USPSShipIntl Component)

Permit number to print Postage Due labels.

Syntax

• C#
• VB.NET

public string PermitNumber { get; set; }

Public Property PermitNumber As 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.

PostageProvider Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public UspsshipintlPostageProviders PostageProvider { get; set; }

enum UspsshipintlPostageProviders {
  ppNone,
  ppEndicia,
  ppStamps
}

Public Property PostageProvider As UspsshipintlPostageProviders

Enum UspsshipintlPostageProviders
  ppNone
  ppEndicia
  ppStamps
End Enum

Default Value

0

Remarks

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

• Set UserId
• Set Password
• Set Server

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

For Production

• Set AccountNumber
• Set Password

For Testing

• Set EndiciaTestMode

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

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

PriceOption Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public UspsshipintlPriceOptions PriceOption { get; set; }

enum UspsshipintlPriceOptions {
  poRetail,
  poCommercialPlus,
  poCommercialBase
}

Public Property PriceOption As UspsshipintlPriceOptions

Enum UspsshipintlPriceOptions
  poRetail
  poCommercialPlus
  poCommercialBase
End Enum

Default Value

2

Remarks

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

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

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

Possible values are as follows:

Prohibitions Property (USPSShipIntl Component)

List of items prohibited from mailing to the destination country.

Syntax

• C#
• VB.NET

public string Prohibitions { get; }

Public ReadOnly Property Prohibitions As String

Default Value

""

Remarks

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

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

This property is read-only.

Proxy Property (USPSShipIntl Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

RecipientAddress Property (USPSShipIntl Component)

Identifies the recipient's address.

Syntax

• C#
• VB.NET

public AddressDetail RecipientAddress { get; set; }

Public Property RecipientAddress As AddressDetail

Remarks

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

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

RecipientContact Property (USPSShipIntl Component)

Identifies the recipient's contact info.

Syntax

• C#
• VB.NET

public ContactDetail RecipientContact { get; set; }

Public Property RecipientContact As ContactDetail

Remarks

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

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

RecipientCustomsReference Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public string RecipientCustomsReference { get; set; }

Public Property RecipientCustomsReference As String

Default Value

""

Remarks

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

Regulations Property (USPSShipIntl Component)

Additional regulations for shipping to the destination country.

Syntax

• C#
• VB.NET

public string Regulations { get; }

Public ReadOnly Property Regulations As String

Default Value

""

Remarks

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

This property is read-only.

Restrictions Property (USPSShipIntl Component)

Restrictions on items being shipped based on country of destination

Syntax

• C#
• VB.NET

public string Restrictions { get; }

Public ReadOnly Property Restrictions As String

Default Value

""

Remarks

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

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

This property is read-only.

SDRValue Property (USPSShipIntl Component)

Special Drawing Right calculated on TotalValue .

Syntax

• C#
• VB.NET

public string SDRValue { get; }

Public ReadOnly Property SDRValue As String

Default Value

""

Remarks

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

This property is read-only.

SenderAddress Property (USPSShipIntl Component)

Identifies the sender's address.

Syntax

• C#
• VB.NET

public AddressDetail SenderAddress { get; set; }

Public Property SenderAddress As AddressDetail

Remarks

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

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

SenderContact Property (USPSShipIntl Component)

Identifies the sender's contact info.

Syntax

• C#
• VB.NET

public ContactDetail SenderContact { get; set; }

Public Property SenderContact As ContactDetail

Remarks

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

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

SenderCustomsReference Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public string SenderCustomsReference { get; set; }

Public Property SenderCustomsReference As String

Default Value

""

Remarks

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

ServiceType Property (USPSShipIntl Component)

The mail service type when shipping to the CountryCode .

Syntax

• C#
• VB.NET

public ServiceTypes ServiceType { get; set; }

enum UspsshipintlServiceTypes {
  stUnspecified,
  stFedExPriorityOvernight,
  stFedExStandardOvernight,
  stFedExFirstOvernight,
  stFedEx2Day,
  stFedExExpressSaver,
  stFedExGround,
  stFedExGroundHomeDelivery,
  stFedEx1DayFreight,
  stFedEx2DayFreight,
  stFedEx3DayFreight,
  stFedExInternationalPriority,
  stFedExInternationalEconomy,
  stFedExInternationalFirst,
  stFedExInternationalPriorityFreight,
  stFedExInternationalEconomyFreight,
  stFedExEuropeFirstInternationalPriority,
  stFedExSmartPost,
  stFedEx2DayAM,
  stFedExFirstFreight,
  stFedExInternationalGround,
  stFedExFreightEconomy,
  stFedExFreightPriority,
  stFedExInternationalPriorityExpress,
  stFedExInternationalConnectPlus,
  stUPSFirstClass,
  stUPSPriorityMail,
  stUPSExpeditedMailInnovations,
  stUPSPriorityMailInnovations,
  stUPSEconomyMailInnovations,
  stUPSNextDayAir,
  stUPSExpress,
  stUPS2ndDayAir,
  stUPSGround,
  stUPSWorldwideExpress,
  stUPSWorldwideExpedited,
  stUPSExpedited,
  stUPSStandard,
  stUPS3DaySelect,
  stUPSNextDayAirSaver,
  stUPSSaver,
  stUPSNextDayAirEarlyAM,
  stUPSExpressEarlyAM,
  stUPSWorldwideExpressPlus,
  stUPSExpressPlus,
  stUPS2ndDayAirAM,
  stUPSTodayStandard,
  stUPSTodayCourrier,
  stUPSTodayInterCity,
  stUPSTodayExpress,
  stUPSTodayExpressSaver,
  stUPSWorldwideExpressFreight,
  stUPSSurePostLessThan1LB,
  stUPSSurePost1LBOrGreater,
  stUPSSurePostBPM,
  stUPSSurePostMedia,
  stUSPSExpress,
  stUSPSFirstClass,
  stUSPSPriority,
  stUSPSParcelPost,
  stUSPSBPM,
  stUSPSMedia,
  stUSPSLibrary,
  stUSPSOnline,
  stUSPSGlobalExpress,
  stUSPSParcelSelect,
  stUSPSCriticalMail,
  stUSPSStandardMail,
  stUSPSExpressMailInternational,
  stUSPSFirstClassMailInternational,
  stUSPSPriorityMailInternational,
  stUSPSPriorityExpress,
  stUSPSRetailGround,
  stUSPSFirstClassPackageInternationalService,
  stUSPSPriorityMailExpressInternational,
  stCanadaRegularParcel,
  stCanadaExpeditedParcel,
  stCanadaXpresspost,
  stCanadaLibrary,
  stCanadaPriority,
  stCanadaPriorityEnvelopeUSA,
  stCanadaPriorityPakUSA,
  stCanadaPriorityParcelUSA,
  stCanadaXpresspostUSA,
  stCanadaExpeditedParcelUSA,
  stCanadaSmallPacketAirUSA,
  stCanadaTrackedPacketUSA,
  stCanadaTrackedPacketLVMUSA,
  stCanadaPriorityEnvelopeInternational,
  stCanadaPriorityPakInternational,
  stCanadaPriorityParcelInternational,
  stCanadaXpresspostInternational,
  stCanadaSmallPacketAirInternational,
  stCanadaSmallPacketLandInternational,
  stCanadaParcelAirInternational,
  stCanadaParcelLandInternational,
  stCanadaTrackedPacketInternational,
  stFedExSameDay,
  stFedExSameDayCity,
  stFedExSameDayMetroAfternoon,
  stFedExSameDayMetroMorning,
  stFedExSameDayMetroRush,
  stUPSWorldwideEconomyDDU,
  stUPSWorldwideEconomyDDP,
  stUSPSParcelSelectGround,
  stUSPSPriorityMailCubic,
  stUSPSGroundAdvantage,
  stUSPSGroundAdvantageCubic,
  stFedExFirst,
  stFedExPriority,
  stFedExPriorityExpress,
  stFedExPriorityExpressFreight,
  stFedExPriorityFreight,
  stFedExEconomySelect
}

Public Property ServiceType As ServiceTypes

Enum UspsshipintlServiceTypes
  stUnspecified
  stFedExPriorityOvernight
  stFedExStandardOvernight
  stFedExFirstOvernight
  stFedEx2Day
  stFedExExpressSaver
  stFedExGround
  stFedExGroundHomeDelivery
  stFedEx1DayFreight
  stFedEx2DayFreight
  stFedEx3DayFreight
  stFedExInternationalPriority
  stFedExInternationalEconomy
  stFedExInternationalFirst
  stFedExInternationalPriorityFreight
  stFedExInternationalEconomyFreight
  stFedExEuropeFirstInternationalPriority
  stFedExSmartPost
  stFedEx2DayAM
  stFedExFirstFreight
  stFedExInternationalGround
  stFedExFreightEconomy
  stFedExFreightPriority
  stFedExInternationalPriorityExpress
  stFedExInternationalConnectPlus
  stUPSFirstClass
  stUPSPriorityMail
  stUPSExpeditedMailInnovations
  stUPSPriorityMailInnovations
  stUPSEconomyMailInnovations
  stUPSNextDayAir
  stUPSExpress
  stUPS2ndDayAir
  stUPSGround
  stUPSWorldwideExpress
  stUPSWorldwideExpedited
  stUPSExpedited
  stUPSStandard
  stUPS3DaySelect
  stUPSNextDayAirSaver
  stUPSSaver
  stUPSNextDayAirEarlyAM
  stUPSExpressEarlyAM
  stUPSWorldwideExpressPlus
  stUPSExpressPlus
  stUPS2ndDayAirAM
  stUPSTodayStandard
  stUPSTodayCourrier
  stUPSTodayInterCity
  stUPSTodayExpress
  stUPSTodayExpressSaver
  stUPSWorldwideExpressFreight
  stUPSSurePostLessThan1LB
  stUPSSurePost1LBOrGreater
  stUPSSurePostBPM
  stUPSSurePostMedia
  stUSPSExpress
  stUSPSFirstClass
  stUSPSPriority
  stUSPSParcelPost
  stUSPSBPM
  stUSPSMedia
  stUSPSLibrary
  stUSPSOnline
  stUSPSGlobalExpress
  stUSPSParcelSelect
  stUSPSCriticalMail
  stUSPSStandardMail
  stUSPSExpressMailInternational
  stUSPSFirstClassMailInternational
  stUSPSPriorityMailInternational
  stUSPSPriorityExpress
  stUSPSRetailGround
  stUSPSFirstClassPackageInternationalService
  stUSPSPriorityMailExpressInternational
  stCanadaRegularParcel
  stCanadaExpeditedParcel
  stCanadaXpresspost
  stCanadaLibrary
  stCanadaPriority
  stCanadaPriorityEnvelopeUSA
  stCanadaPriorityPakUSA
  stCanadaPriorityParcelUSA
  stCanadaXpresspostUSA
  stCanadaExpeditedParcelUSA
  stCanadaSmallPacketAirUSA
  stCanadaTrackedPacketUSA
  stCanadaTrackedPacketLVMUSA
  stCanadaPriorityEnvelopeInternational
  stCanadaPriorityPakInternational
  stCanadaPriorityParcelInternational
  stCanadaXpresspostInternational
  stCanadaSmallPacketAirInternational
  stCanadaSmallPacketLandInternational
  stCanadaParcelAirInternational
  stCanadaParcelLandInternational
  stCanadaTrackedPacketInternational
  stFedExSameDay
  stFedExSameDayCity
  stFedExSameDayMetroAfternoon
  stFedExSameDayMetroMorning
  stFedExSameDayMetroRush
  stUPSWorldwideEconomyDDU
  stUPSWorldwideEconomyDDP
  stUSPSParcelSelectGround
  stUSPSPriorityMailCubic
  stUSPSGroundAdvantage
  stUSPSGroundAdvantageCubic
  stFedExFirst
  stFedExPriority
  stFedExPriorityExpress
  stFedExPriorityExpressFreight
  stFedExPriorityFreight
  stFedExEconomySelect
End Enum

Default Value

0

Remarks

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

Possible values are:

This property is not available at design time.

ShipDate Property (USPSShipIntl Component)

Date package will be mailed.

Syntax

• C#
• VB.NET

public string ShipDate { get; set; }

Public Property ShipDate As 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

ShipmentSpecialServices Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public long ShipmentSpecialServices { get; set; }

Public Property ShipmentSpecialServices As Long

Default Value

0

Remarks

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

SSLAcceptServerCert Property (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

SSLCert Property (USPSShipIntl Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

SSLProvider Property (USPSShipIntl Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public UspsshipintlSSLProviders SSLProvider { get; set; }

enum UspsshipintlSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As UspsshipintlSSLProviders

Enum UspsshipintlSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component 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:

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

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (USPSShipIntl Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (USPSShipIntl Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As 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 component will wait for the operation to complete before returning control.

The component 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 component throws an exception.

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

The default value for the Timeout property is 60 seconds.

TotalValue Property (USPSShipIntl Component)

Total value of all items being shipped.

Syntax

• C#
• VB.NET

public string TotalValue { get; }

Public ReadOnly Property TotalValue As String

Default Value

""

Remarks

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

This property is read-only.

TransactionId Property (USPSShipIntl Component)

The transaction Id.

Syntax

• C#
• VB.NET

public string TransactionId { get; set; }

Public Property TransactionId As 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.

USPSAccount Property (USPSShipIntl Component)

Login information for USPS.

Syntax

• C#
• VB.NET

public USPSAccount USPSAccount { get; set; }

Public Property USPSAccount As USPSAccount

Remarks

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

CancelPackage Method (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public string CancelPackage(string barcodeNumber);

Public Function CancelPackage(ByVal BarcodeNumber As String) As String

Remarks

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

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

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

Config Method (USPSShipIntl Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

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

• C#
• VB.NET

public void GetPackageLabel();

Public Sub GetPackageLabel()

Remarks

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

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

This method fills the following properties:

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

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

Reset Method (USPSShipIntl Component)

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

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

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

Error Event (USPSShipIntl Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, UspsshipintlErrorEventArgs e);

public class UspsshipintlErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As UspsshipintlErrorEventArgs)

Public Class UspsshipintlErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, UspsshipintlNotificationEventArgs e);

public class UspsshipintlNotificationEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As UspsshipintlNotificationEventArgs)

Public Class UspsshipintlNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

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

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, UspsshipintlSSLServerAuthenticationEventArgs e);

public class UspsshipintlSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As UspsshipintlSSLServerAuthenticationEventArgs)

Public Class UspsshipintlSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, UspsshipintlSSLStatusEventArgs e);

public class UspsshipintlSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As UspsshipintlSSLStatusEventArgs)

Public Class UspsshipintlSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

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

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

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public AddressDetail();

Public AddressDetail()

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

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

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

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

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

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

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

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

• C#
• VB.NET

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

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

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

CommodityDetail Type

Represents a single commodity line item.

Remarks

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

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

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

The fields contained by this type are listed below.

Fields