FedExFreightRates Component

Properties Methods Events Config Settings Errors

Provides access to pre-ship rate information for a freight shipment per your established FedEx account rates.

Syntax

DPayments.DShippingSDK.Fedexfreightrates

Remarks

When providing origin, destination information, weight, and service, this component allows a user to obtain a rate quote for a specific service, or a list of available FedEx Express services with the respective rate quotes.

You can send a rate request to FedEx by calling the GetRates method for a specific FedEx service (when RequestedService is specified). The component will return rates for packages based on a combination of origin, destination, service type, weight, and package type. This also checks if the requested service is available, checks your origin/destination pair and ship date to determine whether the service you requested is a valid service type.

Discount rates are available for all services and origin/destination pairs. List rates are available for Express and Ground U.S. shipments only. To have list rates returned with your discount rates, you must set the RateType to 0 (rtList). This way, you will receive both discount and list rates.

When requesting a rate quote, include as much detail as possible about your shipment. This information is important for calculating the correct shipping costs with surcharges.

Rating for a Multiple Package Shipment (MPS) is available for: Express U.S. Domestic and International multiple package shipments, Ground US Domestic and International multiple-package shipments, Express Domestic C.O.D. and International C.O.D. multiple-package shipments and Ground Domestic C.O.D. and International C.O.D. multiple-package shipments.

Please note that all rate quotes are estimates only and may differ from the actual invoiced amount.

With the FedExFreightRates Component, you can:

Ensure service availability (after you provide the carrier code, service type, origination & destination postal codes, packaging type, drop-off type, and estimated weight);
Retrieve the rate required for that shipment.

The restrictions on the allowed property values are listed separately under each control property description. If the user enters more than the allowed number of characters, an error will not be generated. The control will simply pass in the characters provided and the server may disregard the extra characters. This is important since the resulting value could prevent a correct response.

To use this component, you must have a FedEx AccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

Property List

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


CODTotalAmount	The total amount to be collected on delivery.
CODType	COD type.
Commodities	Collection of commodity line items in the fright shipment.
FedExAccount	Login information for FedEx.
Firewall	A set of properties related to firewall access.
FreightGuarantee	Identifies the freight guarantee details.
InsuredValue	The total amount of insurance requested for the shipment being rated.
Packages	A collection of packages contained in the shipment.
Payor	Identifies the payor of transportation charges for the requested shipment.
PickupType	Pickup type used for the shipment that rate is requested for.
Proxy	A set of properties related to proxy access.
RateType	Indicates the type of rates to be returned.
RecipientAddress	Identifies the recipient's address.
RequestedService	Service type for which the shipping rate is requested.
SenderAddress	Identifies the sender's address.
Services	Collection of available services returned for the shipment being rated.
ShipDate	The date on which the package will be shipped.
ShipmentInfo	The shipment info for the freight shipment.
ShipmentSpecialServices	Contains the collection of special services offered by FedEx.
SSLAcceptServerCert	Instructs the component 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 component.
TotalWeight	The total weight of all the pieces in this shipment.

Method List

The following is the full list of the methods of the component 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 FedEx services.
Reset	Resets the internal state of the component and all properties to their default values.

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.


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 component with short descriptions. Click on the links for further details.


AccountExchangeRate[i]	The exchange rate use when converting currency.
AccountFromCurrency[i]	The currency from which the value was converted.
AccountIntoCurrency[i]	The currency to which the value was converted.
CODReferenceIndicator	The reference information to be added to the COD return label.
CurrencyCode	The currency code associated with the monetary values present in the request.
CustomerTransactionId	Customer transaction id.
DryIceCount	The number of packages which contain dry ice.
EstimateDelivery	Determines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
ListExchangeRate[i]	The exchange rate use when converting currency.
ListFromCurrency[i]	The currency from which the value was converted.
ListIntoCurrency[i]	The currency to which the value was converted.
PackageDryIceWeight[i]	The weight of the dry ice for each package.
PackageFreightCommodityIds[i]	The Freight Commodity Line Item IDs associated with this package.
PackagePhysicalPackagingType[i]	Additional details about the physical packaging of the item in a FedEx Freight shipment.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
SizeUnit	The dimension unit.
SmartPostAncillaryEndorsement	The endorsement type used for a FedEx SmartPost shipment.
SmartPostCustomerManifestId	The Customer Manifest Id used to group FedEx SmartPost packages.
SmartPostHubId	The HubId used to send FedEx SmartPost shipments.
SmartPostIndicia	The Indicia type used for a FedEx SmartPost shipment.
TESTMODE	This configuration setting will allow you to run test transactions.
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 component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the component 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 component.
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 component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component 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 component.
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 component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component 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 component 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 component 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.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
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.
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.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
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.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

CODTotalAmount Property (FedExFreightRates Component)

The total amount to be collected on delivery.

public string CODTotalAmount { get; set; }

Public Property CODTotalAmount As String

Default Value

Remarks

This indicates customer's total COD amount (prior to any accumulations: total collection amount minus transportation charges). The CODTotalAmount is required to be provided in a ship request only if the corresponding flag of COD is contained in the ShipmentSpecialServices property.

For Ground COD shipments, the COD amount must be included on each package that uses COD service by setting the CODAmount and the corresponding flag of COD is contained in the SpecialServices field.

Format: Two explicit decimals (e.g.5.00).

CODType Property (FedExFreightRates Component)

COD type.

Syntax

C#
VB.NET

public FedexfreightratesCODTypes CODType { get; set; }

enum FedexfreightratesCODTypes {
  codtAny,
  codtCash,
  codtGuaranteedFunds,
  codtCompanyCheck,
  codtPersonalCheck
}

Public Property CODType As FedexfreightratesCODTypes

Enum FedexfreightratesCODTypes
  codtAny
  codtCash
  codtGuaranteedFunds
  codtCompanyCheck
  codtPersonalCheck
End Enum

Default Value

Remarks

This field identifies the type of funds FedEx should collect upon package delivery. It is required to be provided in a ship request only if the COD is present (requested) in the ShipmentSpecialServices.

Possible values are as follows:


Value	Description
codtAny (0)	Unsecured form of payment: personal check, certified check, cashier's check, official check, money order, or company check.
codtCash (1)	This is not available on the shipment level
codtGuaranteedFunds (2)	Secured form of payment: cashier's check, official check, or money order.
codtCompanyCheck (3)	Company check
codtPersonalCheck (4)	Personal check

Commodities Property (FedExFreightRates Component)

Collection of commodity line items in the fright shipment.

Syntax

C#
VB.NET

public FreightCommodityDetailList Commodities { get; }

Public Property Commodities As FreightCommodityDetailList

Remarks

This contains a collection of the commodity line items required when shipping internationally or when the RequestedService is set to stFedExFreightEconomy or stFedExFreightPriority.

This property is not available at design time.

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

FedExAccount Property (FedExFreightRates Component)

Syntax

C#
VB.NET

public FedExAccount FedExAccount { get; set; }

Public Property FedExAccount As FedExAccount

Remarks

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

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

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

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

FreightGuarantee Property (FedExFreightRates Component)

Identifies the freight guarantee details.

Syntax

C#
VB.NET

public FreightGuaranteeDetail FreightGuarantee { get; set; }

Public Property FreightGuarantee As FreightGuaranteeDetail

Remarks

This specifies the type and date of guarantee provided for the freight shipment.

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

InsuredValue Property (FedExFreightRates Component)

The total amount of insurance requested for the shipment being rated.

Syntax

C#
VB.NET

public string InsuredValue { get; set; }

Public Property InsuredValue As String

Default Value

"0.00"

Remarks

This property is optional to be provided in the rate request, and if present, this will affect the rates and service availability.

Format: Two explicit decimal positions (e.g. 100.00). Total length including decimal position: 11.

Packages Property (FedExFreightRates Component)

A collection of packages contained in the shipment.

Syntax

C#
VB.NET

public PackageDetailList Packages { get; }

Public Property Packages As PackageDetailList

Remarks

At least one package must be specified.

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

For FedEx, the PackagingType and either the Weight or TotalWeight must be specified. The Length, Width, Height, InsuredValue, and SpecialServices are optional.

This property is not available at design time.

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

Payor Property (FedExFreightRates Component)

Identifies the payor of transportation charges for the requested 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.

Note that the only valid value for PayorType is ptSender.

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

PickupType Property (FedExFreightRates Component)

Pickup type used for the shipment that rate is requested for.

Syntax

C#
VB.NET

public FedexfreightratesPickupTypes PickupType { get; set; }

enum FedexfreightratesPickupTypes {
  fptDropoffAtFedexLocation,
  fptContactFedexToSchedule,
  fptUseScheduledPickup,
  fptOnCall,
  fptPackageReturnProgram,
  fptRegularStop,
  fptTag,
  fptNone
}

Public Property PickupType As FedexfreightratesPickupTypes

Enum FedexfreightratesPickupTypes
  fptDropoffAtFedexLocation
  fptContactFedexToSchedule
  fptUseScheduledPickup
  fptOnCall
  fptPackageReturnProgram
  fptRegularStop
  fptTag
  fptNone
End Enum

Default Value

Remarks

Indicate the pickup type method by which the shipment to be tendered to FedEx.

Valid values are:


Value	Description
fptDropoffAtFedexLocation (0)	Dropoff At Fedex Location (Default)	Ship
fptContactFedexToSchedule (1)	Contact Fedex To Schedule	Ship
fptUseScheduledPickup (2)	Use Scheduled Pickup	Ship
fptOnCall (3)	On Call	Pickup
fptPackageReturnProgram (4)	Package Return Program	Pickup
fptRegularStop (5)	RegularStop	Pickup
fptTag (6)	Tag	Ship, Pickup
fptNone (7)	None

Proxy Property (FedExFreightRates Component)

A set of properties related to proxy access.

Syntax

C#
VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

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

RateType Property (FedExFreightRates Component)

Indicates the type of rates to be returned.

Syntax

C#
VB.NET

public int RateType { get; set; }

Public Property RateType As Integer

Default Value

Remarks

Possible values are listed below (specified in hexadecimal notation). They can be or-ed together to include multiple options:


Value	Meaning
0x001	List (Default)	Returns FedEx published list rates in addition to account-specific (discount) rates (if applicable).
0x002	Account	Returns account-specific (discount) rates.
0x004	Preferred	Returns rates in the preferred currency specified in the CurrencyCode config.
0x008	Incentive	This is one-time discount for incentivising the customer. For more information, contact your FedEx representative.
0x010	Retail	Returns customer rate from one of retail FedEx service centers.

