UPSFreightShip Component

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Shipment service.

Syntax

DPayments.DShippingSDK.Upsfreightship

Remarks

The UPSFreightShip component allows labels and documents to be generated for a freight shipment. To use the component, populate Documents to specify the type of documents requested. Specify the sender, recipient, commodity and UPS account information before calling GetShipmentDocuments. For instance:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/"; component.UPSAccount.AuthorizationToken = "Bearer token..."; component.UPSAccount.AccountNumber = "000000"; component.SenderContact.Company = "Developer Test 1"; component.SenderContact.Phone = "884530171"; component.SenderAddress.Address1 = "101 Developer Way"; component.SenderAddress.City = "Richmond"; component.SenderAddress.State = "VA"; component.SenderAddress.ZipCode = "23224"; component.SenderAddress.CountryCode = "US"; component.RecipientContact.Company = "Consignee Test 1"; component.RecipientAddress.Address1 = "1000 Consignee Street"; component.RecipientAddress.City = "Allanton"; component.RecipientAddress.State = "MO"; component.RecipientAddress.ZipCode = "63001"; component.RecipientAddress.CountryCode = "US"; component.Payor.PayorType = TPayorTypes.ptSender; component.HandlingUnit = "SKD:1"; CommodityDetail item = new CommodityDetail(); item.Description = "LCD TVS"; item.FreightClass = "77.5"; item.Weight = "150"; item.FreightNMFC = "132680"; item.FreightNMFCSub = "02"; item.NumberOfPieces = 20; item.Value = "100"; component.Commodities.Add(item); DocumentInfo label = new DocumentInfo(); label.FileName = "TestLabel.pdf"; label.PrintFormat = TFreightPrintFormats.fpfLaser; label.PrintSize = TFreightPrintSizes.fpsSize8X11; label.DocumentType = TFreightTypeCodes.ftcLabel; component.Documents.Add(label); component.GetShipmentDocuments(); Console.WriteLine("Total Charge: " + component.TotalCharge); for (int i = 0; i < component.Charges.Count; i++) { Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value); } Console.WriteLine("Billable Weight: " + component.BillableWeight); Console.WriteLine("BOLID: " + component.BOLID); Console.WriteLine("Shipment Number: " + component.ShipmentNumber);

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.

BillableWeight Property (UPSFreightShip Component)

Represents the billable weight associated with the shipment.

Syntax

• C#
• VB.NET

public string BillableWeight { get; }

Public ReadOnly Property BillableWeight As String

Default Value

""

Remarks

This property is read-only.

BOLID Property (UPSFreightShip Component)

The retrieval key for the stored BOL (Bill of Lading).

Syntax

• C#
• VB.NET

public string BOLID { get; }

Public ReadOnly Property BOLID As String

Default Value

""

Remarks

This property holds the retrieval key for the stored BOL (Bill of Lading) as returned by the server.

This property is read-only.

Charges Property (UPSFreightShip Component)

Collection of shipment charges.

Syntax

• C#
• VB.NET

public ChargeDetailList Charges { get; }

Public Property Charges As ChargeDetailList

Remarks

Freight shipments may include various charges. This collection holds information about each of the charges applied to this shipment.

CODPayorType Property (UPSFreightShip Component)

The type of payment that will be used for the COD payment.

Syntax

• C#
• VB.NET

public UpsfreightshipCODPayorTypes CODPayorType { get; set; }

enum UpsfreightshipCODPayorTypes {
  fcodptCollect,
  fcodptPrepaid
}

Public Property CODPayorType As UpsfreightshipCODPayorTypes

Enum UpsfreightshipCODPayorTypes
  fcodptCollect
  fcodptPrepaid
End Enum

Default Value

0

Remarks

This property specifies the type of COD payment. Possible values are:

CODRemitToAddress Property (UPSFreightShip Component)

Specifies the contact address detail of the contact to whom to send COD funds. If not specified, sender address will be used.

Syntax

• C#
• VB.NET

public AddressDetail CODRemitToAddress { get; set; }

Public Property CODRemitToAddress As AddressDetail

Remarks

CODRemitToContact Property (UPSFreightShip Component)

