UPSFreightRates Class

Properties Methods Events Config Settings Errors

Provides UPS Freight Rates service.

Syntax

dshippingsdk.Upsfreightrates

Remarks

The UPSFreightRates class provides a way to retrieve rates for freight shipments. To use the class first set RequestedService to the service for which rates will be retrieved. Then specify the sender, recipient, and shipment information and call GetRates. Upon response Charges, TotalCharge, BillableWeight, and DimensionalWeight will be populated. For instance:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/"; component.UPSAccount.AuthorizationToken = "Bearer token..."; component.UPSAccount.AccountNumber = "000000"; component.SenderName = "Developer Test 1"; component.SenderAddress.Address1 = "101 Developer Way"; component.SenderAddress.City = "Richmond"; component.SenderAddress.State = "VA"; component.SenderAddress.ZipCode = "23224"; component.SenderAddress.CountryCode = "US"; component.RecipientName = "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 = "200"; item.FreightNMFC = "132680"; item.FreightNMFCSub = "02"; item.NumberOfPieces = 20; item.Value = "100"; component.Commodities.Add(item); component.GetRates(); Console.WriteLine("Total Charge: " + component.TotalCharge); Console.WriteLine("Billable Weight: " + component.BillableWeight); Console.WriteLine("Dimensional Weight: " + component.DimensionalWeight); for (int i = 0; i < component.Charges.Count; i++) { Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value); }

Property List

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


BillableWeight	Represents the billable weight associated with the shipment.
Charges	Collection of shipment charges.
CODPayorType	The type of payment that will be used for the COD payment.
CODTotalAmount	The total amount of additional fees.
CODType	The code that indicates the type of funds that will be used for the COD payment.
Commodities	Collection of commodity items of the shipment.
DimensionalWeight	Represents the dimensional weight associated with the shipment.
Firewall	A set of properties related to firewall access.
HandlingUnit	Describe the Handling Units (Movable Pieces) in this Shipment.
OverSeasLeg	Identifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico.
Payor	Identifies the payor of transportation charges for the shipment.
Proxy	A set of properties related to proxy access.
RecipientAddress	Identifies the recipient's address.
RecipientName	Identifies the recipient's name or company name.
RequestedService	The service selected for the shipment.
SenderAddress	Identifies the sender's address.
SenderName	Identifies the sender's locations name or company name.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the class.
TotalCharge	Represents the total shipment charge.
UPSAccount	Login information for UPS.

Method List

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


Config	Sets or retrieves a configuration setting.
GetRates	Returns rate information for a specified or all available UPS RequestedService s.
Reset	Resets the internal state of the class and all properties to their default values.

Event List

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


Error	Information about errors during data delivery.
Notification	Notification returned by the server upon successful request (if applicable).
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

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