RecipientAddress Property (FedExFreightRates 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 rate request.

The Residential flag in AddressFlags is applicable for all FedEx services (i.e. either Ground or Express). If True, extra charge will be added to rate quote as this is considered a special service. A residential package surcharge applies to shipments to a home or private residence, including locations where a business is operated from a home. This surcharge is applicable for: U.S. Express and Ground services, International Ground service (Canada only), U.S. Express Freight services, and FedEx International Premium.

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.

RequestedService Property (FedExFreightRates Component)

Service type for which the shipping rate is requested.

Syntax

C#
VB.NET

public ServiceTypes RequestedService { get; set; }

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

Public Property RequestedService As ServiceTypes

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

Default Value

Remarks

This property is required to be entered in the request only if the rate request is made for a specific FedEx service type. In this case, the RequestedService should be set to a value different from 'stUnspecified'.

Otherwise, the rate request will be considered by FedEx server as it has been made for all available services and respective rates.

Possible values are:


stFedEx1DayFreight (17)	A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriorityFreight (23)	PackagingType should be set to Your Packaging. A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.
stFedExInternationalEconomyFreight (24)	PackagingType should be set to Your Packaging. Advanced confirmation is required for this service. Call 1.800.332.0807 to book your freight shipment.
stFedExFirstFreight (28)	PackagingType should be set to Your Packaging. Also the maximum declared value for the shipment is $50,000 USD.
stFedExFreightEconomy (30)
stFedExFreightPriority (31)

For all services, the following guidelines apply:

Packages/skids must wight more than 150 lbs.
Individual pallets/skids weighing in excess of 2200 lbs or larger than 70" in height, 119" in length, or 80" in width require prior approval by FedEx.
Service days are Monday through Friday, with Saturday pickup and delivery available to many major markets.

SenderAddress Property (FedExFreightRates 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 rate request.

The Residential flag in AddressFlags is applicable for FedEx Ground services only. If True, extra charge will be added to rate quote as this is considered a special service.

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.

Services Property (FedExFreightRates Component)

Collection of available services returned for the shipment being rated.

Syntax

C#
VB.NET

public ServiceDetailList Services { get; }

Public ReadOnly Property Services As ServiceDetailList

Remarks

This property will contain the list of rates on all available FedEx services that satisfy the request. It should be inspected after a call to GetRates. Each returned service has a ServiceType, ServiceTypeDescription, RateScale, RateZone, TransitTime, DeliveryDate, EffectiveNetDiscount, AccountBaseCharge, AccountNetCharge, AccountTotalDiscount, AccountTotalSurcharge, ListBaseCharge, ListNetCharge, ListTotalDiscount, and ListTotalSurcharge, tied to it.

For instance, if the response contains only one available service that satisfies the search criteria: component.Services[0].ServiceTypeDescription = "FEDEX_2DAY".

This property is read-only.

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

ShipDate Property (FedExFreightRates Component)

The date on which the package will be shipped.

Syntax

C#
VB.NET

public string ShipDate { get; set; }

Public Property ShipDate As String

Default Value

Remarks

This property value is optional to be entered in the request. This might affect the service availability.

The date should be the current date, or a date no more than 10 days in the future.

Defaults to current system date if not present.

Supported date formats are "yyyy-MM-dd" and "yyyy-MM-ddTHH:mm:ss".

ShipmentInfo Property (FedExFreightRates Component)

The shipment info for the freight shipment.

Syntax

C#
VB.NET

public FreightShipmentDetail ShipmentInfo { get; set; }

Public Property ShipmentInfo As FreightShipmentDetail

Remarks

This contains the details required to be sent when the ServiceType is set to either stFedExFreightEconomy or stFedExFeightPriority. When set, Commodities must also be set. The following fields are required to be set:

AccountNumber
BillingAddress1
BillingCity
BillingState
BillingZipCode
BillingCountryCode
CollectTermsType
Role
TotalHandlingUnits

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

ShipmentSpecialServices Property (FedExFreightRates Component)

Contains the collection of special services offered by FedEx.

Syntax

C#
VB.NET

public long ShipmentSpecialServices { get; set; }

Public Property ShipmentSpecialServices As Long

Default Value

Remarks

To request any of the special services offered by FedEx, you must set the ShipmentSpecialServices to a set of flags as listed below, the following flags can be or-ed together in order to select multiple options:


Value	Meaning
0x00000001L	Broker Select
0x00000004L	COD
0x00000010L	Dangerous Goods
0x00000020L	Do Not Break Down Pallets
0x00000040L	Do Not Stack Pallets
0x00000080L	Dry Ice
0x00000200L	Electronic Trade Documents
0x00000400L	Event Notification
0x00000800L	Extreme Length
0x00001000L	Food
0x00002000L	Freight Guarantee
0x00008000L	Hold At Location
0x00010000L	International Controlled Export Service
0x00040000L	Inside Delivery
0x00080000L	Inside Pickup
0x00100000L	Liftgate Delivery
0x00200000L	Liftgate Pickup
0x02000000L	Poison
0x04000000L	Protection From Freezing
0x10000000L	Saturday Delivery
0x20000000L	Saturday Pickup
0x40000000L	Top Load
0x10000000000L	International Traffic in Arms Regulations

The meaning and limitations for each special service option are listed below:

Broker Select: Indicates that the broker select special service is requested. When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:
- stFedExInternationalPriority (20)
- stFedExInternationalEconomy (21)
- stFedExInternationalPriorityFreight (23)
- stFedExInternationalEconomyFreight (24)
- stFedExInternationalPriorityExpress (32)
- stFedExInternationalConnectPlus (33)
FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the ClearanceBrokerageType, BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well.
Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. When set, the CODTotalAmount and CODType properties must be set. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx Freight Economy, and FedEx Freight Priority.
Dangerous Goods: Indicates that the shipment contains dangerous goods. This service will affect shipping rates and service availability. When set, at least one HazardousMaterialsOptions must be selected and the EmergencyContactPhone must be set Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
Do Not Break Down Pallets: Indicates that the pallets should not be broken down. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
Do Not Stack Pallets: Indicates that the pallets should not be stacked. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
Electronic Trade Documents: This only applies when shipping internationally. FedEx will generate and submit your trade documents specified in the ShippingDocumentTypes electronically and you no longer need to print and attach them. Note that some countries do not accept Electronic Trade Documents (ETD). For a full list of countries that support ETD you can go to http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.
If you also want to receive copies of the FedEx generated documents use the RequestedETDDocuments property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them. Note: This is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
Event Notification: Indicates that event notification is requested. This might affect the service availability. If this is requested in a ship request, then the Notify collection is required to be set. Note that this is only valid for FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
Extreme Length: This indicates that the pallet is longer than typically allowed. This requires prior clearance with FedEx.
Food: This indicates that the shipment contains food items. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
Freight Guarantee: This indicates that the freight shipment is guaranteed for a specific date and time. When set, the FreightGuarantee property should be set. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
Hold At Location: Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, or when AddressFlags is set to Residential (i.e., for residential delivery). When this service is requested HoldAtLocation is required to be provided in the request as well. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Economy Freight, and FedEx International Priority Freight.
Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Contact FedEx for current surcharge rates. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Contact FedEx for current surcharge rates. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
International Controlled Export Service Indicates that the Controlled Export service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability. When set, the IntlExportControlledExportType, IntlExportEntryNumber, IntlExportForeignTradeZoneCode, and IntlExportLicenseNumberExpiration properties should be set. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
International Traffic in Arms Regulations Indicates that the Traffic in Arms Regulations service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability. When set, the IntlExportControlledExportType, IntlExportEntryNumber, IntlExportForeignTradeZoneCode, and IntlExportLicenseNumberExpiration properties should be set. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
Liftgate Delivery: This indicates that the liftgate delivery service is requested for this shipment. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
Liftgate Pickup: This indicates that the liftgate pickup service is requested for this shipment. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
Poison: This indicates that the shipment contains poisonous materials. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
Protection From Freezing: This indicates that the shipment should be protected from freezing. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
Saturday Delivery: Requests the shipment be delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and Saturday delivery is desired, the ground option and some express option will not be valid. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx International Priority Freight, and FedEx Freight Priority.
Saturday Pickup: Requests that the shipment be picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and Saturday pickup is desired, the ground option and some express option will not be valid. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx First Overnight Freight, FedEx International Priority Freight, FedEx Freight Economy, and FedEx Freight Priority.
Top Load: This indicates that the pallets in this shipment should not have anything stacked on top of them. This might affect the shipping rates and/or service availability. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.

SSLAcceptServerCert Property (FedExFreightRates 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.

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

SSLCert Property (FedExFreightRates 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.

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

SSLProvider Property (FedExFreightRates Component)

This specifies the SSL/TLS implementation to use.

Syntax

C#
VB.NET

public FedexfreightratesSSLProviders SSLProvider { get; set; }

enum FedexfreightratesSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As FedexfreightratesSSLProviders

Enum FedexfreightratesSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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


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 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 (FedExFreightRates 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.

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

Timeout Property (FedExFreightRates Component)

A timeout for the component.

Syntax

C#
VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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

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

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

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

The default value for the Timeout property is 60 seconds.

TotalWeight Property (FedExFreightRates Component)

The total weight of all the pieces in this shipment.

Syntax

C#
VB.NET

public string TotalWeight { get; set; }

Public Property TotalWeight As String

Default Value

Remarks

This property is required when submitting a rate request by calling GetRates method. It requires one explicit decimal position (i.e. N.N formatting, example 5.0) and has a maximum length of 12 including the decimal.

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

GetRates Method (FedExFreightRates Component)

Returns rate information for a specified or all available FedEx services.

Syntax

C#
VB.NET

public void GetRates();

Public Sub GetRates()

Remarks

To get the courtesy rate quotes for FedEx services, you can call the GetRates method. If the rates are needed for a specific service type, you will have to pass a value of the RequestedService (other than 'UNSPECIFIED') in the request. The RequestedService identifies the FedEx service for which you want to retrieve rate information. If the rates are wanted for all available FedEx services, you should not set a value to RequestedService before sending the request to the FedEx Server. It will default to 'UNSPECIFIED').

In either case, the following properties or config settings are sent in the request (if any of these have not been set, their default values will be used instead):

AuthorizationToken (required)
Server (optional)
AccountNumber (required)
RateType (required)
ShipDate (optional)
PackagingType (required)
SenderAddress (required)
RecipientAddress (required)
TotalWeight (required)
InsuredValue (optional)
Packages (required)
ShipmentSpecialServices that can affect rates and/or service availability (such as COD, Saturday Pickup, Saturday Delivery, Hold At Location, Dry Ice, etc.) (optional)

Regarding the Packages, please note the following:

when requesting rates for all available services (RequestedService set to 'UNSPECIFIED'), only one package should be added to this collection even for MPS. When rating MPS, just specify the Packages and the details for one package only. FedEx will consider all packages the same;
when requesting rates for a specific service (RequestedService set to a value other than 'UNSPECIFIED'), you will have to add as many packages as there are in the MPS specifying the package detail for each package included in the shipment.

In each above mentioned cases, if there are no packages added and specified (Packages = null), the component will throw an error.

Upon a successful response, the Services property gets populated.

If there is a problem with any of the input values within the request, the response will either raise an error (when it's an hard error) and transaction will fail, or give a warning (when it's a soft error), which can be accessed via Warning, and the transaction will go through.

For more details on errors codes and descriptions, please refer to the Error Codes section.

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

Information about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class FedexfreightratesErrorEventArgs 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 (FedExFreightRates 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, FedexfreightratesNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

Public Class FedexfreightratesNotificationEventArgs 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 (FedExFreightRates 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, FedexfreightratesSSLServerAuthenticationEventArgs e);

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

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

Remarks

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

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

SSLStatus Event (FedExFreightRates Component)

Fired when secure connection progress messages are available.

Syntax

C#
VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

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

Remarks

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

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

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

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

The fields contained by this type are listed below.

Fields

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

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

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.

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
bool (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.

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.

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
CertStoreTypes
Default Value: 0

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component 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 component. 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

C#
VB.NET

public Certificate();

Public Certificate()

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

C#
VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

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

C#
VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

C#
VB.NET

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

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

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

C#
VB.NET

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

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

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

C#
VB.NET

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

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

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

C#
VB.NET

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

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

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

C#
VB.NET

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

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

C#
VB.NET

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

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

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

FedExAccount Type

Represents the details of a FedEx account.

Remarks

This type contains data describing the FedEx server and login information.

Example: Setting the fields of an account FedExAccount account = new FedExAccount account.AccountNumber = "1234567" account.AuthorizationToken = "bearer_token_value" account.Server = "https://test.fedex.com"

The fields contained by this type are listed below.

Fields

AccountNumber
string
Default Value: ""

The account number associated with the shipment.

The AccountNumber is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

AuthorizationToken
string
Default Value: ""

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

LanguageCode
string
Default Value: "en"

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

LocaleCode
string
Default Value: "US"

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Server
string
Default Value: ""

URL for the FedEx Server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

Constructors

C#
VB.NET

public FedExAccount();

Public FedExAccount()

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

AutoDetect
bool
Default Value: False

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

FirewallType
FirewallTypes
Default Value: 0

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


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
string
Default Value: ""

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

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.

Password
string
Default Value: ""

This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Port
int
Default Value: 0

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

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

User
string
Default Value: ""

This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.

Constructors

C#
VB.NET

public Firewall();

Public Firewall()

FreightCommodityDetail 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 FreightCommodityDetail commodity = new FreightCommodityDetail(); commodity.Description = "Computer software" commodity.Manufacturer = "US" commodity.Weight = "1.0" commodity.QuantityUnit = "EA" commodity.UnitPrice = "99.99" commodity.HarmonizedCode = "9031.80.90"

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 and freight shipments. 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.

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)

FreightClass
TFreightClass
Default Value: 0

Indicates the freight class of the commodity.

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


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

FreightPackagingType
TFreightCommodityPackagingTypes
Default Value: 0

Identifies the Commodity item's packaging type. Possible values are:


fcptNone (0)
fcptBag (1)
fcptBarrel (2)
fcptBasket (3)
fcptBox (4)
fcptBucket (5)
fcptBundle (6)
fcptCage (7)
fcptCarton (8)
fcptCase (9)
fcptChest (10)
fcptContainer (11)
fcptCrate (12)
fcptCylinder (13)
fcptDrum (14)
fcptEnvelope (15)
fcptHamper (16)
fcptOther (17)
fcptPackage (18)
fcptPail (19)
fcptPallet (20)
fcptParcel (21)
fcptPiece (22)
fcptReel (23)
fcptRoll (24)
fcptSack (25)
fcptShrinkwrapped (26)
fcptSkid (27)
fcptTank (28)
fcptTotebin (29)
fcptTube (30)
fcptUnit (31)

HandlingUnits
int
Default Value: 1

Number of individual handling units to which this commodity applies. (NOTE: Total of commodity-level handling units may not balance to shipment-level total handling units.)

HarmonizedCode
string
Default Value: ""

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

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

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

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

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

HazardousMaterialsOptions
int
Default Value: 0

Indicates the kind of hazardous material content in this commodity.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple options:


Value	Meaning
0x00000001	Hazardous Materials
0x00000002	Battery
0x00000004	Other Regulated Materials - Domestic (ORM-D)
0x00000008	Reportable Quantities
0x00000010	Small Quantity Exception
0x00000020	Limited Quantities Commodities

Height
int
Default Value: 1

The height of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Id
string
Default Value: ""

A unique identifier assigned to this line item.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Length
int
Default Value: 1

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Manufacturer
string
Default Value: "US"

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

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

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

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

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

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


Country Name	Country Code	Currency Code	Max Weight	Address Validation Supported	Postal Code Req.	Euro Country
Albania	AL	ALL	70 KGS	No	No	No
Algeria	DZ	DZD	70 KGS	No	No	No
Andorra	AD	PTS	70 KGS	No	No	No
Angola	AO	AOK	70 KGS	No	No	No
Anguilla	AI	XCD	150 LBS	No	No	No
Antigua & Barbuda	AG	XCD	150 LBS	No	No	No
Argentina	AR	ARP	70 KGS	Yes	Yes	No
Armenia	AM	USD	70 KGS	No	Yes	No
Aruba	AW	AWG	150 LBS	No	No	No
Australia	AU	AUD	70 KGS	Yes	Yes	No
Austria (EU Member)	AT	EUR	70 KGS	No	Yes	Yes
Azerbaijan	AZ	RUR	70 KGS	No	Yes	No
Bahamas	BS	BSD	150 LBS	No	No	No
Bahrain	BH	BHD	70 KGS	No	No	No
Bangladesh	BD	BDT	70 KGS	No	Yes	No
Barbados	BB	BBD	150 LBS	No	No	No
Belarus	BY	RUR	70 KGS	No	Yes	No
Belgium (EU Member)	BE	EUR	70 KGS	No	Yes	Yes
Belize	BZ	BZD	150 LBS	No	No	No
Benin	BJ	XOF	70 KGS	No	No	No
Bermuda	BM	BMD	150 LBS	No	No	No
Bolivia	BO	BOP	70 KGS	No	No	No
Bosnia-Herzegovina	BA	BAD	70 KGS	No	Yes	No
Botswana	BW	BWP	70 KGS	No	No	No
Brazil	BR	BRC	70 KGS	Yes	Yes	No
British Virgin Islands	VG	USD	150 LBS	No	No	No
Brunei	BN	BND	70 KGS	No	No	No
Bulgaria	BG	BGL	70 KGS	No	Yes	No
Burkina Faso	BF	XOF	70 KGS	No	No	No
Burundi	BI	BIF	70 KGS	No	No	No
Cambodia	KH	USD	70 KGS	No	No	No
Cameroon	CM	XAF	70 KGS	No	No	No
Canada	CA	CAD	150 LBS	Yes	Yes	No
Cape Verde	CV	USD	70 KGS	No	No	No
Cayman Islands	KY	KYD	150 LBS	No	No	No
Central African Rep	CF	XAF	70 KGS	No	No	No
Chad	TD	XAF	70 KGS	No	No	No
Channel Islands	CD	GBP	70 KGS	No	Yes	No
Chile	CL	CLP	70 KGS	Yes	No	No
China	CN	CNY	70 KGS	Yes	Yes	No
Colombia	CO	COP	70 KGS	Yes	No	No
Congo	CG	XAF	70 KGS	No	No	No
Cook Islands	CK	NZD	70 KGS	No	No	No
Costa Rica	CR	CRC	70 KGS	No	No	No
Croatia	HR	YUD	70 KGS	No	Yes	No
Cyprus	CY	CYP	70 KGS	No	No	No
Czech Republic	CZ	CZK	70 KGS	No	Yes	No
Dem Rep of Congo (Zaire)	ZR	ZRZ	70 KGS	No	No	No
Denmark (EU Member)	DK	DKK	70 KGS	Yes	Yes	Yes
Djibouti	DJ	DJF	70 KGS	No	No	No
Dominica	DM	XCD	150 LBS	No	No	No
Dominican Republic	DO	DOP	150 LBS	No	No	No
Ecuador	EC	ECS	70 KGS	No	No	No
Egypt	EG	EGP	70 KGS	No	No	No
El Salvador	SV	SVC	70 KGS	No	No	No
Equatorial Guinea	GQ	XAF	70 KGS	No	No	No
Eritrea	ER	DKK	70 KGS	No	No	No
Estonia	EE	EEK	70 KGS	No	Yes	No
Ethiopia	ET	ETB	70 KGS	No	No	No
Faeroe Islands	FO	DKK	70 KGS	No	Yes	No
Fiji	FJ	FJD	70 KGS	No	No	No
Finland (EU Member)	FI	EUR	70 KGS	No	Yes	Yes
France (EU Member)	FR	EUR	70 KGS	Yes	Yes	Yes
French Guiana	GF	FRF	70 KGS	No	No	No
French Polynesia	PF	XPF	70 KGS	No	No	No
Gabon	GA	XAF	70 KGS	No	No	No
Gambia	GM	GMD	70 KGS	No	No	No
Georgia	GE	RUR	70 KGS	No	Yes	No
Germany (EU Member)	DE	EUR	70 KGS	Yes	Yes	Yes
Ghana	GH	GHC	70 KGS	No	No	No
Gibraltar	GI	GIP	70 KGS	No	No	No
Greece (EU Member)	GR	EUR	70 KGS	No	Yes	Yes
Greenland	GL	DKK	70 KGS	No	Yes	No
Grenada	GD	XCD	150 LBS	No	No	No
Guadeloupe	GP	FRF	150 LBS	No	No	No
Guam	GU	USD	150 LBS	No	No	No
Guatemala	GT	GTO	70 KGS	No	No	No
Guinea	GN	GNS	70 KGS	No	No	No
Guinea-Bissau	GW	GWP	70 KGS	No	No	No
Guyana	GY	GYD	70 KGS	No	No	No
Haiti	HT	HTG	150 LBS	No	No	No
Honduras	HN	HNL	70 KGS	No	No	No
Hong Kong	HK	HKD	70 KGS	No	No	No
Hungary	HU	HUF	70 KGS	No	Yes	Yes
Iceland	IS	ISK	70 KGS	No	Yes	Yes
India	IN	INR	70 KGS	Yes	Yes	No
Indonesia	ID	IDR	70 KGS	No	Yes	No
Iran	IR	IRR	70 KGS	No	No	No
Iraq	IQ	IQD	70 KGS	No	No	No
Ireland (EU Member)	IE	EUR	70 KGS	Yes	No	Yes
Israel	IL	ILS	70 KGS	No	Yes	Yes
Italy (EU Member)	IT	EUR	70 KGS	Yes	Yes	Yes
Ivory Coast	CI	XOF	70 KGS	No	No	No
Jamaica	JM	KMD	70 KGS	No	No	No
Japan	JP	JPY	70 KGS	Yes	Yes	No
Jordan	JO	JOD	70 KGS	No	No	No
Kazakhstan	KZ	RUR	70 KGS	No	Yes	No
Kenya	KE	KES	70 KGS	No	No	No
Kiribati	KI	AUD	70 KGS	No	No	No
Kuwait	KW	KWD	70 KGS	No	No	No
Kyrgyzstan	KG	RUR	70 KGS	No	Yes	No
Laos	LA	USD	70 KGS	No	No	No
Latvia	LV	RUR	70 KGS	No	Yes	No
Lebanon	LB	LBP	70 KGS	No	No	No
Lesotho	LS	ZAR	70 KGS	No	No	No
Liberia	LR	LRD	70 KGS	No	No	No
Libya	LY	LYD	70 KGS	No	No	No
Liechtenstein	LI	CHF	70 KGS	No	Yes	No
Lithuania	LT	LTL	70 KGS	No	Yes	No
Luxembourg	LU	LUF	70 KGS	No	Yes	Yes
Macau	MO	MOP	70 KGS	No	No	No
Macedonia (FYROM)	MK	USD	70 KGS	No	Yes	Yes
Madagascar	MG	MGF	70 KGS	No	No	No
Malawi	MW	MWK	70 KGS	No	No	No
Malaysia	MY	MYR	70 KGS	Yes	Yes	No
Maldives	MV	MVR	70 KGS	No	No	No
Mali	ML	MLF	70 KGS	No	No	No
Malta	MT	MTP	70 KGS	No	No	No
Marshall Islands	MH	USD	70 KGS	No	Yes	No
Martinique	MQ	FRF	150 LBS	No	Yes	No
Mauritania	MR	MRO	70 KGS	No	No	No
Mauritius	MU	MUR	70 KGS	No	No	No
Mexico	MX	MXP	70 KGS	Yes	Yes	No
Micronesia	FM	USD	70 KGS	No	Yes	No
Moldova	MD	EUR	70 KGS	No	Yes	Yes
Monaco (EU Member)	MC	EUR	70 KGS	No	Yes	Yes
Mongolia	MN	USD	70 KGS	No	Yes	No
Montserrat	MS	XCD	150 LBS	No	No	No
Morocco	MA	MAD	70 KGS	No	No	No
Mozambique	MZ	MZM	70 KGS	No	No	No
Myanmar	MM	USD	70 KGS	No	No	No
N. Mariana Islands	MP	USD	150 LBS	No	No	No
Namibia	NA	ZAR	70 KGS	No	No	No
Nepal	NP	NPR	70 KGS	No	Yes	No
Netherlands (EU Member)	NL	EUR	70 KGS	Yes	Yes	Yes
Netherlands Antilles	AN	ANG	150 LBS	No	No	No
New Caledonia	NC	XPF	70 KGS	No	No	No
New Zealand	NZ	NZD	70 KGS	Yes	Yes	No
Nicaragua	NI	NIC	70 KGS	No	No	No
Niger	NE	XOF	70 KGS	No	No	No
Nigeria	NG	NGN	70 KGS	No	No	No
Norfolk Island	NF	AUD	70 KGS	No	No	No
Norway	NO	NOK	70 KGS	No	Yes	Yes
Oman	OM	OMR	70 KGS	No	No	No
Pakistan	PK	PKR	70 KGS	No	Yes	No
Palau	PW	USD	70 KGS	No	Yes	No
Panama	PA	PAB	70 KGS	No	No	No
Papua New Guinea	PG	PGK	70 KGS	No	No	No
Paraguay	PY	PYG	70 KGS	No	No	No
Peru	PE	PES	70 KGS	Yes	No	No
Philippines	PH	PHP	70 KGS	Yes	Yes	No
Poland	PL	PLZ	70 KGS	No	Yes	Yes
Portugal(EU Member)	PT	EUR	70 KGS	No	Yes	Yes
Puerto Rico	PR	USD	150 LBS	Yes	Yes	No
Qatar	QA	QAR	70 KGS	No	No	No
Reunion Is.	RE	FRF	70 KGS	No	Yes	No
Romania	RO	ROL	70 KGS	No	Yes	Yes
Russia	RU	RUR	70 KGS	No	Yes	No
Rwanda	RW	RWF	70 KGS	No	No	No
Samoa (Amer.)	AS	USD	70 KGS	No	No	No
Samoa (Western)	WS	NZD	70 KGS	No	No	No
San Marino	IT	ITL	70 KGS	No	Yes	Yes
Saudi Arabia	SA	SAR	70 KGS	No	Yes	No
Senegal	SN	XOF	70 KGS	No	No	No
Serbia & Montenegro	CS	YUD	70 KGS	No	Yes	Yes
Seychelles	SC	SCR	70 KGS	No	No	No
Sierra Leone	SL	SLL	70 KGS	No	No	No
Singapore	SG	SGD	70 KGS	Yes	Yes	No
Slovak Republic	SK	SKK	70 KGS	No	Yes	Yes
Slovenia	SI	SIT	70 KGS	No	Yes	Yes
Solomon Islands	SB	SBD	70 KGS	No	No	No
South Africa	ZA	GBP	70 KGS	Yes	Yes	No
South Korea	KR	KRW	70 KGS	No	Yes	No
Spain (EU Member)	ES	EUR	70 KGS	Yes	Yes	Yes
Sri Lanka	LK	LKR	70 KGS	No	Yes	No
St. Christopher	KN	XCD	150 LBS	No	No	No
St. Lucia	LC	XCD	150 LBS	No	No	No
St. Vincent/Grenadines	VC	XCD	150 LBS	No	No	No
Sudan	SD	SDP	70 KGS	No	No	No
Suriname	SR	SRG	70 KGS	No	No	No
Swaziland	SZ	SZL	70 KGS	No	No	No
Sweden (EU Member)	SE	SEK	70 KGS	No	Yes	Yes
Switzerland	CH	CHF	70 KGS	Yes	Yes	Yes
Syria	SY	SYP	70 KGS	No	No	No
Taiwan	TW	NTD	70 KGS	No	Yes	No
Tajikistan	TJ	RUR	70 KGS	No	Yes	No
Tanzania	TZ	TZS	70 KGS	No	No	No
Thailand	TH	THB	70 KGS	No	Yes	No
Togo	TG	XOF	70 KGS	No	No	No
Tonga	TO	TOP	70 KGS	No	No	No
Trinidad & Tobago	TT	TTD	150 LBS	No	No	No
Tunisia	TN	TND	70 KGS	No	No	No
Turkey	TR	TRL	70 KGS	No	Yes	Yes
Turkmenistan	TM	RUR	70 KGS	No	Yes	No
Turks & Caicos Islands	TC	USD	150 LBS	No	No	No
Tuvalu	TV	AUD	70 KGS	No	No	No
Uganda	UG	UGS	70 KGS	No	No	No
Ukraine	UA	UAK	70 KGS	No	Yes	No
United Arab Emirates	AE	AED	70 KGS	No	No	No
United Kingdom(EU Member)	GB	GBP	70 KGS	Yes	Yes	Yes
United States	US	USD	150 LBS	Yes	Yes	No
Uruguay	UY	UYP	70 KGS	No	Yes	No
US Virgin Islands	VI	USD	150 LBS	No	Yes	No
Uzbekistan	UZ	RUR	70 KGS	No	Yes	No
Vanuatu	VU	VUV	70 KGS	No	No	No
Venezuela	VE	VEB	70 KGS	Yes	No	No
Vietnam	VN	USD	70 KGS	No	Yes	No
Wake Island	WK	USD	70 KGS	No	No	No
Wallis & Futuna Isle	WF	XPF	70 KGS	No	No	No
Yemen	YE	YER	70 KGS	No	No	No
Zambia	ZM	ZMK	70 KGS	No	No	No
Zimbabwe	ZW	ZWD	70 KGS	No	No	No

NmfcCode
string
Default Value: ""

NMFC Code for commodity.

NumberOfPieces
int
Default Value: 1

The total number of packages, cartons, or containers for the commodity line item.

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

PartNumber
string
Default Value: ""

The part number of this commodity line item.

PONumber
string
Default Value: ""

The PO Number for printed reference per commodity.

Quantity
int
Default Value: 1

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

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

QuantityUnit
string
Default Value: "EA"

Unit of measure used to express the Quantity of this commodity line item.

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

Here is a list of possible values for FedEx:


Value	Description
AR	Carat
CG	Centigram
CM	Centimeters
CM3	Cubic Centimeters
CFT	Cubic Feet
M3	Cubic Meters
DOZ	Dozen
DPR	Dozen Pair
EA	Each
GAL	Gallon
G	Grams
GR	Gross
KGM	Kilogram
KG	Kilograms
LFT	Linear Foot
LNM	Linear Meters
LYD	Linear Yard
L	Liter
LTR	Liters
M	Meters
MG	Milligram
ML	Milliliter
NO	Number
OZ	Ounces
PR	Pair
PRS	Pairs
PCS	Pieces
LB	Pound
CM2	Square centimeters
SFT	Square feet
SQI	Square inches
M2	Square meters
SYD	Square yards
YD	Yard

UnitPrice
string
Default Value: "1.00"

Value of each QuantityUnit in Quantity of this commodity line item. This is used in conjunction with the QuantityUnit and Quantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

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

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

Value
string
Default Value: ""

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

Volume
string
Default Value: "0.0"

This should contain the volume of the freight item. This should be specified in cubic feet if SizeUnit is set to IN and cubic meters if SizeUnit is set to CM.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Weight
string
Default Value: "0.00"

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

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

Width
int
Default Value: 1

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Constructors

C#
VB.NET

public FreightCommodityDetail();

Public FreightCommodityDetail()

C#
VB.NET

public FreightCommodityDetail(string description, int freightClass, int freightPackagingType, int handlingUnits, string harmonizedCode, string manufacturer, int numberOfPieces, int quantity, string quantityUnit, string unitPrice, string weight, int length, int width, int height, string volume);

Public FreightCommodityDetail(ByVal Description As String, ByVal FreightClass As Integer, ByVal FreightPackagingType As Integer, ByVal HandlingUnits As Integer, ByVal HarmonizedCode As String, ByVal Manufacturer As String, ByVal NumberOfPieces As Integer, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Volume As String)

C#
VB.NET

public FreightCommodityDetail(string description, int freightClass, int freightPackagingType, int handlingUnits, string weight, int length, int width, int height, string volume);

Public FreightCommodityDetail(ByVal Description As String, ByVal FreightClass As Integer, ByVal FreightPackagingType As Integer, ByVal HandlingUnits As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Volume As String)

C#
VB.NET

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

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

C#
VB.NET

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

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

C#
VB.NET

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

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

C#
VB.NET

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

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

FreightGuaranteeDetail Type

Indicates the freight guarantee details.

Remarks

This type provide the details for when the freight shipment is guaranteed for.

Example: Setting the fields for the freight guarantee details

FreightGuaranteeDetail detail = new FreightGuaranteeDetail detail.Type = TFreightGuaranteeType.fgtGuaranteedMorning detail.Date = "2013-08-15"

Fields

Date
string
Default Value: ""

The date the freight shipment is guaranteed for.

The valid format for the date is YYYY-MM-DD

Type
TFreightGuaranteeTypes
Default Value: 0

Specifies what type of freight guarantee is requested.

The valid values are:


Value	Description
fgtGuaranteedDate (0)	Guaranteed to arrive on date specified
fgtGuaranteedMorning (1)	Guaranteed to arrive the morning of the date specified

Constructors

C#
VB.NET

public FreightGuaranteeDetail();

Public FreightGuaranteeDetail()

FreightShipmentDetail Type

Indicates the freight shipment details.

Remarks

This contains the details necessary when sending a freight shipment when the ServiceType is set to either stFedExFreightEconomy or stFedExFreightPriority.

Fields

AccountNumber
string
Default Value: ""

This is the account number to be used with a freight shipment. This is required when submitting a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingAccountNumber
string
Default Value: ""

This should be set to the alternate account number to be billed. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingCity
string
Default Value: ""

This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingCompanyName
string
Default Value: ""

This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingCountryCode
string
Default Value: ""

This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingPersonName
string
Default Value: ""

This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingPhone
string
Default Value: ""

This should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingState
string
Default Value: ""

This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingStreetAddress
string
Default Value: ""

This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingZipCode
string
Default Value: ""

This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingAddress1
string
Default Value: ""

This should be set to the first address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingAddress2
string
Default Value: ""

This should be set to the second address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingCity
string
Default Value: ""

This should be set to the city listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingCompanyName
string
Default Value: ""

This should be set to the name of the company listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingCountryCode
string
Default Value: ""

This should be set to the country code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingEmail
string
Default Value: ""

This should be set to the email address listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingFax
string
Default Value: ""

This should be set to the fax number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingPersonName
string
Default Value: ""

This should be set to the name of the person listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingPhone
string
Default Value: ""

This should be set to the phone number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingState
string
Default Value: ""

This should be set to the state listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingZipCode
string
Default Value: ""

This should be set to the zip code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

ClientDiscountPercent
string
Default Value: ""

The estimated client discount rate for a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

CollectTermsType
TCollectTermsTypes
Default Value: 0

This sets the terms for how to collect payment for this freight shipment. Default value is 0.

Valid values are as follows:


Value	Meaning
0	Standard
1	Non-Recourse Shipper Signed

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Comments
string
Default Value: ""

The description for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Coupons
string
Default Value: ""

This contains a semicolon delimited list of identifiers for promotional discounts offered to customers. For example: coupon1; coupon2; coupon3.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

DeclaredValue
string
Default Value: ""

The total declared value per unit for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

DeclaredValueUnits
string
Default Value: ""

Identifies the declared value units corresponding to the above defined declared value.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

EmergencyContactPhone
string
Default Value: ""

The phone number for the emergency contact. This is required if any of the Commodities line items contain hazardous materials.

HazardousMaterialsOfferor
string
Default Value: ""

If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

LiabilityCoverageAmount
string
Default Value: ""

This should be set to the total value of the liability coverage.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

LiabilityCoverageType
TLiabilityCoverageTypes
Default Value: 0

This should be set to the type of liability coverage offered.

Valid values are as follows:


Value	Meaning
0	New
1	Used or Reconditioned

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

PalletWeight
string
Default Value: ""

This should contain the total weight of all pallets used in this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Role
TFreightShipmentRoles
Default Value: 0

This indicates the role of the party is submitting the transaction for this freight shipment.

Valid values are as follows:


Value	Meaning
0	Shipper
1	Consignee

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalHandlingUnits
int
Default Value: 1

Total number of individual handling units in the entire shipment (for unit pricing).

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalHeight
int
Default Value: 0

This should be set to the total height of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalLength
int
Default Value: 0

This should be set to the total length of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalWidth
int
Default Value: 0

This should be set to the total width of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Constructors

C#
VB.NET

public FreightShipmentDetail();

Public FreightShipmentDetail()

PackageDetail Type

Represents a single package contained in shipment.

Remarks

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

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

The fields contained by this type are listed below.

Fields

BaseCharge
string (read-only)
Default Value: ""

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

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

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

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

CODAmount
string
Default Value: ""

The COD monetary value for the package.

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

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

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

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

This field is not applicable to USPS packages.

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

This is not applicable for Canada Post.

CODFile
string
Default Value: ""

Filename and location to save the CODLabel of this package to. This is applicable for package(s) that use the COD service.

When the CODFile is set to a valid path and filename, the contents of the CODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then CODFile has to have .pdf extension).

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

This field is only applicable to FedEx shipments.

CODLabel
string (read-only)
Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This field is only applicable to FedEx.

CODLabelB
byte [] (read-only)
Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This field is only applicable to FedEx.

CODType
TPCODTypes
Default Value: 0

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

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

Valid values are:


Value	Description
codtpAny (0)	Company check, personal check, cashier's check or money order - UPS no cash allowed. Not applicable for Canada Post
codtpCash (1)	Cash - FedEx only, only valid for Ground shipments
codtpGuaranteedFunds (2)	Cashier's check or money order
codtpCompanyCheck (3)	Company check - FedEx and Canada Post only
codtpPersonalCheck (4)	Personal check - FedEx and Canada Post only

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

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

DangerousGoodsAccessible
bool
Default Value: False

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This field is only applicable to FedEx shipments, and is required to be specified when the SpecialServices contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The DangerousGoodsAccessible should be set to True.
Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The DangerousGoodsAccessible should be set to False.

The accessibility type affects the service availability and rates.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates component by requesting rates for all available services.

DangerousGoodsOptions
int
Default Value: 0

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:


Value	Meaning
0x00000001	Hazardous Materials
0x00000002	Battery
0x00000004	Other Regulated Materials - Domestic (ORM-D)
0x00000008	Reportable Quantities
0x00000010	Small Quantity Exception
0x00000020	Limited Quantities Commodities

Note: This is only valid when using FedEx.

Description
string
Default Value: ""

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

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

This does not apply for USPS and Canada Post.

Girth
int
Default Value: 0

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

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

Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

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

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Height
int
Default Value: 0

The height of the package to be shipped.

For FedEx, the Height is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

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

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

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

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

Id
string
Default Value: ""

An 8-digit Unique Parcel Identification Number.

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

InsuredValue
string
Default Value: ""

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

Length
int
Default Value: 0

The length of the package to be shipped.

For FedEx, the Length is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Width and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

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

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

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

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

For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Note: For parcels, the Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

NetCharge
string
Default Value: ""

Actual Net Charge applicable to this package.

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

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

In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

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

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

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

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

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

PackagingType
TPackagingTypes
Default Value: 0

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

Possible values are:


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

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

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

If the PackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: Length, Width, and Height.

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

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

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

Also the following restrictions apply when using UPS Mail Innovations:


ServiceType	PackagingType	Weight
stFirstClass (35)	ptFirstClass (36)	1 to 13 OZS
stPriorityMail (36)	ptPriority (37)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptMachinables (38)	6 to <16 OZS
stExpeditedMailInnovations (37)	ptIrregulars (39)	1 to <16 OZS
stExpeditedMailInnovations (37)	ptParcelPost (40)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMParcel (41)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptMediaMail (42)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMFlat (43)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptStandardFlat (44)	1 to <16 OZS
stPriorityMailInnovations (38)	ptFlats (33)	1 to 70 LBS
stPriorityMailInnovations (38)	ptParcels (34)	1 to 70 LBS
stPriorityMailInnovations (38)	ptBPM (35)	1 to 70 LBS
stEconomyMailInnovations (39)	ptFlats (33)	1 to 70 LBS
stEconomyMailInnovations (39)	ptParcels (34)	1 to 70 LBS
stEconomyMailInnovations (39)	ptBPM (35)	1 to 70 LBS

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

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

RatingAggregate
string (read-only)
Default Value: ""

Rating aggregate applicable to this package.

Reference
string
Default Value: ""

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:


Type value	Meaning
CR	Customer Reference - this gets printed on shipping label and invoice.
BL	Bill Of Lading - this gets printed on shipping label, Ground shipping reports, and in the Customer Reference element on the invoice.
IN	Invoice Number - this gets printed on shipping label and invoice.
PO	Purchase Order Number - this gets printed on shipping label and invoice.
DN	Department Number - this gets printed on shipping label and invoice.
SI	Shipment Integrity - this gets printed on invoice only.
SN	Store Number - this gets printed on shipping label and invoice.
IR	Intracountry Reglatory Reference
EPC	Electronic Product Code
RMA	RMA Number

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the Reference should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:


Code	Reference Number Type
AJ	Accounts Receivable Customer Account
AT	Appropriation Number
BM	Bill of Lading Number
9V	Collect on Delivery (COD) Number
ON	Dealer Order Number
DP	Department Number
3Q	Food and Drug Administration (FDA) Product Code
IK	Invoice Number
MK	Manifest Key Number
MJ	Model Number
PM	Part Number
PC	Production Code
PO	Purchase Order Number
RQ	Purchase Request Number
RZ	Return Authorization Number
SA	Salesperson Number
SE	Serial Number
ST	Store Number
TN	Transaction Reference Number
EI	Employer ID Number
TJ	Federal Taxpayer ID No.
SY	Social Security Number

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the Reference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

ReturnReceipt
string (read-only)
Default Value: ""

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

ReturnReceiptB
byte [] (read-only)
Default Value: ""

Image of the receipt for a return shipment.

ReturnReceiptFile
string
Default Value: ""

Filename and location to save the ReturnReceipt of this package to. This is applicable only if using UPS.

When the ReturnReceiptFile is set to a valid path and filename, the contents of the ReturnReceipt are written to disk upon successful response (if a return shipment).

The ReturnReceiptFile has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

ShippingLabel
string (read-only)
Default Value: ""

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

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

ShippingLabelB
byte [] (read-only)
Default Value: ""

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

ShippingLabelFile
string
Default Value: ""

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

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

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

ShippingLabelPart2
string (read-only)
Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format.

For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field.

ShippingLabelPart2B
byte [] (read-only)
Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

SignatureType
TSignatureTypes
Default Value: 0

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


stServiceDefault (0)	The default value for the requested service.
stAdult (1)	Available for both residential and nonresidential deliveries.
stDirect (2)	Available for both residential and nonresidential deliveries.
stIndirect (3)	Available for residential deliveries only.
stNoSignatureRequired (4)	Not available for Ground services.
stUSPSDeliveryConfirmation (5)	Available for UPS Mail Innovations only.
stAdult19 (6)	Available for Canada Post only.

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

Size
TPackages
Default Value: 0

Size of the package being mailed.

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

See below for valid entries:


Package Size	Description	ServiceType
psRegular	For Priority Mail: Package is less than one cubic foot in size. For all other ServiceTypes: Package length plus girth is 84 inches or less.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
psLarge	For Priority Mail: Package is greater than one cubic foot in size. For all other ServiceTypes: Package length plus girth measure more than 84 inches but not more than 108 inches. This tag does not affect the rate for Express Mail, Bound Printed Mater, Media Mail or Library Mail.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
dsOversize	Package length plus girth is more than 108 but not more than 130 inches. Parcel Post packages that measure more than 108 inches but not more than 130 inches in combined length and girth are charged the oversized Parcel Post rate regardless of the weight of the package.	Parcel Post only.

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

Note: Use the Length, Height, Width and optionally Girth (irregular shaped packages only) fields to specify the dimensions of the package.

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

SpecialServices
long
Default Value: 0

Contains the collection of special services offered on the package level. Valid values are:


Value	Meaning	FedEx	FedEx Freight	UPS
0x00000001	Appointment Delivery	X
0x00000002	Dangerous Goods	X	X	X
0x00000004	Dry Ice	X
0x00000008	Priority Alert	X
0x00000010	Non Standard Container	X		X
0x00000020	COD	X	X
0x00000040	Additional Handling			X
0x00000080	Signature Option	X
0x00000100	Alcohol	X

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the SpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
Dangerous Goods: Indicates that this package contains dangerous goods. When the SpecialServices contains this flag, then the DangerousGoodsAccessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the CODAmount and CODType must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the SpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the CODAmount and CODType, SignatureType, and InsuredValue.

This field is not applicable to USPS or Canada Post.

TotalDiscount
string (read-only)
Default Value: ""

Total Actual Discount applicable to this package.

This is normally specific to the FedEx AccountNumber. It is used in the FedExShip and FedExShipIntl components only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

TotalSurcharges
string (read-only)
Default Value: ""

Total Actual Surcharges applicable to this package.

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

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

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

This does not apply to USPS packages.

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

TrackingNumber
string (read-only)
Default Value: ""

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

Weight
string
Default Value: "0.0"

Weight of this package.

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

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

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

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

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

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

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

Width
int
Default Value: 0

The width of the package to be shipped.

For FedEx, the Width is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

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

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

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

For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

Constructors

C#
VB.NET

public PackageDetail();

Public PackageDetail()

C#
VB.NET

public PackageDetail(int packagingType, string weight);

Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String)

C#
VB.NET

public PackageDetail(int length, int width, int height);

Public PackageDetail(ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer)

C#
VB.NET

public PackageDetail(int packagingType, int length, int width, int height);

Public PackageDetail(ByVal PackagingType As Integer, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer)

C#
VB.NET

public PackageDetail(int packagingType, string weight, int length, int width, int height);

Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer)

C#
VB.NET

public PackageDetail(int packagingType, string weight, int length, int width, int height, int specialServices, string insuredValue, string CODAmount, int CODType, int signatureType);

Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal CODType As Integer, ByVal SignatureType As Integer)

C#
VB.NET

public PackageDetail(string weight, int length, int width, int height, int specialServices, string insuredValue, string CODAmount, bool dangerousGoodsAccessible, int signatureType);

Public PackageDetail(ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal DangerousGoodsAccessible As Boolean, ByVal SignatureType As Integer)

C#
VB.NET

public PackageDetail(string weight, int length, int width, int height, string description, string reference, int specialServices, string insuredValue, string CODAmount, bool dangerousGoodsAccessible, int signatureType, string shippingLabelFile, string CODFile);

Public PackageDetail(ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Description As String, ByVal Reference As String, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal DangerousGoodsAccessible As Boolean, ByVal SignatureType As Integer, ByVal ShippingLabelFile As String, ByVal CODFile As String)

C#
VB.NET

public PackageDetail(int packagingType, string weight, int length, int width, int height, string description, string reference, int specialServices, string insuredValue, string CODAmount, int CODType, int signatureType, string shippingLabelFile, string returnReceiptFile);

Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Description As String, ByVal Reference As String, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal CODType As Integer, ByVal SignatureType As Integer, ByVal ShippingLabelFile As String, ByVal ReturnReceiptFile As String)

