USPSShip Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS domestic services complete with addresses and barcode, or manage pickups. To get a label with USPS, postage must be paid. To get a label with postage you must use ppNone , ppEndicia , or ppStamps as your . Note that when is set to ppNone the method will generate an eVS label. The eVS (or Electronic Verification System) Label API allows high-volume package mailers and package consolidators to document and pay postage, including special service fees, using electronic manifest files.

Syntax

DPayments.DShippingSDK.Uspsship

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 other special services you want to associate the shipment (such as Return Shipment, etc.).

This is useful if you have your own Postnet barcode generating software.

In addition, the component can submit a request for your carrier to pick up packages from your current location. You can schedule multiple pickups and edit or cancel previously submitted pickups, and even electronically determine if carrier pickup is available at your current address.

The following methods are available for scheduling carrier pickups:

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.

AddressServiceRequest Property (USPSShip Component)

Indicates if an address service request is made.

Syntax

• C#
• VB.NET

public bool AddressServiceRequest { get; set; }

Public Property AddressServiceRequest As Boolean

Default Value

False

Remarks

The value of this property is optional. False is assumed if no value is entered.

By setting this property to True, you can request the USPS to alert you when a customer changes their address. This feature is especially useful to ensure correct billing. The words "Address Service Requested" will appear on the shipping label immediately below the return address.

By using this option, you will receive the following service with Priority Mail:

• For 12 months after an address change, the mail piece is forwarded at no charge. However, a separate notice of the new address is returned to you and an address correction fee is charged.
• For 13-18 months after an address change, the mail piece is returned with the new address attached at no charge.
• After 18 months, or if undeliverable, the mail piece is returned with the reason for nondelivery attached at no charge.