Specifies the contact detail of the contact to whom to send COD funds. If not specified, funds will be sent to the sender.

Syntax

• C#
• VB.NET

public ContactDetail CODRemitToContact { get; set; }

Public Property CODRemitToContact As ContactDetail

Remarks

CODTotalAmount Property (UPSFreightShip Component)

The total amount of additional fees.

Syntax

• C#
• VB.NET

public string CODTotalAmount { get; set; }

Public Property CODTotalAmount As String

Default Value

""

Remarks

UPS Freight handles your payment collections upon delivery and sends the payment to you (if applicable) for an additional charge.

CODType Property (UPSFreightShip Component)

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

Syntax

• C#
• VB.NET

public UpsfreightshipCODTypes CODType { get; set; }

enum UpsfreightshipCODTypes {
  fcodtsCertifiedCheck,
  fcodtsCash,
  fcodtsCompanyCheck
}

Public Property CODType As UpsfreightshipCODTypes

Enum UpsfreightshipCODTypes
  fcodtsCertifiedCheck
  fcodtsCash
  fcodtsCompanyCheck
End Enum

Default Value

0

Remarks

This property specifies the type of COD requested. Possible values are:

Commodities Property (UPSFreightShip Component)

Collection of commodity items of the shipment.

Syntax

• C#
• VB.NET

public CommodityDetailList Commodities { get; }

Public Property Commodities As CommodityDetailList

Remarks

This collection contains details of the commodities associated with the shipment. At least one commodity must be added for international shipments.

For each idx = 0 to CommodityCount - 1, this must be set to an instance of the CommodityDetail type, which will contain specific information about a commodity item contained in the shipment. See the CommodityDetail type for more information.

The following fields are applicable for each commodity item:

Note: The WeightUnit configuration setting may be set to specify KGS instead of LBS for the weight unit.

For instance, to add a commodity: component.Commodities[0].Weight = 1500; component.Commodities[0].FreightClass = "92.5"; component.Commodities[0].FreightNMFC = "116030"; component.Commodities[0].FreightNMFCSub = "1"; component.Commodities[0].NumberOfPieces = 1; component.Commodities[0].Description = "Test Items";

DimensionalWeight Property (UPSFreightShip Component)

Represents the dimensional weight associated with the shipment

Syntax

• C#
• VB.NET

public string DimensionalWeight { get; }

Public ReadOnly Property DimensionalWeight As String

Default Value

""

Remarks

The dimensional weight as calculated by the server and returned in the response.

This property is read-only.

Documents Property (UPSFreightShip Component)

Collection of information about each of the requested documents.

Syntax

• C#
• VB.NET

public DocumentInfoList Documents { get; }

Public Property Documents As DocumentInfoList

Remarks

This collection contains information about the requested documents. Populate this collection to request specific documents such as labels, packing lists, etc. This must be set before calling GetShipmentDocuments. For example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/"; component.UPSAccount.AuthorizationToken = "Bearer token..."; component.UPSAccount.AccountNumber = "000000"; component.SenderContact.Company = "Developer Test 1"; component.SenderContact.Phone = "884530171"; component.SenderAddress.Address1 = "101 Developer Way"; component.SenderAddress.City = "Richmond"; component.SenderAddress.State = "VA"; component.SenderAddress.ZipCode = "23224"; component.SenderAddress.CountryCode = "US"; component.RecipientContact.Company = "Consignee Test 1"; component.RecipientAddress.Address1 = "1000 Consignee Street"; component.RecipientAddress.City = "Allanton"; component.RecipientAddress.State = "MO"; component.RecipientAddress.ZipCode = "63001"; component.RecipientAddress.CountryCode = "US"; component.Payor.PayorType = TPayorTypes.ptSender; component.HandlingUnit = "SKD:1"; CommodityDetail item = new CommodityDetail(); item.Description = "LCD TVS"; item.FreightClass = "77.5"; item.Weight = "150"; item.FreightNMFC = "132680"; item.FreightNMFCSub = "02"; item.NumberOfPieces = 20; item.Value = "100"; component.Commodities.Add(item); DocumentInfo label = new DocumentInfo(); label.FileName = "TestLabel.pdf"; label.PrintFormat = TFreightPrintFormats.fpfLaser; label.PrintSize = TFreightPrintSizes.fpsSize8X11; label.DocumentType = TFreightTypeCodes.ftcLabel; component.Documents.Add(label); component.GetShipmentDocuments(); Console.WriteLine("Total Charge: " + component.TotalCharge); for (int i = 0; i < component.Charges.Count; i++) { Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value); } Console.WriteLine("Billable Weight: " + component.BillableWeight); Console.WriteLine("BOLID: " + component.BOLID); Console.WriteLine("Shipment Number: " + component.ShipmentNumber);