PayorDetail Type

Represents the payor details responsible for payment.

Remarks

This type contains data of the responsible party for payment of shipping charges, or duties and taxes. This is used in a ship request.

Example: Setting the fields PayorDetail payor = new PayorDetail payor.Type = PT_RECIPIENT payor.AccountNumber = "123456789" payor.CountryCode = "US"

The fields contained by this type are listed below.

Fields

AccountNumber
string
Default Value: ""

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to AccountNumber.

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. Combination of Address1 and Address2 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. Combination of Address1 and Address2 should not exceed 35 characters.

City
string
Default Value: ""

Name of city, town, etc.

CountryCode
string
Default Value: "US"

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the CountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the CountryCode is required only if PayorType is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

Name
string
Default Value: ""

Identifies the payor's name.

Name is required only if PayorType is set to 'THIRDPARTY'.

Note: This field is only applicable to UPSFreightRates and UPSFreightShip.

PayorType
TPayorTypes
Default Value: 0

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:


ptSender (0)
ptRecipient (1)
ptThirdParty (2)
ptCollect (3)
ptConsignee (4)

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this field is set to a value other than 0 (ptSender), the AccountNumber and CountryCode are required to be provided in the request as well. Otherwise, those will default to AccountNumber and CountryCode.

For UPS, when set to ptSender, the AccountNumber is automatically set to AccountNumber. When ptRecipient is specified, AccountNumber and ZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the AccountNumber, ZipCode and CountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