BarcodeNumber Property (USPSShip 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.

Contents Property (USPSShip Component)

Type of the contents in the package.

Syntax

• C#
• VB.NET

public UspsshipContents Contents { get; set; }

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

Public Property Contents As UspsshipContents

Enum UspsshipContents
  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 ctLives, you must also set the ContentDescription configuration setting. For example:

component.Contents = ctLives; component.Config("ContentDescription=0");

CountExpress Property (USPSShip Component)

The number of Express Mail packages to be picked up.

Syntax

• C#
• VB.NET

public int CountExpress { get; set; }

Public Property CountExpress As Integer

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountInternational, and CountOther properties to indicate such.

The maximum count is 999 packages.

CountInternational Property (USPSShip Component)

The number of International Mail packages to be picked up.

Syntax

• C#
• VB.NET

public int CountInternational { get; set; }

Public Property CountInternational As Integer

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountExpress, and CountOther properties to indicate such.

The maximum count is 999 packages.

CountOther Property (USPSShip Component)

The number of packages to be picked up for a service type other than Priority/Express/International Mail.

Syntax

• C#
• VB.NET

public int CountOther { get; set; }

Public Property CountOther As Integer

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountExpress, CountInternational properties to indicate such.

The maximum count is 999 packages.

CountPriority Property (USPSShip Component)

The number of Priority Mail packages to be picked up.

Syntax

• C#
• VB.NET

public int CountPriority { get; set; }

Public Property CountPriority As Integer

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountExpress, CountInternational, and CountOther properties to indicate such.

The maximum count is 999 packages.

CustomerId Property (USPSShip 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.

CustomerReceipt Property (USPSShip Component)

Image of the Customer Online Record.

Syntax

• C#
• VB.NET

public string CustomerReceipt { get; }
public byte[] CustomerReceiptB { get; }

Public ReadOnly Property CustomerReceipt As String
Public ReadOnly Property CustomerReceiptB As Byte()

Default Value

""

Remarks

If you want to have the Customer Online Label Record and ShippingLabel in separate image files, you can accomplish this by setting the ReceiptOption property to 1 (meaning "SEPARATE PAGE"). This image can be generated in PDF or TIF format. The image type is determined by setting LabelImageType property prior to submitting the request.

The Customer Receipt must be presented when filing an indemnity claim and/or for a postage refund.

This property is read-only.

CustomerReceiptFile Property (USPSShip Component)

Filename for CustomerReceipt (optional).

Syntax

• C#
• VB.NET

public string CustomerReceiptFile { get; set; }

Public Property CustomerReceiptFile As String

Default Value

""

Remarks

When this property is set to a valid filename, the contents of the CustomerReceipt property are written into the file.

The file will be saved in the format defined by the value of LabelImageType property, and the filename should include the appropriate extension.

DeliveryOption Property (USPSShip Component)

Indicates the type of delivery option for USPS eVS Domestic shipments.

Syntax

• C#
• VB.NET

public UspsshipDeliveryOptions DeliveryOption { get; set; }

enum UspsshipDeliveryOptions {
  edoNormal,
  edoNoWeekend,
  edoNoHoliday,
  edoNoWeekend_OR_Holiday,
  edoNoSaturday,
  edoNoSunday,
  edoSunday,
  edoHoliday,
  edoNoSunday_OR_Holiday,
  edoScheduledEndofDay,
  edoScheduledEndofDay_NoSunday_OR_Holiday,
  edoScheduledEndofDay_NoWeekend_OR_Holiday
}

Public Property DeliveryOption As UspsshipDeliveryOptions

Enum UspsshipDeliveryOptions
  edoNormal
  edoNoWeekend
  edoNoHoliday
  edoNoWeekend_OR_Holiday
  edoNoSaturday
  edoNoSunday
  edoSunday
  edoHoliday
  edoNoSunday_OR_Holiday
  edoScheduledEndofDay
  edoScheduledEndofDay_NoSunday_OR_Holiday
  edoScheduledEndofDay_NoWeekend_OR_Holiday
End Enum

Default Value

1

Remarks

Note that this property is valid when ServiceType is stUSPSPriorityExpress (85) and PostageProvider is set to ppNone.

The default value for this property is edoNormal.

Possible values are as follows:

ExtraServices Property (USPSShip 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 (USPSShip 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.

InsuranceCost Property (USPSShip Component)

Insurance fee for the package being shipped.

Syntax

• C#
• VB.NET

public string InsuranceCost { get; }

Public ReadOnly Property InsuranceCost As String

Default Value

""

Remarks

This is a computed cost of insurance based on the value specified in InsuredValue.

The value of this property is filled after a call to the GetPackageLabel method only when the Return Shipment flag has been set in the ShipmentSpecialServices property.

This property is read-only.

LabelImageType Property (USPSShip Component)

Type of label image.

Syntax

• C#
• VB.NET

public UspsshipLabelImageTypes LabelImageType { get; set; }

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

Public Property LabelImageType As UspsshipLabelImageTypes

Enum UspsshipLabelImageTypes
  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)

LabelOption Property (USPSShip Component)

Indicates type of label the USPS Server will return.

Syntax

• C#
• VB.NET

public string LabelOption { get; set; }

Public Property LabelOption As String

Default Value

""

Remarks

For Delivery and Signature confirmation, the USPS Server may return either an entire label with the 'To' and 'From' address and the confirmation barcode, or a label with only the barcode and tracking number may be returned. Label options 1 and 2 are available for both Delivery Confirmation labels and Signature Confirmation labels. Detailed descriptions of these label options are included below.

Machinable Property (USPSShip Component)

Indicates if shipment is machinable or not.

Syntax

• C#
• VB.NET

public UspsshipMachinables Machinable { get; set; }

enum UspsshipMachinables {
  moTrue,
  moFalse,
  moIrregular
}

Public Property Machinable As UspsshipMachinables

Enum UspsshipMachinables
  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 (USPSShip 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.

Notify Property (USPSShip Component)

Collection of e-mail notifications to be sent.

Syntax

• C#
• VB.NET

public NotifyDetailList Notify { get; }

Public Property Notify As NotifyDetailList

Remarks

The Notify is optional to be provided in a ship request. This should be set only if the shipper wants to send e-mail notifications.

For each idx = 0 to NotifyCount - 1 (where NotifyCount<=2), this must be set to an instance of the NotifyDetail type, which will contain specific information about the notification to be e-mailed. See the NotifyDetail type for more information.

Each notification has a: RecipientType, Email, and Name tied to it. The only valid recipient types for USPS are rtRecipient and rtShipper.

For instance, if only one notification is requested to be sent:

component.Notify[0].Email = "test@test.com"; component.Notify[0].RecipientType = rtShipper; component.Notify[0].Name = "My Name";

This property is not available at design time.

PackageLocation Property (USPSShip Component)

The location of pickup.

Syntax

• C#
• VB.NET

public UspsshipPackageLocations PackageLocation { get; set; }

enum UspsshipPackageLocations {
  plNotSet,
  plFrontDoor,
  plBackDoor,
  plSideDoor,
  plKnockOnDoor,
  plMailRoom,
  plOffice,
  plReception,
  plInMailbox,
  plOther
}

Public Property PackageLocation As UspsshipPackageLocations

Enum UspsshipPackageLocations
  plNotSet
  plFrontDoor
  plBackDoor
  plSideDoor
  plKnockOnDoor
  plMailRoom
  plOffice
  plReception
  plInMailbox
  plOther
End Enum

Default Value

0

Remarks

This property is required when the following methods are called:

• SchedulePickup (required)
• ChangePickup (optional)
• CancelPickup (optional)

• PickupInquiry method call.

The allowed values to be selected are: Front Door, Back Door, Side Door, Knock on Door/Ring Bell, Mail Room, Office, Reception, In/At Mailbox, Other

Note: When plOther is selected, the SpecialInstructions property is required to be entered.

Packages Property (USPSShip 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.

PermitIssuingPOAddress Property (USPSShip Component)

Address of the Post Office that issued the permit.

Syntax

• C#
• VB.NET

public AddressDetail PermitIssuingPOAddress { get; set; }

Public Property PermitIssuingPOAddress As AddressDetail

Remarks

Sending postage due packages requires a permit with a US Post Office. This property should contain the address of the post office that issued the permit.

The only necessary fields to be set for this type are the City, State, and ZipCode.

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

PermitNumber Property (USPSShip 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.

PostageDueAddress Property (USPSShip Component)

Address of the Postage Due Unit (on the delivery address).

Syntax

• C#
• VB.NET

public AddressDetail PostageDueAddress { get; set; }

Public Property PostageDueAddress As AddressDetail

Remarks

This is the address of the Postage Due Unit, which the shipping label will be addressed to. The package will be delivered to the post office that issued your permit, and postage due will be charged. This property is required when the Return Shipment flag has been set in the ShipmentSpecialServices property and appears on the Return Label.

The Address1 field MUST contain the PO Box number of Postage Due Unit.

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

PostageProvider Property (USPSShip 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 UspsshipPostageProviders PostageProvider { get; set; }

enum UspsshipPostageProviders {
  ppNone,
  ppEndicia,
  ppStamps
}

Public Property PostageProvider As UspsshipPostageProviders

Enum UspsshipPostageProviders
  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

PostalZone Property (USPSShip Component)

Indicates the number of postal rate zones between the origin and destination zip codes.

Syntax

• C#
• VB.NET

public string PostalZone { get; }

Public ReadOnly Property PostalZone As String

Default Value

""

Remarks

The Postal Zone (which might be "Local" or "0 through 8") identifies the appropriate distance code assigned to each origination and destination Zip Code pairing for every Zip Code in the nation. These zones are used for Priority Mail packages over 5 lbs.

The value of this property is filled by the response from the USPS server.

This property is read-only.

PriceOption Property (USPSShip Component)

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

Syntax

• C#
• VB.NET

public UspsshipPriceOptions PriceOption { get; set; }

enum UspsshipPriceOptions {
  poRetail,
  poCommercialPlus,
  poCommercialBase
}

Public Property PriceOption As UspsshipPriceOptions

Enum UspsshipPriceOptions
  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:

Proxy Property (USPSShip 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 (USPSShip 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 (USPSShip 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.

RMABarcode Property (USPSShip Component)

Indicates whether to print the RMANumber as a barcode on the label.

Syntax

• C#
• VB.NET

public bool RMABarcode { get; set; }

Public Property RMABarcode As Boolean

Default Value

False

Remarks

The RMA number entered by the user through the RMANumber property can also appear as a US128C barcode on the label. If you wish to see the number displayed as a barcode on the label, set this property to True. Enter False if no barcode is desired.

RMANumber Property (USPSShip Component)

Return Materials Authorization number.

Syntax

• C#
• VB.NET

public string RMANumber { get; set; }

Public Property RMANumber As String

Default Value

""

Remarks

The value of this optional property may be any combination of alphanumerical characters, up to a maximum length of 30. If entered, this number will appear on the Return Label.

Assigning an RMA number to each package at the time an agreement is made with a customer (to have merchandise returned), enables retailers to provide a closed-loop correlation between receipt of returned packages and records of the order, typically kept in an order-processing database.

SenderAddress Property (USPSShip 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 (USPSShip 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.

SeparateReceipt Property (USPSShip Component)

Indicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages.

Syntax

• C#
• VB.NET

public bool SeparateReceipt { get; set; }

Public Property SeparateReceipt As Boolean

Default Value

False

Remarks

The value of this property is optional on all methods calls. Use SeparateReceipt property to request shipping label & Customer Online Record be printed on 2 separate pages. Enter True if you want this option, or False is you want those to be printed on the same single page. False is assumed if no value is entered.

ServiceType Property (USPSShip Component)

Identifies the USPS service type (applicable to US domestic shipments) to use in a ship request.

Syntax

• C#
• VB.NET

public ServiceTypes ServiceType { get; set; }

enum UspsshipServiceTypes {
  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 UspsshipServiceTypes
  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.

Valid values for USPS are:

Please note that the ServiceType stUSPSBPM (74) is no longer supported by Endicia.

This property is not available at design time.

ShipDate Property (USPSShip 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 (USPSShip 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 (USPSShip 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 (USPSShip 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 (USPSShip Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public UspsshipSSLProviders SSLProvider { get; set; }

enum UspsshipSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As UspsshipSSLProviders

Enum UspsshipSSLProviders
  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 (USPSShip 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.

StandardizeAddress Property (USPSShip Component)

Checks the delivery address against the USPS Address Matching System.

Syntax

• C#
• VB.NET

public bool StandardizeAddress { get; set; }

Public Property StandardizeAddress As Boolean

Default Value

False

Remarks

Set StandardizeAddress to True if you want the component to check the delivery address for accuracy. Identified errors will be returned to allow you to correct them.

Timeout Property (USPSShip 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.

TotalWeight Property (USPSShip Component)

The estimated weight for the package to be picked up.

Syntax

• C#
• VB.NET

public int TotalWeight { get; set; }

Public Property TotalWeight As Integer

Default Value

0

Remarks

Enter the total estimated aggregate weight (in pounds) of all packages being picked up.

This property is required when the following methods are called:

• SchedulePickup
• ChangePickup

• PickupInquiry method call.

TransactionId Property (USPSShip 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 (USPSShip 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 (USPSShip 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.

CancelPickup Method (USPSShip Component)

Cancels a scheduled Carrier Pickup request.

Syntax

• C#
• VB.NET

public string CancelPickup(string confirmationNumber);

Public Function CancelPickup(ByVal ConfirmationNumber As String) As String

Remarks

When the CancelPickup method is called, the exact data from the original SchedulePickup request must be entered.

You must enter the following information:

• ConfirmationNumber (required)
• Company (optional)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode(required)

The confirmation number alone cannot be used to cancel or change a scheduled pickup. You must also supply address information that is identical to what was originally entered when the pickup was scheduled with SchedulePickup.

If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method fills the original pickup address and tracking number as well as the Status property.

You may submit your cancellation to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be canceled online.

If you miss the deadline for canceling your pickup, or if you did not save the ConfirmationNumber or address information, you should put a note at the PackageLocation you specified in the original SchedulePickup request explaining that you wish to cancel the pickup.

The return value for this method is a string containing the status of the cancellation.

ChangePickup Method (USPSShip Component)

Changes requested data in your original Pickup Schedule request and schedules a new pickup.

Syntax

• C#
• VB.NET

public string ChangePickup(string confirmationNumber);

Public Function ChangePickup(ByVal ConfirmationNumber As String) As String

Remarks

When the ChangePickup method is called, the exact data from the original SchedulePickup request must be entered, with whatever changes you wish to enter. It is recommended that you first send a PickupInquiry to fill all the properties, edit the property you wish to change, and then submit a ChangePickup request.

At the minimum, you must enter the pickup address information, number of packages for the service requested, estimated weight, package location, weight, special pickup instructions and confirmation number. The confirmation number alone cannot be used to cancel or change a scheduled pickup.

The name and phone number of the sender can be changed, along with the number and types of package services, weight, and the location of the pickup.

Address data and the confirmation number cannot be changed and must be identical to the original SchedulePickup request (supplied to and returned by SchedulePickup method when first called).

After a successful call, this method fills the following properties:

• ConfirmationNumber (required)
• FirstName (required)
• LastName (required)
• Company (optional)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode(required)
• Phone (optional)
• TotalWeight (required - value may be changed from the original request)
• CountExpress (optional if CountPriority is provided - value may be changed from the original request)
• CountPriority (optional if CountExpress is provided - value may be changed from the original request)
• CountInternational (optional - value may be changed from the original request)
• CountOther (optional - value may be changed from the original request)
• PackageLocation (required - value may be changed from the original request)
• SpecialInstructions (optional - value may be changed from the original request)

To verify the accuracy of your data, you can call the PickupInquiry method. However, the confirmation number cannot be retrieved online. If you need to change or cancel your Carrier Pickup request, please leave notification (at the Package Location you indicated in your Carrier Pickup request) that provides details of your Carrier Pickup change or cancellation.

If the information entered is valid (matches the existing record and is within the time frames available for pickup change), this method will return the Status of the request and fill the sender's information and pickup address (properties listed above), and also the following properties:

• TotalWeight
• CountExpress
• CountPriority
• CountInternational
• CountOther
• PackageLocation
• SpecialInstructions
• ConfirmationNumber
• ShipDate
• CarrierRoute

You may submit your changes to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be changed online.

Config Method (USPSShip 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 (USPSShip 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:

• Server (required)
• AccountNumber (required for Endicia shipments)
• UserId (required)
• Password (required)
• LabelImageType (required)
• SenderAddress (required)
• SenderContact (optional)
• RecipientAddress (required)
• RecipientContact (optional)
• Packages (required)
• ServiceType (required)
• ExtraServices (optional)
• Contents (required)
• ContentDescription (optional)
• PriceOption (optional)
• Machinable (optional)
• DeliveryOption (optional)
• Notify (optional)
• PackageNumber (optional)
• TotalPackages (optional)
• ShipDate (optional)
• HoldForManifest (optional)
• MailingLocation (optional)
• CustomerId (optional)
• CRID (optional)
• MID (optional)
• LogisticsManagerMID (optional)

This method fills in the following fields:

• TrackingNumber
• BarcodeNumber
• ShippingLabel
• NetCharge (only for Endicia and Express labels);
• ShipDate (only for Endicia)
• CustomerReceipt

PickupAvailability Method (USPSShip Component)

Checks the availability of a Carrier Pickup service for the given address.

Syntax

• C#
• VB.NET

public void PickupAvailability();

Public Sub PickupAvailability()

Remarks

The PickupAvailability method requires the values for the following properties:

• Company (optional)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode (either the ZipCode or City and State are required)

After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your packages:

• ShipDate
• CarrierRoute

PickupInquiry Method (USPSShip Component)

Retrieves the data submitted in your original SchedulePickup request.

Syntax

• C#
• VB.NET

public void PickupInquiry(string confirmationNumber);

Public Sub PickupInquiry(ByVal ConfirmationNumber As String)

Remarks

This method requires: the exact pickup address and confirmation number returned in the SchedulePickup request (when the SchedulePickup method was called). This method will fill the following properties:

• Company (optional)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode (either the ZipCode or City and State are required)
• ConfirmationNumber (required)

On valid request, returns the information that was originally entered in SchedulePickup call: the sender's information and pickup address (properties listed above) and also the following:

• TotalWeight
• CountExpress
• CountPriority
• CountInternational
• CountOther
• ShipDate
• ConfirmationNumber
• PackageLocation
• SpecialInstructions

The PickupInquiry method is very useful for the ChangePickup request. PickupInquiry will retrieve the data from your original request, and you can then change whatever properties you like and then call ChangePickup.

Reset Method (USPSShip 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.

SchedulePickup Method (USPSShip Component)

Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup.

Syntax

• C#
• VB.NET

public string SchedulePickup();

Public Function SchedulePickup() As String

Remarks

This method allows users to make a Carrier Pickup request.

The SchedulePickup method requires the values for the following properties:

• FirstName (required)
• LastName (required)
• Company (optional)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode(required)
• Phone (required)
• TotalWeight (required)
• CountExpress (optional if CountPriority is provided)
• CountPriority (optional if CountExpress is provided)
• CountInternational (optional)
• CountOther (optional)
• PackageLocation (required)
• SpecialInstructions (optional)

After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your

• ShipDate
• CarrierRoute

Prior to making a SchedulePickup call, it is recommended to first call the PickupAvailability method to confirm that the pickup service is available.

There must be at least one Express Mail Package or Priority Mail package to make this call a valid request. Either one of the CountPriority, CountExpress, CountInternational or CountOther properties are required for a valid request.

The Confirmation Number will be returned after a successful request.

Error Event (USPSShip Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class UspsshipErrorEventArgs 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 (USPSShip 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, UspsshipNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

Public Class UspsshipNotificationEventArgs 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 (USPSShip 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, UspsshipSSLServerAuthenticationEventArgs e);

public class UspsshipSSLServerAuthenticationEventArgs : 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 UspsshipSSLServerAuthenticationEventArgs)

Public Class UspsshipSSLServerAuthenticationEventArgs 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 (USPSShip Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

Public Class UspsshipSSLStatusEventArgs 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.

ContactDetail Type

Represents the contact information.

Remarks

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

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

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public ContactDetail();

Public ContactDetail()

• C#
• VB.NET

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

Public ContactDetail(ByVal FirstName As String, ByVal LastName As String, ByVal Phone As String)

• C#
• VB.NET

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

Public ContactDetail(ByVal FirstName As String, ByVal LastName As String, ByVal Phone As String, ByVal Email As String)

• C#
• VB.NET

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

Public ContactDetail(ByVal FirstName As String, ByVal LastName As String, ByVal Phone As String, ByVal Email As String, ByVal Company As String)

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

NotifyDetail Type

Represents a single recipient to be notified via email.

Remarks

This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public NotifyDetail();

Public NotifyDetail()

• C#
• VB.NET

public NotifyDetail(int notificationFlags, string email, string message);

Public NotifyDetail(ByVal NotificationFlags As Integer, ByVal Email As String, ByVal Message As String)

• C#
• VB.NET

public NotifyDetail(int notificationFlags, string email);

Public NotifyDetail(ByVal NotificationFlags As Integer, ByVal Email As String)

• C#
• VB.NET

public NotifyDetail(int notificationFlags, int recipientType, string email);

Public NotifyDetail(ByVal NotificationFlags As Integer, ByVal RecipientType As Integer, ByVal Email As String)

• C#
• VB.NET

public NotifyDetail(string name);

Public NotifyDetail(ByVal Name As String)

PackageDetail Type

Represents a single package contained in shipment.

Remarks

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

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

The fields contained by this type are listed below.

Fields