Firewall Property (UPSFreightShip 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.

HandlingUnit Property (UPSFreightShip Component)

Describe the Handling Units (Movable Pieces) in this Shipment.

Syntax

• C#
• VB.NET

public string HandlingUnit { get; set; }

Public Property HandlingUnit As String

Default Value

""

Remarks

HazMatContactName Property (UPSFreightShip Component)

Identifies the contact name for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Syntax

• C#
• VB.NET

public string HazMatContactName { get; set; }

Public Property HazMatContactName As String

Default Value

""

Remarks

This property hold the name of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and FreightIsHazardous is true.

HazMatContactPhone Property (UPSFreightShip Component)

Identifies the contact phone for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Syntax

• C#
• VB.NET

public string HazMatContactPhone { get; set; }

Public Property HazMatContactPhone As String

Default Value

""

Remarks

This property hold the phone number of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and FreightIsHazardous is true.

Notify Property (UPSFreightShip 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 on shipment status, exceptions, and/or delivery status. Up to 3 notification requests can be made within a ship request.

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: NotificationFlags (required), Email (required), Message (optional) tied to it.

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

component.Notify[0].Email = "test@test.com"; component.Notify[0].NotificationFlags = 0x00000001; // On Shipment component.Notify[0].Message = "test";

This property is not available at design time.

OverSeasLeg Property (UPSFreightShip Component)

Identifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico.

Syntax

• C#
• VB.NET

public OverSeasLegDetail OverSeasLeg { get; set; }

Public Property OverSeasLeg As OverSeasLegDetail

Remarks

This must be set to an instance of the OverSeasLegDetail type, which will contain the ShipmentWidth, ShipmentLength and ShipmentHeight etc. See the OverSeasLegDetail type for more information.

Payor Property (UPSFreightShip Component)

Identifies the payor of transportation charges for the shipment.

Syntax

• C#
• VB.NET

public PayorDetail Payor { get; set; }

Public Property Payor As PayorDetail

Remarks

The Payor is required to be provided in a ship request. This must be set to an instance of the PayorDetail type, which will contain the payor details. See the PayorDetail type for more information.

PickupRequester Property (UPSFreightShip Component)

Identifies the pickup requester's contact info. Used with the EarliestPickupTime and LatestPickupTime configuration settings.

Syntax

• C#
• VB.NET

public ContactDetail PickupRequester { get; set; }

Public Property PickupRequester As ContactDetail

Remarks

The PickupRequester is required only if a pickup is requested.

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

Proxy Property (UPSFreightShip Component)

This property includes 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 (UPSFreightShip 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 (UPSFreightShip 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 Company is required to be provided in the request. In domestic shipments: the FirstName and LastName are required when using UPS Next Day Air Early A.M. service. In international shipments: the FirstName and LastName are required when the CountryCode is different than CountryCode, and if Commercial Invoice international form is requested.

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.

References Property (UPSFreightShip Component)

Collection of reference numbers for the shipment.

Syntax

• C#
• VB.NET

public ReferenceDetailList References { get; }

Public ReadOnly Property References As ReferenceDetailList

Remarks

This collection holds the reference numbers that identify the shipment. See ReferenceType for a complete list of possible types of reference numbers returned.

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

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

ServiceType Property (UPSFreightShip Component)

The service selected for the shipment.

Syntax

• C#
• VB.NET

public UpsfreightshipServiceTypes ServiceType { get; set; }

enum UpsfreightshipServiceTypes {
  stUPSFreight,
  stUPSFreightGuaranteed
}

Public Property ServiceType As UpsfreightshipServiceTypes

Enum UpsfreightshipServiceTypes
  stUPSFreight
  stUPSFreightGuaranteed
End Enum

Default Value

0

Remarks

Specifies the service to be used for the shipment.

Valid values for UPS Freight are:

ShipmentNumber Property (UPSFreightShip Component)

The shipment number assigned to the shipment.

Syntax

• C#
• VB.NET

public string ShipmentNumber { get; }

Public ReadOnly Property ShipmentNumber As String

Default Value

""

Remarks

This property contains a 9 character shipment number returned in the response.

This property is read-only.

SSLAcceptServerCert Property (UPSFreightShip 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 (UPSFreightShip 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 (UPSFreightShip Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public UpsfreightshipSSLProviders SSLProvider { get; set; }

enum UpsfreightshipSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As UpsfreightshipSSLProviders

Enum UpsfreightshipSSLProviders
  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 (UPSFreightShip 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 (UPSFreightShip 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.

TotalCharge Property (UPSFreightShip Component)

Represents the total shipment charge.

Syntax

• C#
• VB.NET

public string TotalCharge { get; }

Public ReadOnly Property TotalCharge As String

Default Value

""

Remarks

This property holds the total charge associated with the shipment. The value is represented in dollars and cents with two decimal places. For instance "1500.25".

This property is read-only.

UPSAccount Property (UPSFreightShip Component)

Login information for UPS.

Syntax

• C#
• VB.NET

public UPSAccount UPSAccount { get; set; }

Public Property UPSAccount As UPSAccount

Remarks

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

Config Method (UPSFreightShip 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.

GetShipmentDocuments Method (UPSFreightShip Component)

Generates a shipping label using one of domestic UPS services.

Syntax

• C#
• VB.NET

public void GetShipmentDocuments();

Public Sub GetShipmentDocuments()

Remarks

The following properties must be set before calling this method:

• Server (required)
• AuthorizationToken (required)
• AccountNumber (required)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Documents (required)
• Commodities (required)
• WeightUnit (required; defaults to LBS)

Upon successful response, the following fields will be populated:

• BOLID
• ShipmentNumber
• BillableWeight
• Charges
• TotalCharge

Code example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/"; component.UPSAccount.AuthorizationToken = "Bearer token..."; component.UPSAccount.AccountNumber = "000000"; component.SenderContact.Company = "Developer Test 1"; component.SenderContact.Phone = "884530171"; component.SenderAddress.Address1 = "101 Developer Way"; component.SenderAddress.City = "Richmond"; component.SenderAddress.State = "VA"; component.SenderAddress.ZipCode = "23224"; component.SenderAddress.CountryCode = "US"; component.RecipientContact.Company = "Consignee Test 1"; component.RecipientAddress.Address1 = "1000 Consignee Street"; component.RecipientAddress.City = "Allanton"; component.RecipientAddress.State = "MO"; component.RecipientAddress.ZipCode = "63001"; component.RecipientAddress.CountryCode = "US"; component.Payor.PayorType = TPayorTypes.ptSender; component.HandlingUnit = "SKD:1"; CommodityDetail item = new CommodityDetail(); item.Description = "LCD TVS"; item.FreightClass = "77.5"; item.Weight = "150"; item.FreightNMFC = "132680"; item.FreightNMFCSub = "02"; item.NumberOfPieces = 20; item.Value = "100"; component.Commodities.Add(item); DocumentInfo label = new DocumentInfo(); label.FileName = "TestLabel.pdf"; label.PrintFormat = TFreightPrintFormats.fpfLaser; label.PrintSize = TFreightPrintSizes.fpsSize8X11; label.DocumentType = TFreightTypeCodes.ftcLabel; component.Documents.Add(label); component.GetShipmentDocuments(); Console.WriteLine("Total Charge: " + component.TotalCharge); for (int i = 0; i < component.Charges.Count; i++) { Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value); } Console.WriteLine("Billable Weight: " + component.BillableWeight); Console.WriteLine("BOLID: " + component.BOLID); Console.WriteLine("Shipment Number: " + component.ShipmentNumber);

Reset Method (UPSFreightShip 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 (UPSFreightShip Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class UpsfreightshipErrorEventArgs 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 (UPSFreightShip 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, UpsfreightshipNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

Public Class UpsfreightshipNotificationEventArgs 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 (UPSFreightShip 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, UpsfreightshipSSLServerAuthenticationEventArgs e);

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

Public Class UpsfreightshipSSLServerAuthenticationEventArgs 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

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

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

SSLStatus Event (UPSFreightShip Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

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

Remarks

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

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

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

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

The fields contained by this type are listed below.

Fields

Constructors

• 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 X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 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 X509 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 CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• 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 X509 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 X509 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 X509 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 X509 certificate and search the opened store for a corresponding private key.

ChargeDetail Type

Represents a shipment charge returned on a successful response.

Remarks

Fields

Constructors

• C#
• VB.NET

public ChargeDetail();

Public ChargeDetail()

CommodityDetail Type

Represents a single commodity line item.

Remarks

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

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

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

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public CommodityDetail();

Public CommodityDetail()

• C#
• VB.NET

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

Public CommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal HarmonizedCode As String, ByVal ScheduleBCode As String, ByVal Weight As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String, ByVal NumberOfPieces As Integer, ByVal ExportType As Integer)

• C#
• VB.NET

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

Public CommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal HarmonizedCode As String, ByVal ScheduleBCode As String, ByVal Weight As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String, ByVal NumberOfPieces As Integer)

• C#
• VB.NET

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

Public CommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal HarmonizedCode As String, ByVal ScheduleBCode As String, ByVal Weight As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String)

• C#
• VB.NET

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

Public CommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal HarmonizedCode As String, ByVal ScheduleBCode As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String)

• C#
• VB.NET

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

Public CommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal HarmonizedCode As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String)

• C#
• VB.NET

public CommodityDetail(string description, string manufacturer, string weight);

Public CommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal Weight As String)

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)

DocumentInfo Type

Specifies the information of the requested document.

Remarks

This type specifies the information of the document to be requested. This include the type of document, the printing options, and the location on disk where the file will be written. This must be set before calling GetShipmentDocuments. For example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/"; component.UPSAccount.AuthorizationToken = "Bearer token..."; component.UPSAccount.AccountNumber = "000000"; component.SenderContact.Company = "Developer Test 1"; component.SenderContact.Phone = "884530171"; component.SenderAddress.Address1 = "101 Developer Way"; component.SenderAddress.City = "Richmond"; component.SenderAddress.State = "VA"; component.SenderAddress.ZipCode = "23224"; component.SenderAddress.CountryCode = "US"; component.RecipientContact.Company = "Consignee Test 1"; component.RecipientAddress.Address1 = "1000 Consignee Street"; component.RecipientAddress.City = "Allanton"; component.RecipientAddress.State = "MO"; component.RecipientAddress.ZipCode = "63001"; component.RecipientAddress.CountryCode = "US"; component.Payor.PayorType = TPayorTypes.ptSender; component.HandlingUnit = "SKD:1"; CommodityDetail item = new CommodityDetail(); item.Description = "LCD TVS"; item.FreightClass = "77.5"; item.Weight = "150"; item.FreightNMFC = "132680"; item.FreightNMFCSub = "02"; item.NumberOfPieces = 20; item.Value = "100"; component.Commodities.Add(item); DocumentInfo label = new DocumentInfo(); label.FileName = "TestLabel.pdf"; label.PrintFormat = TFreightPrintFormats.fpfLaser; label.PrintSize = TFreightPrintSizes.fpsSize8X11; label.DocumentType = TFreightTypeCodes.ftcLabel; component.Documents.Add(label); component.GetShipmentDocuments(); Console.WriteLine("Total Charge: " + component.TotalCharge); for (int i = 0; i < component.Charges.Count; i++) { Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value); } Console.WriteLine("Billable Weight: " + component.BillableWeight); Console.WriteLine("BOLID: " + component.BOLID); Console.WriteLine("Shipment Number: " + component.ShipmentNumber);

Fields

Constructors

• C#
• VB.NET

public DocumentInfo();

Public DocumentInfo()

Firewall Type

This is 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