State
string
Default Value: ""

ZipCode
string
Default Value: ""

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS AccountNumber's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the PayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

Constructors

C#
VB.NET

public PayorDetail();

Public PayorDetail()

C#
VB.NET

public PayorDetail(int payorType, string accountNumber, string countryCode);

Public PayorDetail(ByVal PayorType As Integer, ByVal AccountNumber As String, ByVal CountryCode As String)

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

AuthScheme
ProxyAuthSchemes
Default Value: 0

This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
bool
Default Value: False

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

Password
string
Default Value: ""

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

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default Value: 80

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

Server
string
Default Value: ""

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

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

SSL
ProxySSLTypes
Default Value: 0

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


psAutomatic (0)	Default setting. If the URL is an `https` URL, the component will use the `psTunnel` option. If the URL is an `http` URL, the component will use the `psNever` option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

User
string
Default Value: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

C#
VB.NET

public Proxy();

Public Proxy()

C#
VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

C#
VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

ServiceDetail Type

Indicates the rates and service details of a service.

Remarks

This type represents the details (on delivery time, rates, etc.) of a service type. The fields contained by this type are listed below.

Fields

AccountBaseCharge
string (read-only)
Default Value: ""

Transportation charges before surcharges and discounts applied to a ServiceType. This applies to FedEx only and is specific to the AccountNumber. After calling the GetRates method, the AccountBaseCharge will be filled with the value of discounted base charge amount specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For Canada Post, this field will contain the base cost of the shipment before taxes (numeric 99999.99).