AlternateDeliveryAddress	Alternate Delivery Address is used for Hold for Pickup or Delivery at UPS Access Points.
CurrencyCode	The currency code associated with the monetary values present in the request.
CustomerTransactionId	Customer transaction id / customer context information.
DeliveryOptions	Value-Added Freight Delivery Services.
IncludeNegotiatedRates	Whether to include the NegotiatedRatesIndicator in the request.
NotificationDialect	Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationLanguage	Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
PickupOptions	Value-Added Freight Pickup Services.
PiecesToSort	The number of pieces to sort and segregate.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
RequestOption	Defines type of shipping desired.
ShipmentIndicationType	Whether shipment is Hold For Pickup or Delivery at UPS Access Points.
SubVersion	UPS SubVersion.
TaxInformationIndicator	Controls whether to send a TaxInformationIndicator.
TESTMODE	This configuration setting will allow you to run test transactions.
Version	UPS API Version.
Warning	Warning message returned by the server.
WeightUnit	Weight unit.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxHeaders	Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the class will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the class binds to a SOCKS firewall as a server (TCPClient only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLContextProtocol	The protocol used when getting an SSLContext instance.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithm	The algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

BillableWeight Property (UPSFreightRates Class)

Represents the billable weight associated with the shipment.

Syntax


public String getBillableWeight();

Default Value

Remarks

This property is read-only.

Charges Property (UPSFreightRates Class)

Collection of shipment charges.

Syntax


public ChargeDetailList getCharges();


public void setCharges(ChargeDetailList charges);

Remarks

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

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

CODPayorType Property (UPSFreightRates Class)

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

Syntax


public int getCODPayorType();


public void setCODPayorType(int CODPayorType);


Enumerated values:
  public final static int fcodptCollect = 0;
  public final static int fcodptPrepaid = 1;

Default Value

Remarks

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


fcodptCollect (0)
fcodptPrepaid (1)

CODTotalAmount Property (UPSFreightRates Class)

The total amount of additional fees.

Syntax


public String getCODTotalAmount();


public void setCODTotalAmount(String CODTotalAmount);

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 (UPSFreightRates Class)

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

Syntax


public int getCODType();


public void setCODType(int CODType);


Enumerated values:
  public final static int fcodtsCertifiedCheck = 0;
  public final static int fcodtsCash = 1;
  public final static int fcodtsCompanyCheck = 2;

Default Value

Remarks

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


fcodtsCertifiedCheck (0)
fcodtsCash (1)
fcodtsCompanyCheck (2)

Commodities Property (UPSFreightRates Class)

Collection of commodity items of the shipment.

Syntax


public CommodityDetailList getCommodities();


public void setCommodities(CommodityDetailList commodities);

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:


field	Required?
Description	Yes
FreightClass	Conditional, required only for ground shipments
FreightIsHazardous	Conditional, required if hazardous materials are contained in the shipment
FreightNMFC	No
FreightNMFCSub	Conditional, required if FreightNMFC is specified
FreightPackagingType	Yes
NumberOfPieces	Yes
Value	Yes
Weight	Yes

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

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

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

DimensionalWeight Property (UPSFreightRates Class)

Represents the dimensional weight associated with the shipment.

Syntax


public String getDimensionalWeight();

Default Value

Remarks

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

This property is read-only.

Firewall Property (UPSFreightRates Class)

A set of properties related to firewall access.

Syntax


public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

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

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

HandlingUnit Property (UPSFreightRates Class)

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

Syntax


public String getHandlingUnit();


public void setHandlingUnit(String handlingUnit);

Default Value

Remarks


Code	Handling Unit Type
SKD	SKID
CBY	CARBOY
PLT	PALLET
TOT	TOTES
LOO	LOOSE
OTH	OTHER

The first 4 codes are valid for handling unit one and the last two are valid for handling unit two. The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example: SKD:1; OTH:1'.

OverSeasLeg Property (UPSFreightRates Class)

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

Syntax


public OverSeasLegDetail getOverSeasLeg();


public void setOverSeasLeg(OverSeasLegDetail overSeasLeg);

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.

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

Payor Property (UPSFreightRates Class)

Identifies the payor of transportation charges for the shipment.

Syntax


public PayorDetail getPayor();


public void setPayor(PayorDetail payor);

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.

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

Proxy Property (UPSFreightRates Class)

A set of properties related to proxy access.

Syntax


public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

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

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

RecipientAddress Property (UPSFreightRates Class)

Identifies the recipient's address.

Syntax


public AddressDetail getRecipientAddress();


public void setRecipientAddress(AddressDetail recipientAddress);

Remarks

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

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

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

RecipientName Property (UPSFreightRates Class)

Identifies the recipient's name or company name.

Syntax


public String getRecipientName();


public void setRecipientName(String recipientName);

Default Value

Remarks

The recipient's name or company name.

RequestedService Property (UPSFreightRates Class)

The service selected for the shipment.

Syntax


public int getRequestedService();


public void setRequestedService(int requestedService);


Enumerated values:
  public final static int stUPSFreight = 0;
  public final static int stUPSFreightGuaranteed = 1;

Default Value

Remarks

Specifies the service for the shipment.

Valid values for UPS Freight are:


stUPSFreight (0)
stUPSFreightGuaranteed (1)

SenderAddress Property (UPSFreightRates Class)

Identifies the sender's address.

Syntax


public AddressDetail getSenderAddress();


public void setSenderAddress(AddressDetail senderAddress);

Remarks

The SenderAddress is required to be provided in a ship request when the 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.

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

SenderName Property (UPSFreightRates Class)

Identifies the sender's locations name or company name.

Syntax


public String getSenderName();


public void setSenderName(String senderName);

Default Value

Remarks

SSLAcceptServerCert Property (UPSFreightRates Class)

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

Syntax


public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

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

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

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

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

SSLCert Property (UPSFreightRates Class)

The certificate to be used during SSL negotiation.

Syntax


public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

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

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

SSLProvider Property (UPSFreightRates Class)

This specifies the SSL/TLS implementation to use.

Syntax


public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


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

Default Value

Remarks

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

Possible values are:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

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

SSLServerCert Property (UPSFreightRates Class)

The server certificate for the last established connection.

Syntax


public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

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

Timeout Property (UPSFreightRates Class)

A timeout for the class.

Syntax


public int getTimeout();


public void setTimeout(int timeout);

Default Value

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

TotalCharge Property (UPSFreightRates Class)

Represents the total shipment charge.

Syntax


public String getTotalCharge();

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 (UPSFreightRates Class)

Syntax


public UPSAccount getUPSAccount();


public void setUPSAccount(UPSAccount UPSAccount);

Remarks

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

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

Config Method (Upsfreightrates Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

GetRates Method (Upsfreightrates Class)

Returns rate information for a specified or all available UPS RequestedService s.

Syntax

public void getRates();

Remarks

To get the courtesy rate quotes for UPS services, you can call the GetRates method. The RequestedService property identifies the UPS service for which you want to retrieve rate information.

Reset Method (Upsfreightrates Class)

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

Syntax

public void reset();

Remarks

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

Error Event (Upsfreightrates Class)

Information about errors during data delivery.

Syntax

public class DefaultUpsfreightratesEventListener implements UpsfreightratesEventListener {
  ...
  public void error(UpsfreightratesErrorEvent e) {}
  ...
}

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

Remarks

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

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

Notification Event (Upsfreightrates Class)

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

Syntax

public class DefaultUpsfreightratesEventListener implements UpsfreightratesEventListener {
  ...
  public void notification(UpsfreightratesNotificationEvent e) {}
  ...
}

public class UpsfreightratesNotificationEvent {
  public String message;
}

Remarks

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

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

SSLServerAuthentication Event (Upsfreightrates Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultUpsfreightratesEventListener implements UpsfreightratesEventListener {
  ...
  public void SSLServerAuthentication(UpsfreightratesSSLServerAuthenticationEvent e) {}
  ...
}

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

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 (Upsfreightrates Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultUpsfreightratesEventListener implements UpsfreightratesEventListener {
  ...
  public void SSLStatus(UpsfreightratesSSLStatusEvent e) {}
  ...
}

public class UpsfreightratesSSLStatusEvent {
  public String message;
}

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

Address1
String
Default Value: ""

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

Address2
String
Default Value: ""

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

AddressFlags
int
Default Value: 0

Various flags that denote information about the address.


Value	Meaning
0x00000001	POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses.
0x00000002	Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial.

City
String
Default Value: ""

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

CountryCode
String
Default Value: "US"

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

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


Country Name	Country Code
Afghanistan	AF
Albania	AL
American Samoa	AS
Andorra	AD
Angola	AO
Anguilla	AI
Antigua	AG*
Argentina	AR
Armenia	AM
Aruba	AW
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Barbuda	AG*
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
Bermuda	BM
Bhutan	BT
Bolivia	BO
Bonaire	AN**
Bosnia-Herzegovina	BA
Botswana	BW
Brazil	BR
British Virgin Islands	VG*
Brunei	BN
Bulgaria	BG
Burkina Faso	BF
Burundi	BI
Cambodia	KH
Cameroon	CM
Canada	CA
Canary Islands	ES**
Cape Verde	CV
Cayman Islands	KY**
Chad	TD
Channel Islands	GB**
Chile	CL
China	CN
Colombia	CO
Congo	CG
Congo Dem. Rep. Of	CD
Cook Islands	CK
Costa Rica	CR
Croatia	HR
Curacao	AN**
Cyprus	CY
Czech Republic	CZ
Denmark	DK
Djibouti	DJ
Dominica	DM
Dominican Republic	DO
East Timor	TL
Ecuador	EC
Egypt	EG
El Salvador	SV
England	GB**
Equatorial Guinea	GQ
Eritrea	ER
Estonia	EE
Ethiopia	ET
Faeroe Islands	FO*
Fiji	FJ
Finland	FI
France	FR
French Guiana	GF
French Polynesia	PF**
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI
Grand Cayman	KY**
Great Britain	GB**
Great Thatch Island	VG*
Great Tobago Islands	VG*
Greece	GR
Greenland	GL
Grenada	GD
Guadeloupe	GP**
Guam	GU
Guatemala	GT
Guinea	GN
Guyana	GY
Haiti	HT
Holland	NL**
Honduras	HN
Hong Kong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iraq	IQ
Ireland	IE
Israel	IL
Italy	IT**
Ivory Coast	CI
Jamaica	JM
Japan	JP
Jordan	JO
Jost Van Dyke Islands	VG*
Kazakhstan	KZ
Kenya	KE
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV
Lebanon	LB
Lesotho	LS
Liberia	LR
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macau	MO
Macedonia	MK
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Marshall Islands	MH
Martinique	MQ
Mauritania	MR
Mauritius	MU
Mexico	MX
Micronesia	FM
Moldova	MD
Monaco	MC
Mongolia	MN
Montserrat	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nepal	NP
Netherlands	NL**
Netherlands Antilles	AN**
New Caledonia	NC
New Zealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG
Norman Island	VG*
Northern Ireland	GB**
Northern Mariana Islands	MP**
Norway	NO
Oman	OM
Pakistan	PK
Palau	PW
Palestine	PS*
Panama	PA
Papua New Guinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Poland	PL
Portugal	PT
Puerto Rico	PR
Qatar	QA
Reunion	RE
Romania	RO
Rota	MP**
Russia	RU
Rwanda	RW
Saba	AN**
Saipan	MP**
Samoa	WS
San Marino	IT**
Saudi Arabia	SA
Scotland	GB**
Senegal	SN
Serbia & Montenegro	CS
Seychelles	SC
Singapore	SG
Slovak Republic	SK
Slovenia	SI
South Africa	ZA
South Korea	KR
Spain	ES**
Sri Lanka	LK
St. Barthelemy	GP**
St. Christopher	KN**
St. Croix Island	VI**
St. Eustatius	AN**
St. John	VI**
St. Kitts and Nevis	KN**
St. Lucia	LC
St. Maarten	AN**
St. Thomas	VI**
St. Vincent	VC**
Suriname	SR
Swaziland	SZ
Sweden	SE
Switzerland	CH
Tahiti	PF**
Taiwan	TW
Tanzania	TZ
Thailand	TH
Tinian	MP**
Togo	TG
Tonga	TO
Tortola Island	VG*
Trinidad & Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Turks & Caicos Islands	TC
U.S. Virgin Islands	VI**
Uganda	UG
Ukraine	UA
Union Island	VC**
United Arab Emirates	AE
United Kingdom	GB**
United States	US
Uruguay	UY
Uzbekistan	UZ
Vanuatu	VU
Vatican City	IT**
Venezuela	VE
Vietnam	VN
Wales	GB**
Wallis & Futuna Islands	WF
Yemen	YE
Zambia	ZM
Zimbabwe	ZW

* Not supported by USPS

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


Country Name	Country Code
Cayman Islands	KY
French Polynesia	PF
Guadeloupe	GP
Italy	IT
Netherlands	NL
Netherlands Antilles	AN
Northern Mariana Islands	MP
Spain	ES
St. Kitts and Nevis	KN
St. Vincent	VC
United Kingdom	GB
U.S. Virgin Islands	VI

State
String
Default Value: ""

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

ZipCode
String
Default Value: ""

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

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

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

Constructors

public AddressDetail();

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

EffectiveDate
String (read-only)
Default Value: ""

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
String
Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

EncodedB
byte[]
Default Value: ""

This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

ExpirationDate
String (read-only)
Default Value: ""

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String
Default Value: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
String (read-only)
Default Value: ""

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
String (read-only)
Default Value: ""

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
String (read-only)
Default Value: ""

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
String (read-only)
Default Value: ""

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String
Default Value: ""

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.

PrivateKey
String (read-only)
Default Value: ""

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean (read-only)
Default Value: False

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String (read-only)
Default Value: ""

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String (read-only)
Default Value: ""

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String
Default Value: ""

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String (read-only)
Default Value: ""

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
String (read-only)
Default Value: ""

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
String
Default Value: "MY"

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

StoreB
byte[]
Default Value: "MY"

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

StorePassword
String
Default Value: ""

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

StoreType
int
Default Value: 0

This is the type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String
Default Value: ""

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

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

SubjectAltNames
String (read-only)
Default Value: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String (read-only)
Default Value: ""

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
String (read-only)
Default Value: ""

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
String (read-only)
Default Value: ""

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
String
Default Value: ""

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

Digital Signatures
Key Authentication
Key Encryption
Data Encryption
Key Agreement
Certificate Signing
Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int
Default Value: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signatures
0x40	Key Authentication (Non-Repudiation)
0x20	Key Encryption
0x10	Data Encryption
0x08	Key Agreement
0x04	Certificate Signing
0x02	Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String (read-only)
Default Value: ""

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

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

public Certificate( certificateFile);

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

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

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

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

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

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY 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 class 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).

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

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

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

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

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

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

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

ChargeDetail Type

Represents a shipment charge returned on a successful response.

Remarks

Fields

ChargeType
String
Default Value: ""

Indicates the type of the charge. A partial list of possible values are:


2
ADV_NOTF
AFTR_DSCNT
CA_BORDER
CA_CSTM_MNFST
COD
CON_ST_DEL
DEFICITRATE
DEFICITWGHT
DFCT_AMT
DSCNT
DSCNT_RATE
HAZMAT
HICST
HOL_WE_PU_DEL
INSD_PU_DEL
L_UPGF_016
LIFTGATE
LND_GROSS
MINCHARGE
OFUELSURCHG
RESI_PU_DEL
RMTLOC
SORTSEG
TOTI
TOTO

Description
String
Default Value: ""

The description of the rate. The text description is provided by the class based on the value in ChargeType. If a description is not know for the ChargeType this field will hold an empty string. Possible values are:


Fuel Surcharge
Arrival Notification
Amount after Discount
Border Processing Fee
Custom Manifest Fee
Collect on Delivery fee
Construction Site Delivery
Deficit Rate
Deficit Weight
Deficit Charge
Discounted Amount
Discount Rate (as a percentage)
Hazardous Materials Charge
High Cost Service Area Surcharge
Holiday/Weekend Pickup or Delivery
Inside Pickup/Delivery
Custom Charge
Liftgate Fee
Gross Charges
Minimum Charge Applies
Ocean Fuel Surcharge
Residential Pickup/Delivery
Remote Location Fee
Sorting and Segregation
Total Island Charges
Total Ocean Charges

Value
String
Default Value: ""

The value of the charge type specified by ChargeType.

Constructors

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.


field	Required?
Description	Yes
FreightClass	Conditional, required only for ground shipments
FreightIsHazardous	Conditional, required if hazardous materials are contained in the shipment
FreightNMFC	No
FreightNMFCSub	Conditional, required if FreightNMFC is specified
FreightPackagingType	Yes
NumberOfPieces	Yes
Value	Yes
Weight	Yes

The fields contained by this type are listed below.

Fields

Description
String
Default Value: ""

Complete and accurate description of this commodity line item.

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

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

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


Description
Correspondence/No Commercial Value	Leases
Accounting Documents	Legal Documents
Analysis Reports	Letters and Cards
Applications (Completed)	Letter of Credit Packets
Bank Statements	Loan Documents
Bid Quotations	Marriage Certificates
Birth Certificates	Medical Records
Bills of Sale	Office Records
Bonds	Operating Agreements
Business Correspondence	Patent Applications
Checks (Completed)	Permits
Claim Files	Photocopies
Closing Statements	Proposals
Conference Reports	Prospectuses
Contracts	Purchase Orders
Cost Estimates	Quotations
Court Transcripts	Reservation Confirmation
Credit Applications	Resumes
Data Sheets	Sales Agreements
Deeds	Sales Reports
Employment Papers	Shipping Documents
Escrow Instructions	Statements/Reports
Export Papers	Statistical Data
Financial Statements	Stock Information
Immigration Papers	Tax Papers
Income Statements	Trade Confirmation
Insurance Documents	Transcripts
Interoffice Memos	Warranty Deeds
Inventory Reports
Invoices (Completed)

ExportType
int
Default Value: 0

Indicates the export type. Applicable and required for SED only.

Valid values are:


Value	Meaning
etDomestic (0)	Exports that have been produced, manufactured, or grown in the United States or Puerto Rico. This includes imported merchandise which has been enhanced in value or changed from the form in which imported by further manufacture or processing in the United States or Puerto Rico.
etForeign (1)	Merchandise that has entered the United States and is being exported again in the same condition as when imported.
etForeignMilitary (2)	Exported merchandise that is sold under the foreign military sales program.

NOTE: This field is only applicable to UPS shipments.

FreightClass
String
Default Value: ""

Indicates the freight class of the commodity.

The following table lists freight classes available from UPS freight services.


Freight Class
50
55
60
65
70
77.5
85
92.5
100
110
125
150
175
200
250
300
400
500