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

class 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 get_rates method for a specific FedEx service (when requested_service 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 rate_type 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 fed_ex_account_number. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

Property List


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

cod_total_amountThe total amount to be collected on delivery.
cod_typeCOD type.
commodity_countThe number of records in the Commodity arrays.
commodity_descriptionComplete and accurate description of this commodity line item.
commodity_freight_classIndicates the freight class of the commodity.
commodity_freight_packaging_typeIdentifies the Commodity item's packaging type.
commodity_handling_unitsNumber of individual handling units to which this commodity applies.
commodity_harmonized_codeUnique code representing this commodity line item (for imports only).
commodity_hazardous_materials_optionsIndicates the kind of hazardous material content in this commodity.
commodity_heightThe height of the commodity.
commodity_idA unique identifier assigned to this line item.
commodity_lengthThe width of the commodity.
commodity_manufacturerCountry code where the contents of this commodity line were produced, manufactured or grown in their final form.
commodity_nmfc_codeNMFC Code for commodity.
commodity_number_of_piecesThe total number of packages, cartons, or containers for the commodity line item.
commodity_po_numberThe PO Number for printed reference per commodity.
commodity_quantityNumber of units contained in this commodity line item measured in units specified by the QuantityUnit .
commodity_quantity_unitUnit of measure used to express the Quantity of this commodity line item.
commodity_unit_priceValue of each QuantityUnit in Quantity of this commodity line item.
commodity_valueThe value of an individual item being shipped.
commodity_volumeThis should contain the volume of the freight item.
commodity_weightThe shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.
commodity_widthThe width of the commodity.
fed_ex_account_numberThe account number associated with the shipment.
fed_ex_authorization_tokenAuthorization Token used to authenticate the request.
fed_ex_language_codeTwo-letter code for the language (e.
fed_ex_locale_codeTwo-letter code for the region (e.
fed_ex_serverURL for the FedEx Server where the requests are sent.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
freight_guarantee_dateThe date the freight shipment is guaranteed for.
freight_guarantee_typeSpecifies what type of freight guarantee is requested.
insured_valueThe total amount of insurance requested for the shipment being rated.
package_countThe number of records in the Package arrays.
package_heightThe height of the package to be shipped.
package_insured_valueAmount of insurance requested for this package.
package_lengthThe length of the package to be shipped.
package_typeThe packaging type of the package being rated and/or shipped.
package_signature_typeSpecifies one of the Delivery Signature Options requested for this package.
package_special_servicesContains the collection of special services offered on the package level.
package_weightWeight of this package.
package_widthThe width of the package to be shipped.
payor_account_numberThe account number of the party responsible for payment (shipping charges, or duties and taxes).
payor_address1Street name.
payor_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
payor_cityName of city, town, etc.
payor_country_codeThe country code for the payor of the shipment, or duties and taxes.
payor_nameIdentifies the payor's name.
payor_typeMethod of payment for shipment, or duties and taxes.
payor_stateState or province code.
payor_zip_codePayor's postal code (if applicable).
pickup_typePickup type used for the shipment that rate is requested for.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_userThis property contains a username if authentication is to be used for the proxy.
rate_typeIndicates the type of rates to be returned.
recipient_address1Street name.
recipient_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
recipient_address_flagsVarious flags that denote information about the address.
recipient_cityName of city, town, etc.
recipient_country_codeCountry code.
recipient_stateState or province code.
recipient_zip_codePostal code.
requested_serviceService type for which the shipping rate is requested.
sender_address1Street name.
sender_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
sender_address_flagsVarious flags that denote information about the address.
sender_cityName of city, town, etc.
sender_country_codeCountry code.
sender_stateState or province code.
sender_zip_codePostal code.
service_countThe number of records in the Service arrays.
service_account_base_chargeTransportation charges before surcharges and discounts applied to a ServiceType .
service_account_net_chargeNet charge amount applied to a ServiceType .
service_account_total_discountTotal discount amount applied to the shipment for a ServiceType .
service_account_total_surchargeTotal surcharge amount for all additional services applied to a ServiceType .
service_aggregateAggregate of details and rates for the ServiceType in the list of available services.
service_delivery_dateThis indicates the shipment delivery date for the ServiceType .
service_delivery_dayIndicates the day of the week the shipment can be delivered when using the ServiceType .
service_effective_net_discountIndicates the net discount applied to a ServiceType .
service_list_base_chargeTransportation charges before surcharges and discounts applied to a ServiceType .
service_list_net_chargeNet charge amount applied to a ServiceType .
service_list_total_discountTotal discount amount applied to a ServiceType .
service_list_total_surchargeTotal surcharge amount for all additional services applied to a ServiceType .
service_rate_scaleApplicable rate scale for the ServiceType .
service_rate_zoneApplicable rate zone for the ServiceType .
service_typeIndicates the service type in the list of available services returned.
service_type_descriptionIndicates the textual description of a service type in the list of available services returned.
service_signature_typeIndicates the textual description of the delivery signature services option required by FedEx for the ServiceType .
service_transit_timeExpected number of days in transit from pickup to delivery for the ServiceType .
ship_dateThe date on which the package will be shipped.
shipment_info_account_numberThis is the account number to be used with a freight shipment.
shipment_info_alternate_billing_account_numberThis should be set to the alternate account number to be billed.
shipment_info_alternate_billing_cityThis should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_company_nameThis should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_country_codeThis should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_person_nameThis should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_phoneThis should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_stateThis should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_street_addressThis should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_alternate_billing_zip_codeThis should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber .
shipment_info_billing_address1This should be set to the first address line listed on the account associated with the FreightAccountNumber .
shipment_info_billing_address2This should be set to the second address line listed on the account associated with the FreightAccountNumber .
shipment_info_billing_cityThis should be set to the city listed on the account associated with the FreightAccountNumber .
shipment_info_billing_company_nameThis should be set to the name of the company listed on the account associated with the FreightAccountNumber .
shipment_info_billing_country_codeThis should be set to the country code listed on the account associated with the FreightAccountNumber .
shipment_info_billing_emailThis should be set to the email address listed on the account associated with the FreightAccountNumber .
shipment_info_billing_faxThis should be set to the fax number listed on the account associated with the FreightAccountNumber .
shipment_info_billing_person_nameThis should be set to the name of the person listed on the account associated with the FreightAccountNumber .
shipment_info_billing_phoneThis should be set to the phone number listed on the account associated with the FreightAccountNumber .
shipment_info_billing_stateThis should be set to the state listed on the account associated with the FreightAccountNumber .
shipment_info_billing_zip_codeThis should be set to the zip code listed on the account associated with the FreightAccountNumber .
shipment_info_client_discount_percentThe estimated client discount rate for a freight shipment.
shipment_info_collect_terms_typeThis sets the terms for how to collect payment for this freight shipment.
shipment_info_commentsThe description for this freight shipment.
shipment_info_couponsThis contains a semicolon delimited list of identifiers for promotional discounts offered to customers.
shipment_info_declared_valueThe total declared value per unit for this freight shipment.
shipment_info_declared_value_unitsIdentifies the declared value units corresponding to the above defined declared value.
shipment_info_emergency_contact_phoneThe phone number for the emergency contact.
shipment_info_hazardous_materials_offerorIf this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.
shipment_info_liability_coverage_amountThis should be set to the total value of the liability coverage.
shipment_info_liability_coverage_typeThis should be set to the type of liability coverage offered.
shipment_info_pallet_weightThis should contain the total weight of all pallets used in this freight shipment.
shipment_info_roleThis indicates the role of the party is submitting the transaction for this freight shipment.
shipment_info_total_handling_unitsTotal number of individual handling units in the entire shipment (for unit pricing).
shipment_info_total_heightThis should be set to the total height of the shipment.
shipment_info_total_lengthThis should be set to the total length of the shipment.
shipment_info_total_widthThis should be set to the total width of the shipment.
shipment_special_servicesContains the collection of special services offered by FedEx.
ssl_accept_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_providerThis specifies the SSL/TLS implementation to use.
ssl_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
timeoutA timeout for the class.
total_weightThe 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.

configSets or retrieves a configuration setting.
get_ratesReturns rate information for a specified or all available FedEx services.
resetResets 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.

on_errorInformation about errors during data delivery.
on_notificationNotification returned by the server upon successful request (if applicable).
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusFired when secure connection progress messages are available.

Config Settings


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

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.
CODReferenceIndicatorThe reference information to be added to the COD return label.
CurrencyCodeThe currency code associated with the monetary values present in the request.
CustomerTransactionIdCustomer transaction id.
DryIceCountThe number of packages which contain dry ice.
EstimateDeliveryDetermines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
ListExchangeRate[i]The exchange rate use when converting currency.
ListFromCurrency[i]The currency from which the value was converted.
ListIntoCurrency[i]The currency to which the value was converted.
PackageDryIceWeight[i]The weight of the dry ice for each package.
PackageFreightCommodityIds[i]The Freight Commodity Line Item IDs associated with this package.
PackagePhysicalPackagingType[i]Additional details about the physical packaging of the item in a FedEx Freight shipment.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
SizeUnitThe dimension unit.
SmartPostAncillaryEndorsementThe endorsement type used for a FedEx SmartPost shipment.
SmartPostCustomerManifestIdThe Customer Manifest Id used to group FedEx SmartPost packages.
SmartPostHubIdThe HubId used to send FedEx SmartPost shipments.
SmartPostIndiciaThe Indicia type used for a FedEx SmartPost shipment.
TESTMODEThis configuration setting will allow you to run test transactions.
WarningWarning message returned by the server.
WeightUnitWeight unit.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

cod_total_amount Property

The total amount to be collected on delivery.

Syntax

def get_cod_total_amount() -> str: ...
def set_cod_total_amount(value: str) -> None: ...

cod_total_amount = property(get_cod_total_amount, set_cod_total_amount)

Default Value

""

Remarks

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

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

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

cod_type Property

COD type.

Syntax

def get_cod_type() -> int: ...
def set_cod_type(value: int) -> None: ...

cod_type = property(get_cod_type, set_cod_type)

Default Value

0

Remarks

This property 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 shipment_special_services.

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

commodity_count Property

The number of records in the Commodity arrays.

Syntax

def get_commodity_count() -> int: ...
def set_commodity_count(value: int) -> None: ...

commodity_count = property(get_commodity_count, set_commodity_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at commodity_count - 1.

commodity_description Property

Complete and accurate description of this commodity line item.

Syntax

def get_commodity_description(commodity_idx: int) -> str: ...
def set_commodity_description(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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 commodity_description has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_freight_class Property

Indicates the freight class of the commodity.

Syntax

def get_commodity_freight_class(commodity_idx: int) -> int: ...
def set_commodity_freight_class(commodity_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Indicates the freight class of the commodity.

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

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_freight_packaging_type Property

Identifies the Commodity item's packaging type.

Syntax

def get_commodity_freight_packaging_type(commodity_idx: int) -> int: ...
def set_commodity_freight_packaging_type(commodity_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_handling_units Property

Number of individual handling units to which this commodity applies.

Syntax

def get_commodity_handling_units(commodity_idx: int) -> int: ...
def set_commodity_handling_units(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

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.)

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_harmonized_code Property

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

Syntax

def get_commodity_harmonized_code(commodity_idx: int) -> str: ...
def set_commodity_harmonized_code(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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 commodity_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 commodity_harmonized_code 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 total_customs_value is greater than 2,500 USD or if a valid U.S. Export license is required.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_hazardous_materials_options Property

Indicates the kind of hazardous material content in this commodity.

Syntax

def get_commodity_hazardous_materials_options(commodity_idx: int) -> int: ...
def set_commodity_hazardous_materials_options(commodity_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Indicates the kind of hazardous material content in this commodity.

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

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_height Property

The height of the commodity.

Syntax

def get_commodity_height(commodity_idx: int) -> int: ...
def set_commodity_height(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

The height of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_id Property

A unique identifier assigned to this line item.

Syntax

def get_commodity_id(commodity_idx: int) -> str: ...
def set_commodity_id(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

A unique identifier assigned to this line item.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_length Property

The width of the commodity.

Syntax

def get_commodity_length(commodity_idx: int) -> int: ...
def set_commodity_length(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_manufacturer Property

Country code where the contents of this commodity line were produced, manufactured or grown in their final form.

Syntax

def get_commodity_manufacturer(commodity_idx: int) -> str: ...
def set_commodity_manufacturer(commodity_idx: int, value: str) -> None: ...

Default Value

"US"

Remarks

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the commodity_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 commodity_manufacturer and commodity_description are required to be provided in the request. If the commodity_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 commodity_manufacturer has to be provided for each commodity item included in that international shipment.

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

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

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

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_nmfc_code Property

NMFC Code for commodity.

Syntax

def get_commodity_nmfc_code(commodity_idx: int) -> str: ...
def set_commodity_nmfc_code(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

NMFC Code for commodity.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_number_of_pieces Property

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

Syntax

def get_commodity_number_of_pieces(commodity_idx: int) -> int: ...
def set_commodity_number_of_pieces(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

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

If the Documents is set to False in ship request, the commodity_number_of_pieces 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.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_po_number Property

The PO Number for printed reference per commodity.

Syntax

def get_commodity_po_number(commodity_idx: int) -> str: ...
def set_commodity_po_number(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

The PO Number for printed reference per commodity.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_quantity Property

Number of units contained in this commodity line item measured in units specified by the QuantityUnit .

Syntax

def get_commodity_quantity(commodity_idx: int) -> int: ...
def set_commodity_quantity(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

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

If the Documents is set to False in ship request, the commodity_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.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_quantity_unit Property

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

Syntax

def get_commodity_quantity_unit(commodity_idx: int) -> str: ...
def set_commodity_quantity_unit(commodity_idx: int, value: str) -> None: ...

Default Value

"EA"

Remarks

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

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

Here is a list of possible values for FedEx:

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_unit_price Property

Value of each QuantityUnit in Quantity of this commodity line item.

Syntax

def get_commodity_unit_price(commodity_idx: int) -> str: ...
def set_commodity_unit_price(commodity_idx: int, value: str) -> None: ...

Default Value

"1.00"

Remarks

Value of each commodity_quantity_unit in commodity_quantity of this commodity line item. This is used in conjunction with the commodity_quantity_unit and commodity_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 commodity_unit_price 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).

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_value Property

The value of an individual item being shipped.

Syntax

def get_commodity_value(commodity_idx: int) -> str: ...
def set_commodity_value(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_volume Property

This should contain the volume of the freight item.

Syntax

def get_commodity_volume(commodity_idx: int) -> str: ...
def set_commodity_volume(commodity_idx: int, value: str) -> None: ...

Default Value

"0.0"

Remarks

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.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_weight Property

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.

Syntax

def get_commodity_weight(commodity_idx: int) -> str: ...
def set_commodity_weight(commodity_idx: int, value: str) -> None: ...

Default Value

"0.00"

Remarks

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 commodity_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.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_width Property

The width of the commodity.

Syntax

def get_commodity_width(commodity_idx: int) -> int: ...
def set_commodity_width(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

fed_ex_account_number Property

The account number associated with the shipment.

Syntax

def get_fed_ex_account_number() -> str: ...
def set_fed_ex_account_number(value: str) -> None: ...

fed_ex_account_number = property(get_fed_ex_account_number, set_fed_ex_account_number)

Default Value

""

Remarks

The account number associated with the shipment.

The fed_ex_account_number 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.

fed_ex_authorization_token Property

Authorization Token used to authenticate the request.

Syntax

def get_fed_ex_authorization_token() -> str: ...
def set_fed_ex_authorization_token(value: str) -> None: ...

fed_ex_authorization_token = property(get_fed_ex_authorization_token, set_fed_ex_authorization_token)

Default Value

""

Remarks

Authorization Token used to authenticate the request.

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

fed_ex_language_code Property

Two-letter code for the language (e.

Syntax

def get_fed_ex_language_code() -> str: ...
def set_fed_ex_language_code(value: str) -> None: ...

fed_ex_language_code = property(get_fed_ex_language_code, set_fed_ex_language_code)

Default Value

"en"

Remarks

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

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

fed_ex_locale_code Property

Two-letter code for the region (e.

Syntax

def get_fed_ex_locale_code() -> str: ...
def set_fed_ex_locale_code(value: str) -> None: ...

fed_ex_locale_code = property(get_fed_ex_locale_code, set_fed_ex_locale_code)

Default Value

"US"

Remarks

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.

fed_ex_server Property

URL for the FedEx Server where the requests are sent.

Syntax

def get_fed_ex_server() -> str: ...
def set_fed_ex_server(value: str) -> None: ...

fed_ex_server = property(get_fed_ex_server, set_fed_ex_server)

Default Value

""

Remarks

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

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

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

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

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

freight_guarantee_date Property

The date the freight shipment is guaranteed for.

Syntax

def get_freight_guarantee_date() -> str: ...
def set_freight_guarantee_date(value: str) -> None: ...

freight_guarantee_date = property(get_freight_guarantee_date, set_freight_guarantee_date)

Default Value

""

Remarks

The date the freight shipment is guaranteed for.

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

freight_guarantee_type Property

Specifies what type of freight guarantee is requested.

Syntax

def get_freight_guarantee_type() -> int: ...
def set_freight_guarantee_type(value: int) -> None: ...

freight_guarantee_type = property(get_freight_guarantee_type, set_freight_guarantee_type)

Default Value

0

Remarks

Specifies what type of freight guarantee is requested.

The valid values are:

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

insured_value Property

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

Syntax

def get_insured_value() -> str: ...
def set_insured_value(value: str) -> None: ...

insured_value = property(get_insured_value, set_insured_value)

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.

package_count Property

The number of records in the Package arrays.

Syntax

def get_package_count() -> int: ...
def set_package_count(value: int) -> None: ...

package_count = property(get_package_count, set_package_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at package_count - 1.

package_height Property

The height of the package to be shipped.

Syntax

def get_package_height(package_idx: int) -> int: ...
def set_package_height(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the package_height is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_length and package_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 package_width is provided in the request, then all other dimensions (package_length and package_height) are to be set as well.

For USPS, this only applies to get_rates and is only required if the package is irregular and the package_packaging_type property is set to ptNonRectangular. (In this case package_width and package_height must still be set). For parcels, package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_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 package_length, package_width, and package_height are required for Priority Mail packages when the package_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).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_insured_value Property

Amount of insurance requested for this package.

Syntax

def get_package_insured_value(package_idx: int) -> str: ...
def set_package_insured_value(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_length Property

The length of the package to be shipped.

Syntax

def get_package_length(package_idx: int) -> int: ...
def set_package_length(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the package_length is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_width and package_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 package_width is provided in the request, then all other dimensions (package_length and package_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 package_packaging_type property is set to ptNonRectangular. (In this case package_width and package_height must still be set).

Note: For parcels, the package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_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 package_length, package_width, and package_height are required for Priority Mail packages when the package_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).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_type Property

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

Syntax

def get_package_type(package_idx: int) -> int: ...
def set_package_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

Possible values are:

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

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

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

If the package_packaging_type is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: package_length, package_width, and package_height.

If the service_type is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the package_packaging_type 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 package_packaging_type make sure this is valid for all the following: sender_country_code, recipient_country_code, service_type, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

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

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

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_signature_type Property

Specifies one of the Delivery Signature Options requested for this package.

Syntax

def get_package_signature_type(package_idx: int) -> int: ...
def set_package_signature_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

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

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

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

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

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

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

For UPS, when delivery confirmation is requested for a package, the package_signature_type should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the service_type. 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_special_services Property

Contains the collection of special services offered on the package level.

Syntax

def get_package_special_services(package_idx: int) -> int: ...
def set_package_special_services(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

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

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

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

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

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

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

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

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the package_cod_amount and package_cod_type, package_signature_type, and package_insured_value.

This property is not applicable to USPS or Canada Post.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_weight Property

Weight of this package.

Syntax

def get_package_weight(package_idx: int) -> str: ...
def set_package_weight(package_idx: int, value: str) -> None: ...

Default Value

"0.0"

Remarks

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 package_packaging_type 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 service_type stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the service_type stUPSExpeditedMailInovations is used with the package_packaging_type 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 postage_provider 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).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_width Property

The width of the package to be shipped.

Syntax

def get_package_width(package_idx: int) -> int: ...
def set_package_width(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the package_width is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_length and package_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 package_width is provided in the request, then all other dimensions (package_length and package_height) are to be set as well.

For USPS, this is only required if the package is irregular and the package_packaging_type property is set to ptNonRectangular. (In this case package_width and package_height must still be set).

Note: For parcels, package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_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 package_length, package_width, and package_height are required for Priority Mail packages when the package_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).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

payor_account_number Property

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

Syntax

def get_payor_account_number() -> str: ...
def set_payor_account_number(value: str) -> None: ...

payor_account_number = property(get_payor_account_number, set_payor_account_number)

Default Value

""

Remarks

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 payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to payor_account_number.

payor_address1 Property

Street name.

Syntax

def get_payor_address1() -> str: ...
def set_payor_address1(value: str) -> None: ...

payor_address1 = property(get_payor_address1, set_payor_address1)

Default Value

""

Remarks

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 payor_address1 and payor_address2 should not exceed 35 characters.

payor_address2 Property

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

def get_payor_address2() -> str: ...
def set_payor_address2(value: str) -> None: ...

payor_address2 = property(get_payor_address2, set_payor_address2)

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of payor_address1 and payor_address2 should not exceed 35 characters.

payor_city Property

Name of city, town, etc.

Syntax

def get_payor_city() -> str: ...
def set_payor_city(value: str) -> None: ...

payor_city = property(get_payor_city, set_payor_city)

Default Value

""

Remarks

Name of city, town, etc.

payor_country_code Property

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

Syntax

def get_payor_country_code() -> str: ...
def set_payor_country_code(value: str) -> None: ...

payor_country_code = property(get_payor_country_code, set_payor_country_code)

Default Value

"US"

Remarks

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

When shipping via FedEx Express, the payor_country_code is required to be provided in the ship request only if payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the payor_country_code is required only if payor_type 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.

payor_name Property

Identifies the payor's name.

Syntax

def get_payor_name() -> str: ...
def set_payor_name(value: str) -> None: ...

payor_name = property(get_payor_name, set_payor_name)

Default Value

""

Remarks

Identifies the payor's name.

payor_name is required only if payor_type is set to 'THIRDPARTY'.

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

payor_type Property

Method of payment for shipment, or duties and taxes.

Syntax

def get_payor_type() -> int: ...
def set_payor_type(value: int) -> None: ...

payor_type = property(get_payor_type, set_payor_type)

Default Value

0

Remarks

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

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

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

For FedEx, when this property is set to a value other than 0 (ptSender), the payor_account_number and payor_country_code are required to be provided in the request as well. Otherwise, those will default to fed_ex_account_number and sender_country_code.

For UPS, when set to ptSender, the payor_account_number is automatically set to ups_account_number. When ptRecipient is specified, payor_account_number and payor_zip_code 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 payor_account_number, payor_zip_code and payor_country_code 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.

payor_state Property

State or province code.

Syntax

def get_payor_state() -> str: ...
def set_payor_state(value: str) -> None: ...

payor_state = property(get_payor_state, set_payor_state)

Default Value

""

Remarks

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.

payor_zip_code Property

Payor's postal code (if applicable).

Syntax

def get_payor_zip_code() -> str: ...
def set_payor_zip_code(value: str) -> None: ...

payor_zip_code = property(get_payor_zip_code, set_payor_zip_code)

Default Value

""

Remarks

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS payor_account_number'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 payor_type is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

pickup_type Property

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

Syntax

def get_pickup_type() -> int: ...
def set_pickup_type(value: int) -> None: ...

pickup_type = property(get_pickup_type, set_pickup_type)

Default Value

0

Remarks

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

Valid values are:

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

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

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

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

rate_type Property

Indicates the type of rates to be returned.

Syntax

def get_rate_type() -> int: ...
def set_rate_type(value: int) -> None: ...

rate_type = property(get_rate_type, set_rate_type)

Default Value

1

Remarks

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

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

recipient_address1 Property

Street name.

Syntax

def get_recipient_address1() -> str: ...
def set_recipient_address1(value: str) -> None: ...

recipient_address1 = property(get_recipient_address1, set_recipient_address1)

Default Value

""

Remarks

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 recipient_address1 should not exceed 35 characters.

recipient_address2 Property

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

def get_recipient_address2() -> str: ...
def set_recipient_address2(value: str) -> None: ...

recipient_address2 = property(get_recipient_address2, set_recipient_address2)

Default Value

""

Remarks

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

recipient_address_flags Property

Various flags that denote information about the address.

Syntax

def get_recipient_address_flags() -> int: ...
def set_recipient_address_flags(value: int) -> None: ...

recipient_address_flags = property(get_recipient_address_flags, set_recipient_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

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

recipient_city Property

Name of city, town, etc.

Syntax

def get_recipient_city() -> str: ...
def set_recipient_city(value: str) -> None: ...

recipient_city = property(get_recipient_city, set_recipient_city)

Default Value

""

Remarks

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

recipient_country_code Property

Country code.

Syntax

def get_recipient_country_code() -> str: ...
def set_recipient_country_code(value: str) -> None: ...

recipient_country_code = property(get_recipient_country_code, set_recipient_country_code)

Default Value

"US"

Remarks

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

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

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

* Not supported by USPS

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

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

recipient_state Property

State or province code.

Syntax

def get_recipient_state() -> str: ...
def set_recipient_state(value: str) -> None: ...

recipient_state = property(get_recipient_state, set_recipient_state)

Default Value

""

Remarks

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.

recipient_zip_code Property

Postal code.

Syntax

def get_recipient_zip_code() -> str: ...
def set_recipient_zip_code(value: str) -> None: ...

recipient_zip_code = property(get_recipient_zip_code, set_recipient_zip_code)

Default Value

""

Remarks

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 recipient_city and recipient_state are not present.

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

requested_service Property

Service type for which the shipping rate is requested.

Syntax

def get_requested_service() -> int: ...
def set_requested_service(value: int) -> None: ...

requested_service = property(get_requested_service, set_requested_service)

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 requested_service 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) package_type 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) package_type 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) package_type 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.

sender_address1 Property

Street name.

Syntax

def get_sender_address1() -> str: ...
def set_sender_address1(value: str) -> None: ...

sender_address1 = property(get_sender_address1, set_sender_address1)

Default Value

""

Remarks

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 sender_address1 should not exceed 35 characters.

sender_address2 Property

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

def get_sender_address2() -> str: ...
def set_sender_address2(value: str) -> None: ...

sender_address2 = property(get_sender_address2, set_sender_address2)

Default Value

""

Remarks

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

sender_address_flags Property

Various flags that denote information about the address.

Syntax

def get_sender_address_flags() -> int: ...
def set_sender_address_flags(value: int) -> None: ...

sender_address_flags = property(get_sender_address_flags, set_sender_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

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

sender_city Property

Name of city, town, etc.

Syntax

def get_sender_city() -> str: ...
def set_sender_city(value: str) -> None: ...

sender_city = property(get_sender_city, set_sender_city)

Default Value

""

Remarks

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

sender_country_code Property

Country code.

Syntax

def get_sender_country_code() -> str: ...
def set_sender_country_code(value: str) -> None: ...

sender_country_code = property(get_sender_country_code, set_sender_country_code)

Default Value

"US"

Remarks

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

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

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

* Not supported by USPS

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

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

sender_state Property

State or province code.

Syntax

def get_sender_state() -> str: ...
def set_sender_state(value: str) -> None: ...

sender_state = property(get_sender_state, set_sender_state)

Default Value

""

Remarks

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.

sender_zip_code Property

Postal code.

Syntax

def get_sender_zip_code() -> str: ...
def set_sender_zip_code(value: str) -> None: ...

sender_zip_code = property(get_sender_zip_code, set_sender_zip_code)

Default Value

""

Remarks

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 sender_city and sender_state are not present.

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

service_count Property

The number of records in the Service arrays.

Syntax

def get_service_count() -> int: ...

service_count = property(get_service_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at service_count - 1.

This property is read-only.

service_account_base_charge Property

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

def get_service_account_base_charge(service_idx: int) -> str: ...

Default Value

""

Remarks

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

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_account_net_charge Property

Net charge amount applied to a ServiceType .

Syntax

def get_service_account_net_charge(service_idx: int) -> str: ...

Default Value

""

Remarks

Net charge amount applied to a service_type.

For FedEx, this is specific to the fed_ex_account_number. After calling the get_rates method, the service_account_net_charge will be filled with the value of discounted net charge amount specific to the fed_ex_account_number (i.e. depending on the current rate schedule the fed_ex_account_number 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 service_type

The UPS server response will contain negotiated rate(s) only for the qualified ups_account_numbers. 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 property 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.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_account_total_discount Property

Total discount amount applied to the shipment for a ServiceType .

Syntax

def get_service_account_total_discount(service_idx: int) -> str: ...

Default Value

""

Remarks

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

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_account_total_surcharge Property

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

Syntax

def get_service_account_total_surcharge(service_idx: int) -> str: ...

Default Value

""

Remarks

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

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_aggregate Property

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

Syntax

def get_service_aggregate(service_idx: int) -> str: ...

Default Value

""

Remarks

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_delivery_date Property

This indicates the shipment delivery date for the ServiceType .

Syntax

def get_service_delivery_date(service_idx: int) -> str: ...

Default Value

""

Remarks

This indicates the shipment delivery date for the service_type.

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 get_shipping_time.

This is not applicable to USPS.

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_delivery_day Property

Indicates the day of the week the shipment can be delivered when using the ServiceType .

Syntax

def get_service_delivery_day(service_idx: int) -> str: ...

Default Value

""

Remarks

Indicates the day of the week the shipment can be delivered when using the service_type. 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 get_shipping_time.

This is not applicable to USPS.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_effective_net_discount Property

Indicates the net discount applied to a ServiceType .

Syntax

def get_service_effective_net_discount(service_idx: int) -> str: ...

Default Value

""

Remarks

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

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_list_base_charge Property

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

def get_service_list_base_charge(service_idx: int) -> str: ...

Default Value

""

Remarks

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

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

This does not apply to USPS.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_list_net_charge Property

Net charge amount applied to a ServiceType .

Syntax

def get_service_list_net_charge(service_idx: int) -> str: ...

Default Value

""

Remarks

Net charge amount applied to a service_type.

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

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_list_total_discount Property

Total discount amount applied to a ServiceType .

Syntax

def get_service_list_total_discount(service_idx: int) -> str: ...

Default Value

""

Remarks

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_list_total_surcharge Property

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

Syntax

def get_service_list_total_surcharge(service_idx: int) -> str: ...

Default Value

""

Remarks

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

After calling the get_rates method, the service_list_total_surcharge will be filled with the value of total surcharges applied.

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

This value does not apply to USPS.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_rate_scale Property

Applicable rate scale for the ServiceType .

Syntax

def get_service_rate_scale(service_idx: int) -> str: ...

Default Value

""

Remarks

Applicable rate scale for the service_type.

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_rate_zone Property

Applicable rate zone for the ServiceType .

Syntax

def get_service_rate_zone(service_idx: int) -> str: ...

Default Value

""

Remarks

Applicable rate zone for the service_type.

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_type Property

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

Syntax

def get_service_type(service_idx: int) -> int: ...

Default Value

0

Remarks

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

This is populated when the get_shipping_time or get_rates methods are called.

Valid values for FedEx are:

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

Valid values for UPS are:

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

Valid values for USPS are:

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

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

Valid values for Canada Post are:

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_type_description Property

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

Syntax

def get_service_type_description(service_idx: int) -> str: ...

Default Value

""

Remarks

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

Possible returned values for FedEx are:

Service Type Service Type Description
10 PRIORITY_OVERNIGHT
11 STANDARD_OVERNIGHT
12 FIRST_OVERNIGHT
13 FEDEX_2_DAY
14 FEDEX_EXPRESS_SAVER
15 FEDEX_GROUND
16 GROUND_HOME_DELIVERY
17 FEDEX_1_DAY_FREIGHT
18 FEDEX_2_DAY_FREIGHT
19 FEDEX_3_DAY_FREIGHT
20 INTERNATIONAL_PRIORITY
21 INTERNATIONAL_ECONOMY
22 INTERNATIONAL_FIRST
23 INTERNATIONAL_PRIORITY_FREIGHT
24 INTERNATIONAL_ECONOMY_FREIGHT
25 EUROPE_FIRST_INTERNATIONAL_PRIORITY
26 FEDEX_SMART_POST
27 FEDEX_2_DAY_AM
28 FEDEX_FIRST_FREIGHT
29 FEDEX_FREIGHT_ECONOMY
30 FEDEX_FREIGHT_PRIORITY
120 FEDEX_DISTANCE_DEFERRED
121 FEDEX_NEXT_DAY_AFTERNOON
122 FEDEX_NEXT_DAY_EARLY_MORNING
123 FEDEX_NEXT_DAY_END_OF_DAY
124 FEDEX_NEXT_DAY_FREIGHT
125 FEDEX_NEXT_DAY_MID_MORNING

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_signature_type Property

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType .

Syntax

def get_service_signature_type(service_idx: int) -> str: ...

Default Value

""

Remarks

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

Possible returned values are:

ADULT
DIRECT
INDIRECT
NO_SIGNATURE_REQUIRED
SERVICE_DEFAULT

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_transit_time Property

Expected number of days in transit from pickup to delivery for the ServiceType .

Syntax

def get_service_transit_time(service_idx: int) -> str: ...

Default Value

""

Remarks

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

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

ship_date Property

The date on which the package will be shipped.

Syntax

def get_ship_date() -> str: ...
def set_ship_date(value: str) -> None: ...

ship_date = property(get_ship_date, set_ship_date)

Default Value

""

Remarks

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

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

Defaults to current system date if not present.

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

shipment_info_account_number Property

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

Syntax

def get_shipment_info_account_number() -> str: ...
def set_shipment_info_account_number(value: str) -> None: ...

shipment_info_account_number = property(get_shipment_info_account_number, set_shipment_info_account_number)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_account_number Property

This should be set to the alternate account number to be billed.

Syntax

def get_shipment_info_alternate_billing_account_number() -> str: ...
def set_shipment_info_alternate_billing_account_number(value: str) -> None: ...

shipment_info_alternate_billing_account_number = property(get_shipment_info_alternate_billing_account_number, set_shipment_info_alternate_billing_account_number)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_city Property

This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_city() -> str: ...
def set_shipment_info_alternate_billing_city(value: str) -> None: ...

shipment_info_alternate_billing_city = property(get_shipment_info_alternate_billing_city, set_shipment_info_alternate_billing_city)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_company_name Property

This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_company_name() -> str: ...
def set_shipment_info_alternate_billing_company_name(value: str) -> None: ...

shipment_info_alternate_billing_company_name = property(get_shipment_info_alternate_billing_company_name, set_shipment_info_alternate_billing_company_name)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_country_code Property

This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_country_code() -> str: ...
def set_shipment_info_alternate_billing_country_code(value: str) -> None: ...

shipment_info_alternate_billing_country_code = property(get_shipment_info_alternate_billing_country_code, set_shipment_info_alternate_billing_country_code)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_person_name Property

This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_person_name() -> str: ...
def set_shipment_info_alternate_billing_person_name(value: str) -> None: ...

shipment_info_alternate_billing_person_name = property(get_shipment_info_alternate_billing_person_name, set_shipment_info_alternate_billing_person_name)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_phone Property

This should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_phone() -> str: ...
def set_shipment_info_alternate_billing_phone(value: str) -> None: ...

shipment_info_alternate_billing_phone = property(get_shipment_info_alternate_billing_phone, set_shipment_info_alternate_billing_phone)

Default Value

""

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_alternate_billing_state Property

This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_state() -> str: ...
def set_shipment_info_alternate_billing_state(value: str) -> None: ...

shipment_info_alternate_billing_state = property(get_shipment_info_alternate_billing_state, set_shipment_info_alternate_billing_state)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_street_address Property

This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_street_address() -> str: ...
def set_shipment_info_alternate_billing_street_address(value: str) -> None: ...

shipment_info_alternate_billing_street_address = property(get_shipment_info_alternate_billing_street_address, set_shipment_info_alternate_billing_street_address)

Default Value

""

Remarks

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.

shipment_info_alternate_billing_zip_code Property

This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber .

Syntax

def get_shipment_info_alternate_billing_zip_code() -> str: ...
def set_shipment_info_alternate_billing_zip_code(value: str) -> None: ...

shipment_info_alternate_billing_zip_code = property(get_shipment_info_alternate_billing_zip_code, set_shipment_info_alternate_billing_zip_code)

Default Value

""

Remarks

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.

shipment_info_billing_address1 Property

This should be set to the first address line listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_address1() -> str: ...
def set_shipment_info_billing_address1(value: str) -> None: ...

shipment_info_billing_address1 = property(get_shipment_info_billing_address1, set_shipment_info_billing_address1)

Default Value

""

Remarks

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.

shipment_info_billing_address2 Property

This should be set to the second address line listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_address2() -> str: ...
def set_shipment_info_billing_address2(value: str) -> None: ...

shipment_info_billing_address2 = property(get_shipment_info_billing_address2, set_shipment_info_billing_address2)

Default Value

""

Remarks

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.

shipment_info_billing_city Property

This should be set to the city listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_city() -> str: ...
def set_shipment_info_billing_city(value: str) -> None: ...

shipment_info_billing_city = property(get_shipment_info_billing_city, set_shipment_info_billing_city)

Default Value

""

Remarks

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.

shipment_info_billing_company_name Property

This should be set to the name of the company listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_company_name() -> str: ...
def set_shipment_info_billing_company_name(value: str) -> None: ...

shipment_info_billing_company_name = property(get_shipment_info_billing_company_name, set_shipment_info_billing_company_name)

Default Value

""

Remarks

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.

shipment_info_billing_country_code Property

This should be set to the country code listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_country_code() -> str: ...
def set_shipment_info_billing_country_code(value: str) -> None: ...

shipment_info_billing_country_code = property(get_shipment_info_billing_country_code, set_shipment_info_billing_country_code)

Default Value

""

Remarks

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.

shipment_info_billing_email Property

This should be set to the email address listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_email() -> str: ...
def set_shipment_info_billing_email(value: str) -> None: ...

shipment_info_billing_email = property(get_shipment_info_billing_email, set_shipment_info_billing_email)

Default Value

""

Remarks

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.

shipment_info_billing_fax Property

This should be set to the fax number listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_fax() -> str: ...
def set_shipment_info_billing_fax(value: str) -> None: ...

shipment_info_billing_fax = property(get_shipment_info_billing_fax, set_shipment_info_billing_fax)

Default Value

""

Remarks

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.

shipment_info_billing_person_name Property

This should be set to the name of the person listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_person_name() -> str: ...
def set_shipment_info_billing_person_name(value: str) -> None: ...

shipment_info_billing_person_name = property(get_shipment_info_billing_person_name, set_shipment_info_billing_person_name)

Default Value

""

Remarks

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.

shipment_info_billing_phone Property

This should be set to the phone number listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_phone() -> str: ...
def set_shipment_info_billing_phone(value: str) -> None: ...

shipment_info_billing_phone = property(get_shipment_info_billing_phone, set_shipment_info_billing_phone)

Default Value

""

Remarks

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.

shipment_info_billing_state Property

This should be set to the state listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_state() -> str: ...
def set_shipment_info_billing_state(value: str) -> None: ...

shipment_info_billing_state = property(get_shipment_info_billing_state, set_shipment_info_billing_state)

Default Value

""

Remarks

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.

shipment_info_billing_zip_code Property

This should be set to the zip code listed on the account associated with the FreightAccountNumber .

Syntax

def get_shipment_info_billing_zip_code() -> str: ...
def set_shipment_info_billing_zip_code(value: str) -> None: ...

shipment_info_billing_zip_code = property(get_shipment_info_billing_zip_code, set_shipment_info_billing_zip_code)

Default Value

""

Remarks

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.

shipment_info_client_discount_percent Property

The estimated client discount rate for a freight shipment.

Syntax

def get_shipment_info_client_discount_percent() -> str: ...
def set_shipment_info_client_discount_percent(value: str) -> None: ...

shipment_info_client_discount_percent = property(get_shipment_info_client_discount_percent, set_shipment_info_client_discount_percent)

Default Value

""

Remarks

The estimated client discount rate for a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_collect_terms_type Property

This sets the terms for how to collect payment for this freight shipment.

Syntax

def get_shipment_info_collect_terms_type() -> int: ...
def set_shipment_info_collect_terms_type(value: int) -> None: ...

shipment_info_collect_terms_type = property(get_shipment_info_collect_terms_type, set_shipment_info_collect_terms_type)

Default Value

0

Remarks

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

Valid values are as follows:

Value Meaning
0 Standard
1 Non-Recourse Shipper Signed

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_comments Property

The description for this freight shipment.

Syntax

def get_shipment_info_comments() -> str: ...
def set_shipment_info_comments(value: str) -> None: ...

shipment_info_comments = property(get_shipment_info_comments, set_shipment_info_comments)

Default Value

""

Remarks

The description for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_coupons Property

This contains a semicolon delimited list of identifiers for promotional discounts offered to customers.

Syntax

def get_shipment_info_coupons() -> str: ...
def set_shipment_info_coupons(value: str) -> None: ...

shipment_info_coupons = property(get_shipment_info_coupons, set_shipment_info_coupons)

Default Value

""

Remarks

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.

shipment_info_declared_value Property

The total declared value per unit for this freight shipment.

Syntax

def get_shipment_info_declared_value() -> str: ...
def set_shipment_info_declared_value(value: str) -> None: ...

shipment_info_declared_value = property(get_shipment_info_declared_value, set_shipment_info_declared_value)

Default Value

""

Remarks

The total declared value per unit for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_declared_value_units Property

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

Syntax

def get_shipment_info_declared_value_units() -> str: ...
def set_shipment_info_declared_value_units(value: str) -> None: ...

shipment_info_declared_value_units = property(get_shipment_info_declared_value_units, set_shipment_info_declared_value_units)

Default Value

""

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_emergency_contact_phone Property

The phone number for the emergency contact.

Syntax

def get_shipment_info_emergency_contact_phone() -> str: ...
def set_shipment_info_emergency_contact_phone(value: str) -> None: ...

shipment_info_emergency_contact_phone = property(get_shipment_info_emergency_contact_phone, set_shipment_info_emergency_contact_phone)

Default Value

""

Remarks

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

shipment_info_hazardous_materials_offeror Property

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

Syntax

def get_shipment_info_hazardous_materials_offeror() -> str: ...
def set_shipment_info_hazardous_materials_offeror(value: str) -> None: ...

shipment_info_hazardous_materials_offeror = property(get_shipment_info_hazardous_materials_offeror, set_shipment_info_hazardous_materials_offeror)

Default Value

""

Remarks

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.

shipment_info_liability_coverage_amount Property

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

Syntax

def get_shipment_info_liability_coverage_amount() -> str: ...
def set_shipment_info_liability_coverage_amount(value: str) -> None: ...

shipment_info_liability_coverage_amount = property(get_shipment_info_liability_coverage_amount, set_shipment_info_liability_coverage_amount)

Default Value

""

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_liability_coverage_type Property

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

Syntax

def get_shipment_info_liability_coverage_type() -> int: ...
def set_shipment_info_liability_coverage_type(value: int) -> None: ...

shipment_info_liability_coverage_type = property(get_shipment_info_liability_coverage_type, set_shipment_info_liability_coverage_type)

Default Value

0

Remarks

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

Valid values are as follows:

Value Meaning
0 New
1 Used or Reconditioned

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_pallet_weight Property

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

Syntax

def get_shipment_info_pallet_weight() -> str: ...
def set_shipment_info_pallet_weight(value: str) -> None: ...

shipment_info_pallet_weight = property(get_shipment_info_pallet_weight, set_shipment_info_pallet_weight)

Default Value

""

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_role Property

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

Syntax

def get_shipment_info_role() -> int: ...
def set_shipment_info_role(value: int) -> None: ...

shipment_info_role = property(get_shipment_info_role, set_shipment_info_role)

Default Value

0

Remarks

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

Valid values are as follows:

Value Meaning
0 Shipper
1 Consignee

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_total_handling_units Property

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

Syntax

def get_shipment_info_total_handling_units() -> int: ...
def set_shipment_info_total_handling_units(value: int) -> None: ...

shipment_info_total_handling_units = property(get_shipment_info_total_handling_units, set_shipment_info_total_handling_units)

Default Value

1

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_total_height Property

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

Syntax

def get_shipment_info_total_height() -> int: ...
def set_shipment_info_total_height(value: int) -> None: ...

shipment_info_total_height = property(get_shipment_info_total_height, set_shipment_info_total_height)

Default Value

0

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_total_length Property

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

Syntax

def get_shipment_info_total_length() -> int: ...
def set_shipment_info_total_length(value: int) -> None: ...

shipment_info_total_length = property(get_shipment_info_total_length, set_shipment_info_total_length)

Default Value

0

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_info_total_width Property

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

Syntax

def get_shipment_info_total_width() -> int: ...
def set_shipment_info_total_width(value: int) -> None: ...

shipment_info_total_width = property(get_shipment_info_total_width, set_shipment_info_total_width)

Default Value

0

Remarks

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

shipment_special_services Property

Contains the collection of special services offered by FedEx.

Syntax

def get_shipment_special_services() -> int: ...
def set_shipment_special_services(value: int) -> None: ...

shipment_special_services = property(get_shipment_special_services, set_shipment_special_services)

Default Value

0

Remarks

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

ValueMeaning
0x00000001L Broker Select
0x00000004L COD
0x00000010L Dangerous Goods
0x00000020L Do Not Break Down Pallets
0x00000040L Do Not Stack Pallets
0x00000080L Dry Ice
0x00000200L Electronic Trade Documents
0x00000400L Event Notification
0x00000800L Extreme Length
0x00001000L Food
0x00002000L Freight Guarantee
0x00008000L Hold At Location
0x00010000L International Controlled Export Service
0x00040000L Inside Delivery
0x00080000L Inside Pickup
0x00100000L Liftgate Delivery
0x00200000L Liftgate Pickup
0x02000000L Poison
0x04000000L Protection From Freezing
0x10000000L Saturday Delivery
0x20000000L Saturday Pickup
0x40000000L Top Load
0x10000000000LInternational 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 shipment_special_services value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:
    • stFedExInternationalPriority (20)
    • stFedExInternationalEconomy (21)
    • stFedExInternationalPriorityFreight (23)
    • stFedExInternationalEconomyFreight (24)
    • stFedExInternationalPriorityExpress (32)
    • stFedExInternationalConnectPlus (33)
    FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the clearance_brokerage_type, broker_type, broker_contact, and broker_address are required to be provided in the ship request as well.

    Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.

  • COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. When set, the cod_total_amount and cod_type 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 commodity_hazardous_materials_options must be selected and the shipment_info_emergency_contact_phone 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 requested_etd_documents property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them. Note: This is only valid for FedEx International Economy Freight and FedEx International Priority Freight.

  • Event Notification: Indicates that event notification is requested. This might affect the service availability. If this is requested in a ship request, then the notify collection is required to be set. Note that this is only valid for FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
  • Extreme Length: This indicates that the pallet is longer than typically allowed. This requires prior clearance with FedEx.
  • Food: This indicates that the shipment contains food items. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
  • Freight Guarantee: This indicates that the freight shipment is guaranteed for a specific date and time. When set, the freight_guarantee property should be set. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
  • Hold At Location: Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, or when recipient_address_flags is set to Residential (i.e., for residential delivery). When this service is requested hold_at_location 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 intl_export_controlled_export_type, intl_export_entry_number, intl_export_foreign_trade_zone_code, and intl_export_license_number_expiration 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 intl_export_controlled_export_type, intl_export_entry_number, intl_export_foreign_trade_zone_code, and intl_export_license_number_expiration 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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

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 property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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.
Additional Notes

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_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 do_events 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 fails with an error.

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.

total_weight Property

The total weight of all the pieces in this shipment.

Syntax

def get_total_weight() -> str: ...
def set_total_weight(value: str) -> None: ...

total_weight = property(get_total_weight, set_total_weight)

Default Value

""

Remarks

This property is required when submitting a rate request by calling get_rates 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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

get_rates Method

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

Syntax

def get_rates() -> None: ...

Remarks

To get the courtesy rate quotes for FedEx services, you can call the get_rates method. If the rates are needed for a specific service type, you will have to pass a value of the requested_service (other than 'UNSPECIFIED') in the request. The requested_service 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 requested_service 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):

Regarding the packages, please note the following:

  • when requesting rates for all available services (requested_service 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 (requested_service set to a value other than 'UNSPECIFIED'), you will have to add as many packages as there are in the MPS specifying the package detail for each package included in the shipment.
In each above mentioned cases, if there are no packages added and specified (packages = null), the class will throw an error.

Upon a successful response, the services property gets populated.

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

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

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about errors during data delivery.

Syntax

class FedExFreightRatesErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class FedExFreightRates:
@property
def on_error() -> Callable[[FedExFreightRatesErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FedExFreightRatesErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_notification Event

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

Syntax

class FedExFreightRatesNotificationEventParams(object):
  @property
  def message() -> str: ...

# In class FedExFreightRates:
@property
def on_notification() -> Callable[[FedExFreightRatesNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[FedExFreightRatesNotificationEventParams], None]) -> None: ...

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 on_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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class FedExFreightRatesSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class FedExFreightRates:
@property
def on_ssl_server_authentication() -> Callable[[FedExFreightRatesSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FedExFreightRatesSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

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

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

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class FedExFreightRatesSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class FedExFreightRates:
@property
def on_ssl_status() -> Callable[[FedExFreightRatesSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[FedExFreightRatesSSLStatusEventParams], None]) -> None: ...

Remarks

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

FedExFreightRates Config Settings

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:

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

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

This optional field identifies the preferred currency of the requestor.

CustomerTransactionId:   Customer transaction id.

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

DryIceCount:   The number of packages which contain dry ice.

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

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.

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 shipment_special_services). 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:

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

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:

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

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

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

SmartPostHubId:   The HubId used to send FedEx SmartPost shipments.

When you want to ship packages via FedEx SmartPost, you will have to specify the SmartPostHubId. By setting this, the server will consider your shipment as a SmartPost one. service_type 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:

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

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

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

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

Warning:   Warning message returned by the server.

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

WeightUnit:   Weight unit.

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

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

HTTP Config Settings

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

When AllowHTTPCompression is True, the 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 http_version 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 fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file 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 auth_scheme 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 on_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 fails with an error.

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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

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:

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

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

HTTP/2 Notes

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

If the server does not support HTTP/2, the 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/3 Notes

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

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

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

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

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

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

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

The default value for KeepAlive is False.

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

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

LogLevel:   The level of detail that is logged.

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

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

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

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

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

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

When follow_redirects 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 http_version 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 proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

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.

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

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

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

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

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

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

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the 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 Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the 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. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

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).

Note: This setting is applicable only to Mac/iOS editions.

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

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.

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 fails with an error.

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:

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

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 fails with an error.

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 local_host 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 local_host 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 local_port after the connection is established.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

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

When ssl_provider 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 on_ssl_status event, which will fire each time an SSL packet is sent or received.

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

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

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:

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

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

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

The default value is:

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

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 fails with an error.

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 fails with an error.

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 on_ssl_status event.

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

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

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

The enabled cipher suites to be used in SSL negotiation.

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

The special value "*" means that the 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.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when ssl_provider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider 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 on_ssl_server_authentication 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 on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

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 ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

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

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when ssl_provider 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 fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the 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.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   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 configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

FedExFreightRates Errors

FedExFreightRates Errors

301   Operation interrupted (or timeout).
432   Invalid index.
527   Server Error Response.
528   Property set with invalid data.

The class may also return one of the following error codes, which are inherited from other classes.