AccountNetCharge
string (read-only)
Default Value: ""

Net charge amount applied to a ServiceType.

For FedEx, this is specific to the AccountNumber. After calling the GetRates method, the AccountNetCharge will be filled with the value of discounted net charge amount specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For UPS, this is the value of grand total charges for account based rating applied to a shipment when using the returned ServiceType

The UPS server response will contain negotiated rate(s) only for the qualified AccountNumbers. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

This field is not used by the USPS component.

For Canada Post, this field will contain the total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.

AccountTotalDiscount
string (read-only)
Default Value: ""

Total discount amount applied to the shipment for a ServiceType. This is for FedEx only and is specific to the AccountNumber. After calling the GetRates method, the AccountTotalDiscount will be filled with the value of total discount applied, which is specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of discounts.

AccountTotalSurcharge
string (read-only)
Default Value: ""

Total surcharge amount for all additional services applied to a ServiceType. This is only for FedEx, and is specific to the AccountNumber. After calling the GetRates method, the AccountTotalSurcharge will be filled with the value of total surcharges applied, which is specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of surcharges.

Aggregate
string (read-only)
Default Value: ""

Aggregate of details and rates for the ServiceType in the list of available services.

BusinessDays
int (read-only)
Default Value: 0

Number of business days from origin to destination location. This is valid only for UPS and is returned for the number of UPS business days (Monday, Tuesday, Wednesday, Thursday, Friday and Saturday) the shipment will take to travel from one location to another.

