FedExFreightRates Class
Properties Methods Events Config Settings Errors
Provides access to pre-ship rate information for a freight shipment per your established FedEx account rates.
Syntax
dshippingsdk.Fedexfreightrates
Remarks
When providing origin, destination information, weight, and service, this class 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 class 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 Class, 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 class, you must have a FedEx AccountNumber. You should also have already obtained a DeveloperKey, Password and a MeterNumber uniquely assigned to your account by FedEx after registration for Web Services.
Property List
The following is the full list of the properties of the class 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. |
DropoffType | Identifies the method by which the package is to be tendered to FedEx. |
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. |
Proxy | This property includes 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 class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | A timeout for the class. |
TotalWeight | The total weight of all the pieces in this shipment. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
GetRates | Returns rate information for a specified or all available FedEx services. |
Reset | Resets the internal state of the class and all properties to their default values. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
Notification | Notification returned by the server upon successful request (if applicable). |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class 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. |
CSPProductId | Identifies the CSP product. |
CSPProductVersion | Identifies the CSP product version. |
CSPUserKey | CSP end user key. |
CSPUserPassword | CSP end user password. |
CurrencyCode | The currency code associated with the monetary values present in the request. |
CustomContent | Defines any custom content to print on the label. |
CustomerTransactionId | Customer transaction id. |
DryIceCount | The number of packages which contain dry ice. |
EstimateDelivery | Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day. |
HasXPath | Determines whether a specific element exists in the document. |
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. |
UseSOAP | Determines if the FedEx SOAP web services are used instead of the FedEx XML web services. |
Warning | Warning message returned by the server. |
WeightUnit | Weight unit. |
XAttrCount | The number of records in the XAttr arrays. |
XAttrName[i] | The name of the indexed attribute. |
XAttrValue[i] | The value of the indexed attribute. |
XChildCount | The number of records in the XChild arrays. |
XChildElement[i] | The name of the indexed child element. |
XChildText[i] | The text of the indexed child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Used to set the XPath within the response from the server. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
CODTotalAmount Property (FedExFreightRates Class)
The total amount to be collected on delivery.
Syntax
public String getCODTotalAmount(); public void setCODTotalAmount(String CODTotalAmount);
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 Class)
COD type.
Syntax
public int getCODType(); public void setCODType(int CODType); Enumerated values: public final static int codtAny = 0; public final static int codtCash = 1; public final static int codtGuaranteedFunds = 2; public final static int codtCompanyCheck = 3; public final static int codtPersonalCheck = 4;
Default Value
0
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 Class)
Collection of commodity line items in the fright shipment.
Syntax
public FreightCommodityDetailList getCommodities(); public void setCommodities(FreightCommodityDetailList commodities);
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.
DropoffType Property (FedExFreightRates Class)
Identifies the method by which the package is to be tendered to FedEx.
Syntax
public int getDropoffType(); public void setDropoffType(int dropoffType); Enumerated values: public final static int dtRegularPickup = 0; public final static int dtRequestCourier = 1; public final static int dtDropBox = 2; public final static int dtBusinessServiceCenter = 3; public final static int dtStation = 4;
Default Value
0
Remarks
This type of dropoff is required in a rate request. A charge applies when you request a pickup (i.e., when DropoffType is set to 1 (dtRequestCourier)). This charge does not apply if you drop off your package at a FedEx shipping location or if you have regular scheduled pickups.
Possible values are:
dtRegularPickup (0) | |
dtRequestCourier (1) | |
dtDropBox (2) | |
dtBusinessServiceCenter (3) | |
dtStation (4) |
This property does not dispatch a courier.
FedExAccount Property (FedExFreightRates Class)
Login information for FedEx.
Syntax
public FedExAccount getFedExAccount(); public void setFedExAccount(FedExAccount fedExAccount);
Remarks
This property must be set when connecting to FedEx server. It contains server and login information.
Firewall Property (FedExFreightRates Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.
FreightGuarantee Property (FedExFreightRates Class)
Identifies the freight guarantee details.
Syntax
public FreightGuaranteeDetail getFreightGuarantee(); public void setFreightGuarantee(FreightGuaranteeDetail freightGuarantee);
Remarks
This specifies the type and date of guarantee provided for the freight shipment.
InsuredValue Property (FedExFreightRates Class)
The total amount of insurance requested for the shipment being rated.
Syntax
public String getInsuredValue(); public void setInsuredValue(String insuredValue);
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 Class)
A collection of packages contained in the shipment.
Syntax
public PackageDetailList getPackages(); public void setPackages(PackageDetailList packages);
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.
Payor Property (FedExFreightRates Class)
Identifies the payor of transportation charges for the requested shipment.
Syntax
public PayorDetail getPayor(); public void setPayor(PayorDetail payor);
Remarks
The Payor is required to be provided in a ship request. This must be set to an instance of the PayorDetail type, which will contain the payor details. See the PayorDetail type for more information.
Note that the only valid value for PayorType is ptSender.
Proxy Property (FedExFreightRates Class)
This property includes a set of properties related to proxy access.
Syntax
public Proxy getProxy(); public void setProxy(Proxy proxy);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
RateType Property (FedExFreightRates Class)
Indicates the type of rates to be returned.
Syntax
public int getRateType(); public void setRateType(int rateType); Enumerated values: public final static int rtList = 0; public final static int rtAccount = 1;
Default Value
0
Remarks
Possible values are as follows:
rtList (0) | |
rtAccount (1) |
If you request list rates, you must set the RateType to 0 (rtList) and you will receive both the discount and list rate quote in the reply. List rates are available for Express and Ground U.S. shipments.
If you request the discount rate, you must set the RateType to 1 (rtAccount), and the class will return only discount rates that are applicable to your FedEx account. Discount rates are available for all services and origin/destination pairs.
RecipientAddress Property (FedExFreightRates Class)
Identifies the recipient's address.
Syntax
public AddressDetail getRecipientAddress(); public void setRecipientAddress(AddressDetail recipientAddress);
Remarks
The RecipientAddress is required to be provided in a 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.
RequestedService Property (FedExFreightRates Class)
Service type for which the shipping rate is requested.
Syntax
public int getRequestedService(); public void setRequestedService(int requestedService); Enumerated values: public final static int stUnspecified = 0; public final static int stFedExPriorityOvernight = 10; public final static int stFedExStandardOvernight = 11; public final static int stFedExFirstOvernight = 12; public final static int stFedEx2Day = 13; public final static int stFedExExpressSaver = 14; public final static int stFedExGround = 15; public final static int stFedExGroundHomeDelivery = 16; public final static int stFedEx1DayFreight = 17; public final static int stFedEx2DayFreight = 18; public final static int stFedEx3DayFreight = 19; public final static int stFedExInternationalPriority = 20; public final static int stFedExInternationalEconomy = 21; public final static int stFedExInternationalFirst = 22; public final static int stFedExInternationalPriorityFreight = 23; public final static int stFedExInternationalEconomyFreight = 24; public final static int stFedExEuropeFirstInternationalPriority = 25; public final static int stFedExSmartPost = 26; public final static int stFedEx2DayAM = 27; public final static int stFedExFirstFreight = 28; public final static int stFedExInternationalGround = 29; public final static int stFedExFreightEconomy = 30; public final static int stFedExFreightPriority = 31; public final static int stFedExInternationalPriorityExpress = 32; public final static int stFedExInternationalConnectPlus = 33; public final static int stUPSFirstClass = 35; public final static int stUPSPriorityMail = 36; public final static int stUPSExpeditedMailInnovations = 37; public final static int stUPSPriorityMailInnovations = 38; public final static int stUPSEconomyMailInnovations = 39; public final static int stUPSNextDayAir = 40; public final static int stUPSExpress = 41; public final static int stUPS2ndDayAir = 42; public final static int stUPSGround = 43; public final static int stUPSWorldwideExpress = 44; public final static int stUPSWorldwideExpedited = 45; public final static int stUPSExpedited = 46; public final static int stUPSStandard = 47; public final static int stUPS3DaySelect = 48; public final static int stUPSNextDayAirSaver = 49; public final static int stUPSSaver = 50; public final static int stUPSNextDayAirEarlyAM = 51; public final static int stUPSExpressEarlyAM = 52; public final static int stUPSWorldwideExpressPlus = 53; public final static int stUPSExpressPlus = 54; public final static int stUPS2ndDayAirAM = 55; public final static int stUPSTodayStandard = 56; public final static int stUPSTodayCourrier = 57; public final static int stUPSTodayInterCity = 58; public final static int stUPSTodayExpress = 59; public final static int stUPSTodayExpressSaver = 60; public final static int stUPSWorldwideExpressFreight = 61; public final static int stUPSSurePostLessThan1LB = 62; public final static int stUPSSurePost1LBOrGreater = 63; public final static int stUPSSurePostBPM = 64; public final static int stUPSSurePostMedia = 65; public final static int stUSPSExpress = 70; public final static int stUSPSFirstClass = 71; public final static int stUSPSPriority = 72; public final static int stUSPSParcelPost = 73; public final static int stUSPSBPM = 74; public final static int stUSPSMedia = 75; public final static int stUSPSLibrary = 76; public final static int stUSPSOnline = 77; public final static int stUSPSGlobalExpress = 78; public final static int stUSPSParcelSelect = 79; public final static int stUSPSCriticalMail = 80; public final static int stUSPSStandardMail = 81; public final static int stUSPSExpressMailInternational = 82; public final static int stUSPSFirstClassMailInternational = 83; public final static int stUSPSPriorityMailInternational = 84; public final static int stUSPSPriorityExpress = 85; public final static int stUSPSRetailGround = 86; public final static int stUSPSFirstClassPackageInternationalService = 87; public final static int stUSPSPriorityMailExpressInternational = 88; public final static int stCanadaRegularParcel = 90; public final static int stCanadaExpeditedParcel = 91; public final static int stCanadaXpresspost = 92; public final static int stCanadaLibrary = 93; public final static int stCanadaPriority = 94; public final static int stCanadaPriorityEnvelopeUSA = 95; public final static int stCanadaPriorityPakUSA = 96; public final static int stCanadaPriorityParcelUSA = 97; public final static int stCanadaXpresspostUSA = 98; public final static int stCanadaExpeditedParcelUSA = 99; public final static int stCanadaSmallPacketAirUSA = 100; public final static int stCanadaTrackedPacketUSA = 101; public final static int stCanadaTrackedPacketLVMUSA = 102; public final static int stCanadaPriorityEnvelopeInternational = 103; public final static int stCanadaPriorityPakInternational = 104; public final static int stCanadaPriorityParcelInternational = 105; public final static int stCanadaXpresspostInternational = 106; public final static int stCanadaSmallPacketAirInternational = 107; public final static int stCanadaSmallPacketLandInternational = 108; public final static int stCanadaParcelAirInternational = 109; public final static int stCanadaParcelLandInternational = 110; public final static int stCanadaTrackedPacketInternational = 111; public final static int stFedExDistanceDeferred = 120; public final static int stFedExNextDayAfternoon = 121; public final static int stFedExNextDayEarlyMorning = 122; public final static int stFedExNextDayEndOfDay = 123; public final static int stFedExNextDayFreight = 124; public final static int stFedExNextDayMidMorning = 125; public final static int stFedExSameDay = 126; public final static int stFedExSameDayCity = 127; public final static int stFedExSameDayMetroAfternoon = 128; public final static int stFedExSameDayMetroMorning = 129; public final static int stFedExSameDayMetroRush = 130; public final static int stUPSWorldwideEconomyDDU = 131; public final static int stUPSWorldwideEconomyDDP = 132; public final static int stUSPSParcelSelectGround = 133; public final static int stUSPSPriorityMailCubic = 134;
Default Value
0
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 Class)
Identifies the sender's address.
Syntax
public AddressDetail getSenderAddress(); public void setSenderAddress(AddressDetail senderAddress);
Remarks
The SenderAddress is required to be provided in a 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.
Services Property (FedExFreightRates Class)
Collection of available services returned for the shipment being rated.
Syntax
public ServiceDetailList getServices();
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: class.Services[0].ServiceTypeDescription = "FEDEX_2DAY".
This property is read-only.
ShipDate Property (FedExFreightRates Class)
The date on which the package will be shipped.
Syntax
public String getShipDate(); public void setShipDate(String shipDate);
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.
If future day shipping is requested (i.e., the corresponding flag of Future Day is present in the ShipmentSpecialServices): for Express shipping this value must be less than or equal to 10 days in the future; for Express freight, this must be less than or equal to 5 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 Class)
The shipment info for the freight shipment.
Syntax
public FreightShipmentDetail getShipmentInfo(); public void setShipmentInfo(FreightShipmentDetail shipmentInfo);
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
ShipmentSpecialServices Property (FedExFreightRates Class)
Contains the collection of special services offered by FedEx.
Syntax
public long getShipmentSpecialServices(); public void setShipmentSpecialServices(long shipmentSpecialServices);
Default Value
0
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 | Email Notification |
0x00000800L | Extreme Length |
0x00001000L | Food |
0x00002000L | Freight Guarantee |
0x00004000L | Future Day |
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)
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.
- Email Notification: Indicates that email 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.
- Future Day: Indicates that future day shipping is requested. This might affect the service availability. When this is requested, for Express freight, the ShipDate must be less than or equal to 5 days in the future. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx International Economy Freight, and FedEx International Priority Freight.
- 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 Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
SSLCert Property (FedExFreightRates Class)
The certificate to be used during SSL negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
SSLProvider Property (FedExFreightRates Class)
This specifies the SSL/TLS implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
SSLServerCert Property (FedExFreightRates Class)
The server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Timeout Property (FedExFreightRates Class)
A timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class throws an exception.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
TotalWeight Property (FedExFreightRates Class)
The total weight of all the pieces in this shipment.
Syntax
public String getTotalWeight(); public void setTotalWeight(String totalWeight);
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 Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
GetRates Method (Fedexfreightrates Class)
Returns rate information for a specified or all available FedEx services.
Syntax
public void 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):
- Server (required)
- DeveloperKey (required)
- Password (required)
- AccountNumber (required)
- MeterNumber (required)
- RateType (required)
- ShipDate (optional)
- PackagingType (required)
- DropoffType (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.
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 Class)
Resets the internal state of the class and all properties to their default values.
Syntax
public void reset();
Remarks
The Reset method does not have any parameters and does not return any value.
Error Event (Fedexfreightrates Class)
Information about errors during data delivery.
Syntax
public class DefaultFedexfreightratesEventListener implements FedexfreightratesEventListener { ... public void error(FedexfreightratesErrorEvent e) {} ... } public class FedexfreightratesErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Notification Event (Fedexfreightrates Class)
Notification returned by the server upon successful request (if applicable).
Syntax
public class DefaultFedexfreightratesEventListener implements FedexfreightratesEventListener { ... public void notification(FedexfreightratesNotificationEvent e) {} ... } public class FedexfreightratesNotificationEvent { public String message; }
Remarks
When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.
Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.
SSLServerAuthentication Event (Fedexfreightrates Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultFedexfreightratesEventListener implements FedexfreightratesEventListener { ... public void SSLServerAuthentication(FedexfreightratesSSLServerAuthenticationEvent e) {} ... } public class FedexfreightratesSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; }
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Fedexfreightrates Class)
Shows the progress of the secure connection.
Syntax
public class DefaultFedexfreightratesEventListener implements FedexfreightratesEventListener { ... public void SSLStatus(FedexfreightratesSSLStatusEvent e) {} ... } public class FedexfreightratesSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
AddressDetail Type
Represents the address details of a sender or recipient.
Remarks
This type contains descriptive data of physical location of a sender or recipient.
Example: Setting the fields of a sender
SenderAddress addr = new SenderAddress
addr.Address1 = "100 Somewhere St."
addr.Address2 = "Ste 100"
addr.City = "Raleigh"
addr.State = "NC"
addr.ZipCode = "27154"
addr.CountryCode = "US"
The fields contained by this type are listed below.
Fields
Address1 String |
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 |
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 |
Various flags that denote information about the address.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
City String |
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CountryCode String |
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.
* Not supported by USPS ** Has multiple values, the values used for USPS are below
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
State String |
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 |
Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and State are not present. Valid characters: A-Z; 0-9; a-z. Maximum length: 16. |
Constructors
public AddressDetail();
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate String |
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 |
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[] |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExpirationDate String |
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 |
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). |
||||||||||||||||||||||||||||||||||||||||||||||||
Fingerprint String |
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 |
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 |
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 |
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
KeyPassword String |
This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys. Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKey String |
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyAvailable boolean |
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 |
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKey String |
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyAlgorithm String |
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 |
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. |
||||||||||||||||||||||||||||||||||||||||||||||||
SerialNumber String |
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 |
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 |
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 are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreB byte[] |
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 are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType int |
This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
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 displayed below.
If a field value contains a comma it must be quoted. |
||||||||||||||||||||||||||||||||||||||||||||||||
SubjectAltNames String |
This field contains comma-separated lists of alternative subject names for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintMD5 String |
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 |
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 |
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 |
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:
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. |
||||||||||||||||||||||||||||||||||||||||||||||||
UsageFlags int |
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
Please see the Usage field for a text representation of UsageFlags. This functionality currently is not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||
Version String |
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3". |
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate( certificateData);
Parses CertificateData as an X509 public key.
public Certificate( certStoreType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate( certStoreType, storeBlob, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 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.DeveloperKey = "my_developer_key"
account.MeterNumber = "1234567"
account.Password = "my_password"
account.Server = "https://test.fedex.com"
The fields contained by this type are listed below.
Fields
AccountNumber String |
Account number for logging in to the FedEx Server. An AccountNumber and MeterNumber will be required with each input request a user makes to a FedEx server. 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. For all transaction whether they are Ground or Express service, you will need to pass your valid 9 digit FedEx account number. |
CSPProductId String |
Identifies the CSP product. This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: AccountNumber, MeterNumber, DeveloperKey, Password, CSPUserKey, CSPUserPassword and CSPProductVersion. |
CSPProductVersion String |
Identifies the CSP product version. This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: AccountNumber, MeterNumber, DeveloperKey, Password, CSPUserKey, CSPUserPassword and CSPProductId. |
CSPUserKey String |
CSP end user key. This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user. This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (DeveloperKey and Password respectively). |
CSPUserPassword String |
CSP end user password. This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user. This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (DeveloperKey and Password respectively). |
DeveloperKey String |
Identifying part of the authentication key used for the sender's identity. The DeveloperKey is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Developer Key is provided to you by FedEx after registration and it is the publicly known part of authentication credential. The Developer Key may also be referred to as an Authentication Key. The DeveloperKey, AccountNumber, MeterNumber, and Password will be required with each input request a user makes to a FedEx server. This 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. |
LanguageCode String |
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 |
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. |
MeterNumber String |
Meter number to use for submitting requests to the FedEx Server. An AccountNumber and MeterNumber will be required with each input request a user makes to a FedEx server. The Meter Number is provided to you by FedEx when you register for service. This 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. |
Password String |
Secret part of authentication key used for the sender's identity. The Password is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Password is provided to you by FedEx after registration and it is the private part of authentication credential, known only to the user and FedEx. The DeveloperKey, AccountNumber, MeterNumber, and Password will be required with each input request a user makes to a FedEx server. This 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. |
Server String |
URL for the FedEx Server where the requests are sent. This is required to be provided on each transaction request sent to FedEx along with AccountNumber and MeterNumber. The full URL (including the URL scheme normally https://) should be supplied. All test requests are sent over SSL. The server URL for the production will be provided to you by FedEx after your application has been approved/certified by FedEx Web Integration Solutions team. Note that FedEx provides both SOAP and XML services and the URLs for each service are slightly different, however the
functionality provided is exactly the same. If the URL ends with "/web-services", then the server will use the SOAP
services. If the URL ends with "/xml", then the server will use the XML service. When using the SOAP services, the
UseSOAP config should be set to true (default). The test URLs for FedEx are as follows:
|
Constructors
public FedExAccount();
Firewall Type
This is the firewall the class 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 boolean |
This field tells the class whether or not to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). |
||||||||||
FirewallType int |
This field determines the type of firewall to connect through. The applicable values are as follows:
|
||||||||||
Host String |
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 class throws an exception. |
||||||||||
Password String |
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 class throws an exception. |
||||||||||
Port int |
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 |
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 class throws an exception. |
Constructors
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 |
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightClass int |
Indicates the freight class of the commodity. The following table lists freight classes available from FedEx freight services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightPackagingType int |
Identifies the Commodity item's packaging type. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HandlingUnits int |
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 |
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 |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Height int |
The height of the commodity. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Id String |
A unique identifier assigned to this line item. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Length int |
The width of the commodity. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Manufacturer String |
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. XX may be used to indicate multiple countries of manufacturer. 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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NmfcCode String |
NMFC Code for commodity. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NumberOfPieces int |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PONumber String |
The PO Number for printed reference per commodity. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Quantity int |
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 |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UnitPrice String |
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 |
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 |
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 |
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 |
The width of the commodity. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
Constructors
public FreightCommodityDetail();
public FreightCommodityDetail( description, freightClass, freightPackagingType, handlingUnits, harmonizedCode, manufacturer, numberOfPieces, quantity, quantityUnit, unitPrice, weight, length, width, height, volume);
public FreightCommodityDetail( description, freightClass, freightPackagingType, handlingUnits, weight, length, width, height, volume);
public FreightCommodityDetail( description, harmonizedCode, manufacturer, numberOfPieces, quantity, quantityUnit, unitPrice, weight);
public FreightCommodityDetail( description, harmonizedCode, manufacturer, quantity, quantityUnit, unitPrice, weight);
public FreightCommodityDetail( description, harmonizedCode, manufacturer, quantity, quantityUnit, unitPrice);
public FreightCommodityDetail( description, manufacturer, weight);
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 |
The date the freight shipment is guaranteed for. The valid format for the date is YYYY-MM-DD |
||||||
Type int |
Specifies what type of freight guarantee is requested. The valid values are:
|
Constructors
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 |
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 |
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 |
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 |
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 |
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 |
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. |
||||||
AlternateBillingState String |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
The estimated client discount rate for a freight shipment. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
CollectTermsType int |
This sets the terms for how to collect payment for this freight shipment. Default value is 0. Valid values are as follows:
This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
Comments String |
The description for this freight shipment. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
Coupons String |
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 |
The total declared value per unit for this freight shipment. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
DeclaredValueUnits String |
Identifies the declared value units corresponding to the above defined declared value. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
EmergencyContactPhone String |
The phone number for the emergency contact. This is required if any of the Commodities line items contain hazardous materials. |
||||||
HazardousMaterialsOfferor String |
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 |
This should be set to the total value of the liability coverage. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
LiabilityCoverageType int |
This should be set to the type of liability coverage offered. Valid values are as follows:
This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
PalletWeight String |
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 int |
This indicates the role of the party is submitting the transaction for this freight shipment. Valid values are as follows:
This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
TotalHandlingUnits int |
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 |
This should be set to the total height of the shipment. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
TotalLength int |
This should be set to the total length of the shipment. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||
TotalWidth int |
This should be set to the total width of the shipment. This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
Constructors
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 |
Base charge applicable to this package. For FedEx, this is 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 |
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 |
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 |
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[] |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODType int |
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:
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 boolean |
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:
Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DangerousGoodsOptions int |
Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:
Note: This is only valid when using FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description String |
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 |
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 |
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. 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. 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 |
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 |
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 |
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. 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. 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 |
Net charge applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs 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 int |
The packaging type of the package being rated and/or shipped. Possible values are:
If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0), except for with FedEx, in which case it will default to ptLetter (2). 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:
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 |
Rating aggregate applicable to this package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference String |
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:
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:
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 |
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[] |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceiptFile String |
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 |
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[] |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelFile String |
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 |
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[] |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SignatureType int |
Specifies one of the Delivery Signature Options requested for this package. Possible values are:
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:
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 int |
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:
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 |
Contains the collection of special services offered on the package level. Valid values are:
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:
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:
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 |
Total discount applicable to this package. This is specific to the FedEx AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalSurcharges String |
Total surcharges applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. 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, 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 |
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 |
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 |
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: 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. 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. 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
public PackageDetail();
public PackageDetail( packagingType, weight);
public PackageDetail( length, width, height);
public PackageDetail( packagingType, length, width, height);
public PackageDetail( packagingType, weight, length, width, height);
public PackageDetail( packagingType, weight, length, width, height, specialServices, insuredValue, CODAmount, CODType, signatureType);
public PackageDetail( weight, length, width, height, specialServices, insuredValue, CODAmount, dangerousGoodsAccessible, signatureType);
public PackageDetail( weight, length, width, height, description, reference, specialServices, insuredValue, CODAmount, dangerousGoodsAccessible, signatureType, shippingLabelFile, CODFile);
public PackageDetail( packagingType, weight, length, width, height, description, reference, specialServices, insuredValue, CODAmount, CODType, signatureType, shippingLabelFile, returnReceiptFile);
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 |
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 |
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 |
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 |
Name of city, town, etc. |
||||||||||
CountryCode String |
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 |
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 int |
Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:
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 |
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 |
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
public PayorDetail();
public PayorDetail( payorType, accountNumber, countryCode);
Proxy Type
This is the proxy the class 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 int |
This field is used to tell the class 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 class. Look at the configuration file for the class 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 boolean |
This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false. Note: This setting is applicable only in Windows. |
||||||||
Password String |
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 |
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 |
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 int |
This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
|
||||||||
User String |
This field contains a user name, 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. |
Constructors
public Proxy();
public Proxy( server, port);
public Proxy( server, port, user, password);
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 |
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 |
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. Eligibility is determined using the combination of the UserId and AccountNumber. 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 class. 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 |
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 |
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 |
Aggregate of details and rates for the ServiceType in the list of available services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BusinessDays int |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InsuranceCost String |
Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ListBaseCharge String |
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 |
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 |
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 |
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 |
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 |
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 |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RateScale String |
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 |
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 |
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 int |
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:
Valid values for UPS are:
Valid values for USPS are:
Please note that the RequestedService stUSPSBoundPrintedMatter (74) is no longer supported by USPS or Endicia. Valid values for Canada Post are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ServiceTypeDescription String |
Indicates the textual description of a service type in the list of available services returned. Possible returned values for FedEx are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipDate String |
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 |
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 |
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransitTime String |
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. Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN. |
Config Settings (Fedexfreightrates Class)
The class 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 class, 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:
|
||||||||||||||||||||||||||||||||||||||||||||||
CSPProductId: Identifies the CSP product.This is applicable to CSP developers only. This is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the AccountNumber, MeterNumber and CSPProductVersion. | ||||||||||||||||||||||||||||||||||||||||||||||
CSPProductVersion: Identifies the CSP product version.This is applicable to CSP developers only. This is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the AccountNumber, MeterNumber and CSPProductId. | ||||||||||||||||||||||||||||||||||||||||||||||
CSPUserKey:
CSP end user key.This is applicable to CSP developers only.
When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user.
This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (DeveloperKey and Password respectively). |
||||||||||||||||||||||||||||||||||||||||||||||
CSPUserPassword:
CSP end user password.This is applicable to CSP developers only.
When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user.
This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (DeveloperKey and Password respectively). |
||||||||||||||||||||||||||||||||||||||||||||||
CurrencyCode: The currency code associated with the monetary values present in the request.This optional field identifies the preferred currency of the requestor. | ||||||||||||||||||||||||||||||||||||||||||||||
CustomContent:
Defines any custom content to print on the label.FedEx allows you to add customizable content on select label types. FedEx requires that the customizable
graphic or text must not exceed 1-1/2 inches high and 4-1/2 inches wide. You must insert the XML necessary
to display your graphic or text. For example if you wanted to add some custom text to the label you would
do something like this:
string customContent = "CustomContent=<CustomContent><TextEntries><Position><X>150</X><Y>70</Y></Position><Format>My text here</Format><ThermalFontId>2</ThermalFontId></TextEntries></CustomContent>" When using the CustomContent, the LabelStockType must be either 4 (Stock 4x8) or 5 (Stock 4x9 Leading Doc Tab). Also LabelFormatType must be 0 (Common2D) and LabelImageType must 2 (fitEltron), 3 (fitZebra) or 4 (fitUniMark). |
||||||||||||||||||||||||||||||||||||||||||||||
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 class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.If True (default), the class 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 class 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. |
||||||||||||||||||||||||||||||||||||||||||||||
HasXPath: Determines whether a specific element exists in the document.This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath. This method returns True if the XPath exists, False if not. | ||||||||||||||||||||||||||||||||||||||||||||||
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:
class.Commodities[0].Id = "Item1";
...
class.Commodities[1].Id = "Item2";
class.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:
Note: This only applies when using the FedExFreightEconomy and FedExFreightPriority services. |
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
UseSOAP:
Determines if the FedEx SOAP web services are used instead of the FedEx XML web services.If True (default), the class will use the FedEx SOAP based web services.
When using the SOAP based web services the Server should end in "web-services".
For instance: "https://gatewaybeta.fedex.com:443/web-services".
If False, the class will use the FedEx XML based web services. When using the XML based web services the Server should end in "xml". For instance: "https://gatewaybeta.fedex.com:443/xml". |
||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||
XAttrCount: The number of records in the XAttr arrays.This property controls the size of the following arrays: | ||||||||||||||||||||||||||||||||||||||||||||||
XAttrName[i]: The name of the indexed attribute.The size of the array is controlled by XAttrCount. | ||||||||||||||||||||||||||||||||||||||||||||||
XAttrValue[i]: The value of the indexed attribute.The size of the array is controlled by XAttrCount. | ||||||||||||||||||||||||||||||||||||||||||||||
XChildCount: The number of records in the XChild arrays.This property controls the size of the following arrays: | ||||||||||||||||||||||||||||||||||||||||||||||
XChildElement[i]: The name of the indexed child element.The size of the array is controlled by XChildCount. | ||||||||||||||||||||||||||||||||||||||||||||||
XChildText[i]: The text of the indexed child element.The size of the array is controlled by XChildCount. | ||||||||||||||||||||||||||||||||||||||||||||||
XElement: The name of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||
XParent: The parent of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Used to set the XPath within the response from the server.XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the RawResponse. XPath is 1-indexed.
The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.
The following are possible values for an element accessor:
|
||||||||||||||||||||||||||||||||||||||||||||||
XText: The text of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||
HTTP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||
AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is True, the class 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 class 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 class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class 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 class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class 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 class 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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. 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 class.If set to True, the URL passed to the class 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 class 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 class 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 class throws an exception instead. Following are the valid options:
|
||||||||||||||||||||||||||||||||||||||||||||||
GetOn302Redirect: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class 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 class.This property specifies the HTTP version used by the class. Possible values are as follows:
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 NotesWhen 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 class 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 platforms. The class will use the internal security implementation in all cases when connecting.
HTTP/3 NotesHTTP/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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive.
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:
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 class 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 class 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.
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. |
||||||||||||||||||||||||||||||||||||||||||||||
MaxRedirectAttempts: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class 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 class 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 class 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 classs 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 classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||
ProxyPort: Port for the proxy server (default 80).This configuration setting is provided for use by classs 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 classs 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 classs 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. | ||||||||||||||||||||||||||||||||||||||||||||||
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 class.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 class. | ||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||
UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.If UseChunkedEncoding is set to True, the class 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 class 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 class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.
When True (default), the class 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 class will use Timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs 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 classs 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 class 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 class throws an exception.
Note: This setting is provided for use by classs 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 classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs 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 class throws an exception.
Note: This setting is provided for use by classs 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 class 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 class initiate connections (or accept in the case of server classs) only through that interface. If the class 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 class binds.
This must be set before a connection is
attempted. It instructs the class 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 class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class 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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||
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 class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||
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 class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class 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 class throws an exception.
When set to 0 (default) the CRL check will not be performed by the class. 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 class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class 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 class throws an exception.
When set to 0 (default) the class 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. |
||||||||||||||||||||||||||||||||||||||||||||||
SSLContextProtocol: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. | ||||||||||||||||||||||||||||||||||||||||||||||
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 class 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. Note: This value must be set after SSLProvider is set. Example values:
Possible values when SSLProvider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
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:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class 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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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 class 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 class 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 ciphersuite.Returns the ciphersuite 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:
|
||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite 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:
|
||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite 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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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----- |
||||||||||||||||||||||||||||||||||||||||||||||
SSLTrustManagerFactoryAlgorithm: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. | ||||||||||||||||||||||||||||||||||||||||||||||
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 class 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 class throws an exception. The format of this value is a comma separated list of hash-signature combinations. For instance:
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||
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 class 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 class 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:
Tells the class 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 class 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 class 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 class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||
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 classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||
UseDaemonThreads: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (Fedexfreightrates Class)
FedExFreightRates Errors
301 Operation interrupted (or timeout). | |
432 Invalid index. | |
527 Server Error Response. | |
528 Property set with invalid data. |
SOAP Errors
169 Invalid param index (out of range). | |
170 Invalid namespace index (out of range). | |
171 Method not found. Please specify a valid Method. | |
172 No method URI. Please specify a valid MethodURI. | |
173 SOAP Fault. See FaultCode and/or FaultString for details. |
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
303 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |
XML Errors
101 Invalid attribute index. | |
102 No attributes available. | |
103 Invalid namespace index. | |
104 No namespaces available. | |
105 Invalid element index. | |
106 No elements available. | |
107 Attribute does not exist. | |
201 Unbalanced element tag. | |
202 Unknown element prefix (can't find namespace). | |
203 Unknown attribute prefix (can't find namespace). | |
204 Invalid XML markup. | |
205 Invalid end state for parser. | |
206 Document contains unbalanced elements. | |
207 Invalid XPath. | |
208 No such child. | |
209 Top element does not match start of path. | |
210 DOM tree unavailable (set BuildDOM to true and reparse). | |
302 Can't open file. | |
401 Invalid XML would be generated. | |
402 An invalid XML name has been specified. |