If applicable, this property is filled after a call to the GetShippingTime.

Commitments
string (read-only)
Default Value: ""

Service commitments for the PackagingType when shipping to CountryCode.

This is valid only for USPS, and indicates how long it will take for the package to be delivered when shipped via PackagingType.

CustomerCenterCutoff
string (read-only)
Default Value: ""

Time the UPS Customer Service Center closes.

This value is only relevant for UPS and it provides the user with the time the Customer Service Center closes. This is applicable for shipments outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

DelayDays
int (read-only)
Default Value: 0

Number of days the shipment is delayed in customs. This is only valid for UPS requests, and is returned for requests outside the US only and when the request indicates the query is in reference to a Non-Document type of shipment.

If applicable, this property is filled after a call to the GetShippingTime.

DeliveryDate
string (read-only)
Default Value: ""

This indicates the shipment delivery date for the ServiceType.

In regards to International services, the delivery date availability is limited to some postal-code supported countries. The delivery date will be returned if available. Format: YYYY-MM-DD.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

For Canada Post, this field will be populated after a GetRates call and will contain the estimated date of delivery, starting from the expected mailing-date.

DeliveryDay
string (read-only)
Default Value: ""

Indicates the day of the week the shipment can be delivered when using the ServiceType. Possible values are: SUN, MON, TUE, WED, THU, FRI, SAT. In regards to International services, the delivery date availability is limited to some postal-code supported countries and it will be returned if available.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

DeliveryTime
string (read-only)
Default Value: ""

Scheduled local delivery time. This is available only for UPS, and indicates the latest time of day the shipment will be delivered as guaranteed by UPS. Format: HH:MM:SS.

If applicable, this property is filled after a call to the GetShippingTime.

EffectiveNetDiscount
string (read-only)
Default Value: ""

Indicates the net discount applied to a ServiceType. This is only valid for FedEx.

After calling the GetRates method, the EffectiveNetDiscount will be filled with the value of net discount applied. This is specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx). This is the difference between the list net charge and account net charge.

GuaranteedDescription
string (read-only)
Default Value: ""

Textual description of a guaranteed delivery for a UPS service type in the list of available services returned. This is populated when the GetShippingTime method is called for UPS only.

This method is also populated for Canada Post after the GetRates method is called. The returned value will either be "true" or "false" to indicate whether the delivery date is guaranteed.

Holidays
int (read-only)
Default Value: 0

Number of national holidays during transit. This is returned only for UPS when the shipment would be in transit during a national holiday. Holidays outside the US are taken into account. Returned for requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

IndemnityCoverage
string (read-only)
Default Value: ""

Indicates the indemnity coverage available for this service. This property is valid only for USPS, and is only returned when TotalValue was sent in the request. It contains the lesser of maximum parcel indemnity coverage per given weight and TotalValue, if applicable. Otherwise it will be blank.

InsuranceComment
string (read-only)
Default Value: ""

Explains why no InsuranceCost was returned in the response.

This field is only applicable to USPS.

If the TotalValue was sent in the request (indicating you wish to receive the InsuranceCost in the response), but no InsuranceCost was returned, then InsuranceComment will contain text explaining why no value was returned for InsuranceCost. It may be one of three reasons:


Value	Meaning
SERVICE	Insurance is not available for this service.
DESTINATION	Insurance is not available to the given country via this service.
INSURED VALUE	Insurance is available for the country and service, but not for the given value.

InsuranceCost
string (read-only)
Default Value: ""

Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package.

ListBaseCharge
string (read-only)
Default Value: ""

Transportation charges before surcharges and discounts applied to a ServiceType. After calling the GetRates method, the ListBaseCharge will be filled with the value of base charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This does not apply to USPS.

ListNetCharge
string (read-only)
Default Value: ""

Net charge amount applied to a ServiceType.

After calling the GetRates method, the ListNetCharge will be filled with the value of list net charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

ListTotalDiscount
string (read-only)
Default Value: ""

Total discount amount applied to a ServiceType. This applies only to FedEx. After calling the GetRates method, the ListTotalDiscount will be filled with the value of total discount applied. This is returned in the server response only if the RateType is set to 0 (rtList) in the request.

ListTotalSurcharge
string (read-only)
Default Value: ""

Total surcharge amount for all additional services applied to a ServiceType.

After calling the GetRates method, the ListTotalSurcharge will be filled with the value of total surcharges applied.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This value does not apply to USPS.

MaxDimensions
string (read-only)
Default Value: ""

Maximum dimensions of a package allowed when sending to the CountryCode. This is only applicable to USPS. After a call to GetRates, this property will contain the maximum allowable dimensions of a package sent to the CountryCode via the indicated ServiceType.

MaxWeight
string (read-only)
Default Value: ""

Maximum weight of package allowed when sending to the CountryCode.

This is only applicable to USPS.

After a call to GetRates, this field will contain the maximum allowable weight (in pounds) of a package sent to the CountryCode via the indicated ServiceType.

Note: This field may contain a fractional quantity (eg: "0.2188", which indicates a max weight of 3.5 ounces).

PackagingType
string (read-only)
Default Value: ""

The mail service type when shipping to CountryCode.

This is only valid for USPS international rate requests.

PackagingType indicates what type of shipping service is being used for each InternationalService. PackagingType may contain the following information:


Priority	Priority Mail rate.
FirstClass	First Class rate.
ParcelPost	Parcel Post rate.
BPM	Bound Printed Matter rate (books, magazines).
Media	Media Mail rate (CDs, movies, etc).
Library	Inter-library mail rate (not for public use).
Express	Express Mail rate.

RateScale
string (read-only)
Default Value: ""

Applicable rate scale for the ServiceType.

The RateScale indicates the rate scale (this is specific to the AccountNumber) used by FedEx to rate a shipment when shipped via the ServiceType. This is applicable for FedEx Express services only.

RateZone
string (read-only)
Default Value: ""

Applicable rate zone for the ServiceType.

The RateZone indicates the zone used by FedEx to rate a shipment (this is specific to the ZipCode) when using a FedEx Express service. This is applicable for FedEx Express services only.

RestDays
int (read-only)
Default Value: 0

Number of days the shipment is in rest due to non-business days. Returned for UPS requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

ServiceType
ServiceTypes (read-only)
Default Value: 0

Indicates the service type in the list of available services returned.

This is populated when the GetShippingTime or GetRates methods are called.

Valid values for FedEx are:


stUnspecified (0)
stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15)
stFedExGroundHomeDelivery (16)
stFedEx1DayFreight (17)
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriority (20)
stFedExInternationalEconomy (21)
stFedExInternationalFirst (22)
stFedExInternationalPriorityFreight (23)
stFedExInternationalEconomyFreight (24)
stFedExEuropeFirstInternationalPriority (25)	For intra-Europe shipments only.
stFedExSmartPost (26)
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExInternationalPriorityExpress (32)
stFedExInternationalConnectPlus (33)
stFedExFirst (140)	For EU and APAC Regions only.
stFedExPriority (141)	For EU and APAC Regions only.
stFedExPriorityExpress (142)	For EU and APAC Regions only.
stFedExPriorityExpressFreight (143)	For EU and APAC Regions only.
stFedExPriorityFreight (144)	For EU and APAC Regions only.
stFedExEconomySelect (145)	For UK only.

Valid values for UPS are:


Value	Applicable for
stUnspecified (0)
stUPSFirstClass(35)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMail(36)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSExpeditedMailInnovations(37)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMailInnovations (38)	All origins, requires a contract with Mail Innovations, single package shipments only
stUPSEconomyMailInnovations (39)	All Origins, requires a contract with Mail Innovations, single package shipments only
stUPSNextDayAir (40)	US Domestic Shipments; Originating in US/PR
stUPSExpress (41)	Polish Domestic Shipments; All Origins
stUPS2ndDayAir (42)	US Domestic Shipments; Originating in US/PR
stUPSGround (43)	US Domestic Shipments; Originating in US/PR
stUPSWorldwideExpress (44)	Originating in US/PR
stUPSWorldwideExpedited (45)	US/PR, Canada and Non-EU origins, EXCEPT Mexico
stUPSExpedited (46)	Polish Domestic Shipments; Originating in EU or Mexico
stUPSStandard (47)	Polish Domestic Shipments; All Origins
stUPS3DaySelect (48)	US Domestic Shipments; Originating in CA or US
stUPSNextDayAirSaver (49)	US Domestic Shipments
stUPSSaver (50)	US or Polish Domestic Shipments; All Origins
stUPSNextDayAirEarlyAM (51)	US Domestic Shipments; Originating in CA or US/PR
stUPSExpressEarlyAM (52)	Originating in CA
stUPSWorldwideExpressPlus (53)	Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico
stUPSExpressPlus (54)	Originating in Mexico
stUPS2ndDayAirAM (55)	US Domestic Shipments; Originating in US
stUPSTodayStandard (56)	Polish Domestic Shipments (Stolica)
stUPSTodayCourrier (57)	Polish Domestic Shipments (Stolica)
stUPSTodayInterCity (58)	Polish Domestic Shipments (Stolica)
stUPSTodayExpress (59)	Polish Domestic Shipments (Stolica)
stUPSTodayExpressSaver (60)	Polish Domestic Shipments (Stolica)
stUPSWorldwideExpressFreight (61)	All Origins; Worldwide Express Freight
stUPSSurePostLessThan1LB (62)	US Domestic Shipments, SurePost Less Than 1LB
stUPSSurePost1LBOrGreater (63)	US Domestic Shipments, SurePost 1LB Or Greater
stUPSSurePostBPM (64)	US Domestic Shipments, SurePost BPM (Bound Printed Matter)
stUPSSurePostMedia (65)	US Domestic Shipments, SurePost Media
stUPSWorldwideEconomyDDU (131)	Originating in Canada or US, requires a contract with UPS
stUPSWorldwideEconomyDDP (132)	Originating in Canada or US, requires a contract with UPS

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

Valid values for USPS are:


stUnspecified (0)
stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSBPM (74) (USPS Only )
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only )
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)
stUSPSPriorityExpress (85) (Endicia only)
stUSPSRetailGround (86) (Endicia only)
stUSPSParcelSelectGround (133)
stUSPSPriorityMailCubic (134)
stUSPSGroundAdvantage (135)
stUSPSGroundAdvantageCubic (136)

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

Valid values for Canada Post are:


stCanadaRegularParcel (90)
stCanadaExpeditedParcel (91)
stCanadaXpresspost (92)
stCanadaXpresspostCertified (93)
stCanadaPriority (94)
stCanadaPriorityEnvelopeUSA (95)
stCanadaPriorityPakUSA (96)
stCanadaPriorityParcelUSA (97)
stCanadaXpresspostUSA (98)
stCanadaExpeditedParcelUSA (99)
stCanadaSmallPacketAirUSA (100)
stCanadaSmallPacketLandUSA (101)
stCanadaPriorityEnvelopeInternational (102)
stCanadaPriorityPakInternational (103)
stCanadaPriorityParcelInternational (104)
stCanadaXpresspostInternational (105)
stCanadaSmallPacketAirInternational (106)
stCanadaSmallPacketLandInternational (107)
stCanadaParcelAirInternational (108)
stCanadaParcelLandInternational (109)

ServiceTypeDescription
string (read-only)
Default Value: ""

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:


Service Type	Service Type Description
10	PRIORITY_OVERNIGHT
11	STANDARD_OVERNIGHT
12	FIRST_OVERNIGHT
13	FEDEX_2_DAY
14	FEDEX_EXPRESS_SAVER
15	FEDEX_GROUND
16	GROUND_HOME_DELIVERY
17	FEDEX_1_DAY_FREIGHT
18	FEDEX_2_DAY_FREIGHT
19	FEDEX_3_DAY_FREIGHT
20	FEDEX_INTERNATIONAL_PRIORITY
21	INTERNATIONAL_ECONOMY
22	INTERNATIONAL_FIRST
23	INTERNATIONAL_PRIORITY_FREIGHT
24	INTERNATIONAL_ECONOMY_FREIGHT
25	EUROPE_FIRST_INTERNATIONAL_PRIORITY
26	SMART_POST
27	FEDEX_2_DAY_AM
28	FEDEX_FIRST_FREIGHT
30	FEDEX_FREIGHT_ECONOMY
31	FEDEX_FREIGHT_PRIORITY
32	FEDEX_INTERNATIONAL_PRIORITY_EXPRESS
33	FEDEX_INTERNATIONAL_CONNECT_PLUS
140	FEDEX_FIRST
141	FEDEX_PRIORITY
142	FEDEX_PRIORITY_EXPRESS
143	FEDEX_PRIORITY_EXPRESS_FREIGHT
144	FEDEX_PRIORITY_FREIGHT
145	FEDEX_ECONOMY_SELECT

ShipDate
string (read-only)
Default Value: ""

Date UPS picks up the package from the origin. In the event the ShipDate differs from the ShipDate provided in the request, a warning message will be returned.

This is only applicable to UPS GetShippingTime.

Format: YYYY-MM-DD.

ShipTime
string (read-only)
Default Value: ""

Time UPS picks up the package from the origin. It is returned for requests outside the US. If applicable, this property is filled after a call to the GetShippingTime.

This is only applicable to UPS GetShippingTime.

Format: HH:MM:SS

SignatureType
string (read-only)
Default Value: ""

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType. This might be different from the requested SignatureType.

Possible returned values are:


ADULT
DIRECT
INDIRECT
NO_SIGNATURE_REQUIRED
SERVICE_DEFAULT

TransitTime
string (read-only)
Default Value: ""

Expected number of days in transit from pickup to delivery for the ServiceType. This is an estimate only and depends on the customs clearance times. It is optional to be returned in the server reply.

Config Settings (FedExFreightRates Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

FedExFreightRates Config Settings

AccountExchangeRate[i]: The exchange rate use when converting currency.

When dynamic currency conversion is performed by FedEx, this specifies the exchange rate used to convert the currency from AccountFromCurrency to AccountIntoCurrency. This is applicable to account based (discounted) rates.

AccountFromCurrency[i]: The currency from which the value was converted.

When dynamic currency conversion is performed by FedEx, this specifies the currency from which the value was converted. This is applicable to account based (discounted) rates.

AccountIntoCurrency[i]: The currency to which the value was converted.

When dynamic currency conversion is performed by FedEx, this specifies the currency to which the value was converted. This is applicable to account based (discounted) rates.

CODReferenceIndicator: The reference information to be added to the COD return label.

The reference information to be added to the COD return label.

Possible values are:


0	None (default)
1	INVOICE
2	PO
3	REFERENCE
4	TRACKING

CurrencyCode: The currency code associated with the monetary values present in the request.

This optional field identifies the preferred currency of the requestor.

CustomerTransactionId: Customer transaction id.

This element allows you to assign a unique identifier to your transaction. This element is returned in the reply and helps you match requests to replies. Maximum of 40 characters.

DryIceCount: The number of packages which contain dry ice.

This specifies the number of packages in the shipment which contain dry ice. This is used in conjunction with PackageDryIceWeight when DryIce is present (requested) in the ShipmentSpecialServices.

EstimateDelivery: Determines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.

If True (default), the component will attempt to estimate Transit Time, Delivery Date, and/or Delivery Day based on what information came back in the response. This does not account for non-business days, holidays, or weekend delivery and should be treated accordingly.

If False, the component will not estimate Transit Time, Delivery Date, and/or Delivery Day. Instead it will ONLY use the values returned in the response from FedEx. If a property is empty, it means that FedEx did not return this information.

ListExchangeRate[i]: The exchange rate use when converting currency.

When dynamic currency conversion is performed by FedEx, this specifies the exchange rate used to convert the currency from ListFromCurrency to ListIntoCurrency. This is applicable to list rates.

ListFromCurrency[i]: The currency from which the value was converted.

When dynamic currency conversion is performed by FedEx, this specifies the currency from which the value was converted. This is applicable to list rates.

ListIntoCurrency[i]: The currency to which the value was converted.

When dynamic currency conversion is performed by FedEx, this specifies the currency to which the value was converted. This is applicable to list rates.

PackageDryIceWeight[i]: The weight of the dry ice for each package.

This is required to be provided in a ship request when shipping Dry Ice (i.e., when the corresponding flag for DryIce is present (requested) in the ShipmentSpecialServices). Dry ice shipping is allowed for FedEx Express services only (U.S. domestic, intra-Canadian, and FedEx Express International shipments). FedEx assesses a surcharge on each package containing dry ice. Dry ice weight cannot be greater than the package weight. The dry ice weight type is KGS only. There is a limit of 2.5 KG dry ice for destination.

NOTE: The weight will always be specified in KG.

PackageFreightCommodityIds[i]: The Freight Commodity Line Item IDs associated with this package.

For FedEx Freight Shipments, set this config to specify the Freight Commodity Line Item IDs associated with this package. This setting accepts multiple, comma separated IDs. For example: component.Commodities[0].Id = "Item1"; ... component.Commodities[1].Id = "Item2"; component.Config("PackageFreightCommodityIds[0]=Item1,Item2");

Note: This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

PackagePhysicalPackagingType[i]: Additional details about the physical packaging of the item in a FedEx Freight shipment.

Set this config to specify additional details about how the item has been physically packaged for a FedEx Freight shipment.

The applicable values include the following:


0 (default)	Not Set
1	BAG
2	BARREL
3	BASKET
4	BOX
5	BUCKET
6	BUNDLE
7	CAGE
8	CARTON
9	CASE
10	CHEST
11	CONTAINER
12	CRATE
13	CYLINDER
14	DRUM
15	ENVELOPE
16	HAMPER
17	OTHER
18	PACKAGE
19	PAIL
20	PALLET
21	PARCEL
22	PIECE
23	REEL
24	ROLL
25	SACK
26	SHRINKWRAPPED
27	SKID
28	TANK
29	TOTEBIN
30	TUBE
31	UNIT

RawRequest: Contains the complete request sent to the Server.

This returns the complete request as sent to the server. Used for debugging purposes.

RawResponse: Contains the complete response returned by the Server.

This returns the complete response as received from the server. Used for debugging purposes.

SizeUnit: The dimension unit.

Declares the type of size units to be used in calculating the size of the shipment and each package contained in it. This is required if package dimensions are passed in the request.

Valid dimension unit of measure codes: IN and CM. Defaults to IN if a value is not passed in the transaction.

SmartPostAncillaryEndorsement: The endorsement type used for a FedEx SmartPost shipment.

Set this config to specify the endorsement type used for a FedEx SmartPost shipment. This is optional when using FedEx SmartPost service.

The applicable values include the following:


0	None (default setting)
1	Address Correction
2	Carrier Leave If No Response
3	Change Service
4	Forwarding Service
5	Return Service

SmartPostCustomerManifestId: The Customer Manifest Id used to group FedEx SmartPost packages.

Set this config to specify the Customer Manifest Id which is used to group FedEx SmartPost packages onto a manifest for each trailer that is being prepared. You must assign a unique Manifest Id to each FedEx SmartPost package, when you have multiple trailers. If you have a single trailer, then this config is optional. The Manifest Id must be unique to your account number for a minimum of six months and cannot exceed eight characters in length.

SmartPostHubId: The HubId used to send FedEx SmartPost shipments.

When you want to ship packages via FedEx SmartPost, you will have to specify the SmartPostHubId. By setting this, the server will consider your shipment as a SmartPost one. ServiceType will automatically be set to the correct value when this is specified.

SmartPost cannot be enabled via Web Support. You will need to contact your local Account Executive to enable SmartPost for your account. Depending on the zip code associated with your account, they can also provide you with the correct Hub Id for production. This config should only be set using the numeric Hub Id value. For example, to set the Hub Id for Charlotte area: ship.Config("SmartPostHubId=5281"). In regards to test, you should be able to test your transactions by supplying a dummy Hub Id of 5531.

Note: SmartPost ships via FedEx using FedEx Ground. The only available packaging type for Ground is 'Your Packaging', so SmartPost can only use this as packaging type, and the package dimensions are required to be entered in the request as well. The package weight limitations depend on the value of SmartPostIndicia which is also required to be provided in the request.

SmartPostIndicia: The Indicia type used for a FedEx SmartPost shipment.

Set this config to specify the Indicia type used for a FedEx SmartPost shipment. This is required when using FedEx SmartPost service.

The applicable values include the following:


0	Media Mail (default setting) - to be used for Books, DVDs, CDs, videotapes, weight: 1 lb to 70 lbs
1	Parcel Select - to be used for general packages greater than 1 lb, weight: 1 lb to 70 lbs
2	Presorted Bound Printed Matter - to be used for Catalogs, phone books or anything permanently bound, weight: 0.1 lb to 15 lbs
3	Presorted Standard - to be used for general packages up to 1 lb
4	Parcel Return

TESTMODE: This configuration setting will allow you to run test transactions.

When setting this configuration setting to True the transactions will be directed to the default testing end-point. component.Config("TESTMODE=true");

Default value is False, transactions are directed to the default production end-point.

Warning: Warning message returned by the server.

This might be returned by the server even upon successful response. These warnings are usually informational.

WeightUnit: Weight unit.

This is required when submitting a rate or ship request. It declares the type of weight unit to be used in calculating the weight of the shipment and each package contained in it.

Valid weight types: LB and KG. Defaults to LB if a value is not passed in the transaction. It must be LB for a U.S. Domestic rate quote or ship request.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the component adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.

When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the component.

If set to True, the URL passed to the component will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the component will perform a GET on the new location.

The default value is False. If set to True, the component will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the component.

This property specifies the HTTP version used by the component. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxHeaders: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the component beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the component.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the component whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

The appropriate values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the component binds.

This must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

CACertFilePaths: The paths to CA certificate files when using Mono on Unix/Linux.

This setting specifies the paths on disk to CA certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the component will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the component is the same.

SSLCACerts: A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the component will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default) the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the OCSP URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default) the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internal:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30) [Platform Only]
SSL2	12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

The platform provider is only available on Windows 11 / Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the component will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion: Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the component throws an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (FedExFreightRates Component)

FedExFreightRates Errors


	301 Operation interrupted (or timeout).
	432 Invalid index.
	527 Server Error Response.
	528 Property set with invalid data.

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