FedExShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx domestic services complete with addresses and barcode, cancel a shipment or close out the FedEx Ground shipments.

Syntax

class dshippingsdk.FedExShip

Remarks

Generating a shipping label can be done by calling either the get_package_label or get_shipment_labels method. You will have to specify the package information, FedEx service to be used for shipping this package, origin and destination information, and any other special services associated with the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Locations, etc.).

This class also allows you to delete packages included in the daily shipping log that have not already been tendered to FedEx by calling the cancel_shipment method. The TrackingNumber parameter that identifies the shipment must be specified in the request along with the fed_ex_account_number.

When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling close_ground_shipments method.

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.

NOTE: FedEx requires that all applications that print shipping labels pass a series of certification tests prior to being placed in production. The full version of FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

Property List


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

carrier_typeThe carrier type.
close_dateIdentifies the date up to which the unclosed FedEx Ground shipments are to be closed.
close_report_fileFile name of the report to be saved and/or printed by customer.
close_report_typeIndicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.
close_timeIdentifies the time up to which the unclosed FedEx Ground shipments are to be closed.
close_tracking_numberShipment Ground tracking number.
cod_labelThe label that is returned.
cod_label_fileThe file the COD label should be written to.
cod_total_amountThe total amount to be collected on delivery.
cod_tracking_numberContains the tracking number for the COD return shipment.
cod_typeCOD type.
company_close_timeThe time your company closes.
delivery_dateDate on which shipment is expected to be delivered.
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.
haz_mat_certificateImage of a Hazardous Materials certification report.
hold_at_location_address1Street name.
hold_at_location_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
hold_at_location_cityName of city, town, etc.
hold_at_location_country_codeCountry code.
hold_at_location_stateState or province code.
hold_at_location_zip_codePostal code.
hold_at_location_contact_companyIdentifies the contact person's company name.
hold_at_location_contact_emailIdentifies the contact person's email address.
hold_at_location_contact_faxRecipient's fax number.
hold_at_location_contact_first_nameSender's first name.
hold_at_location_contact_last_namePerson's last name.
hold_at_location_contact_middle_initialMiddle initial.
hold_at_location_contact_phoneIdentifies the contact person's phone number.
hold_at_location_phonePhone number of the FedEx location where the shipment will be hold at.
home_delivery_dateDate for Ground Home Delivery service.
home_delivery_phoneThe phone number of the delivery location.
home_delivery_typeThe type of Home Delivery Premium service being requested.
insured_valueTotal insured amount.
label_image_typeType of image or printer commands the label is to be formatted in.
locationThe FedEx location identifier that received the express dispatch request.
manifestImage of the manifest for FedEx Ground shipment activity.
master_tracking_numberTracking number assigned to the whole MPS shipment.
multiweight_reportImage of a multiweight report.
notify_countThe number of records in the Notify arrays.
notify_aggregateThis can be used to set the entire aggregate xml for the recipient to be notified.
notify_emailEmail address of the recipient to be notified.
notify_messageUser defined text that will be included in the email to be sent to Email .
notify_nameThe name associated with the notification.
notify_flagsIdentifies the type of notification requested.
notify_typeIdentifies the set of valid email notification recipient types.
origin_address1Street name.
origin_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
origin_address_flagsVarious flags that denote information about the address.
origin_cityName of city, town, etc.
origin_country_codeCountry code.
origin_stateState or province code.
origin_zip_codePostal code.
origin_companyIdentifies the contact person's company name.
origin_emailIdentifies the contact person's email address.
origin_faxRecipient's fax number.
origin_first_nameSender's first name.
origin_last_namePerson's last name.
origin_middle_initialMiddle initial.
origin_phoneIdentifies the contact person's phone number.
package_locationThe location of pickup.
package_countThe number of records in the Package arrays.
package_base_chargeActual Base Charge applicable to this package.
package_cod_amountThe COD monetary value for the package.
package_cod_fileFilename and location to save the CODLabel of this package to.
package_cod_labelImage of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
package_cod_typeThe code that indicates the type of funds that will be used for the COD payment for this package.
package_dangerous_goods_accessibleIdentifies whether or not the dangerous goods being shipped are required to be accessible during delivery.
package_dangerous_goods_optionsContains the collection of options will be used on the package level when using dangerous goods.
package_descriptionFor FedEx, this is the description that appears in the email to identify this package.
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_net_chargeActual Net Charge applicable to this package.
package_typeThe packaging type of the package being rated and/or shipped.
package_referenceIndicates the package reference type and value, that associates this package (assigned by the customer).
package_shipping_labelImage of the shipping label for this package returned by the Server upon a successful ship response.
package_shipping_label_fileFilename and location to save the ShippingLabel of this package to.
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_total_discountTotal Actual Discount applicable to this package.
package_total_surchargesTotal Actual Surcharges applicable to this package.
package_tracking_numberTracking number assigned to this package.
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.
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.
recipient_companyIdentifies the contact person's company name.
recipient_emailIdentifies the contact person's email address.
recipient_faxRecipient's fax number.
recipient_first_nameSender's first name.
recipient_last_namePerson's last name.
recipient_middle_initialMiddle initial.
recipient_phoneIdentifies the contact person's phone number.
return_address1Street name.
return_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
return_address_flagsVarious flags that denote information about the address.
return_cityName of city, town, etc.
return_country_codeCountry code.
return_stateState or province code.
return_zip_codePostal code.
return_companyIdentifies the contact person's company name.
return_emailIdentifies the contact person's email address.
return_faxRecipient's fax number.
return_first_nameSender's first name.
return_last_namePerson's last name.
return_middle_initialMiddle initial.
return_phoneIdentifies the contact person's phone number.
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.
sender_companyIdentifies the contact person's company name.
sender_emailIdentifies the contact person's email address.
sender_faxRecipient's fax number.
sender_first_nameSender's first name.
sender_last_namePerson's last name.
sender_middle_initialMiddle initial.
sender_phoneIdentifies the contact person's phone number.
service_typeIdentifies the FedEx domestic service to use in a ship request.
ship_dateThe date on which the package will be tendered to FedEx.
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_net_chargeThe total net charge applied to the whole shipment (specific to the AccountNumber ).
total_weightTotal shipment weight.
transit_timeExpected number of days in transit from pickup to delivery.

Method List


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

cancel_packageCancels a single package shipment by deleting it from the shipping log.
cancel_pickupCancels a scheduled Carrier Pickup request.
cancel_shipmentCancels all packages within the shipment.
close_ground_shipmentsCloses out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.
configSets or retrieves a configuration setting.
get_package_labelGenerates a shipping label for the specified package.
get_shipment_labelsGenerates a shipping label for all packages in the shipment.
pickup_availabilityChecks the availability of the courier dispatch service for the given address.
reprint_documentsReprints the requested document.
resetResets the internal state of the class and all properties to their default values.
schedule_pickupThis method schedules a courier pickup.

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.

AccessTimeTime window for FedEx to pickup up the package.
BlockVisibilityWhether the visibility of this shipment should be blocked from parties other than shipper/payor.
BookingNumberBooking confirmation number.
CancelledShipmentIndicates whether the shipment has been cancelled or not.
CODRecipientAddress1The primary street address of the COD recipient.
CODRecipientAddress1Street name of the COD recipient.
CODRecipientAddress2The secondary street address of the COD recipient.
CODRecipientAddress2A specific detail on the COD recipient's address (such as building, suite, apartment, floor number etc.).
CODRecipientCityThe city of the COD recipient.
CODRecipientCityName of city, town, etc. of the COD recipient.
CODRecipientCompanyThe company of the COD recipient.
CODRecipientCompanyCompany name of the COD recipient.
CODRecipientCountryCodeThe country code of the COD recipient.
CODRecipientCountryCodeCountry code of the COD recipient.
CODRecipientNameThe name of the COD recipient.
CODRecipientNameName of the COD recipient.
CODRecipientPhoneThe phone number of the COD recipient.
CODRecipientPhonePhone number of the COD recipient.
CODRecipientResidentialThe residential status of the COD recipient.
CODRecipientResidentialIndicates whether the COD recipient address is residential (as opposed to commercial).
CODRecipientStateThe state of the COD recipient.
CODRecipientStateState or province code of the COD recipient.
CODRecipientZipCodeThe zip code of the COD recipient.
CODRecipientZipCodePostal code of the COD recipient.
CODReferenceIndicatorThe reference information to be added to the COD return label.
CODTrackingNumberThe COD Tracking Number.
CustomerTransactionIdCustomer transaction id.
CutoffTimeLatest pickup time.
DeliveryDayDay of the week on which shipment is expected to be delivered.
DeliveryInstructionsDelivery instructions.
DocTabContentCustom DocTab content set by the user when preparing a shipping label.
DryIceCountThe number of packages which contain dry ice.
EmailLabelExpirationDateEmail label's expiration date.
EstimateDeliveryDetermines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
FreightAccountNumberAccount number used with the FedEx Freight service.
FreightAlternateBillingAccountNumberThe alternate account number to be billed.
FreightAlternateBillingCityThe city of the party to be billed.
FreightAlternateBillingCompanyNameThe name of the company to be billed.
FreightAlternateBillingCountryCodeThe country code of the party to be billed.
FreightAlternateBillingPersonNameThe name of the person to be billed.
FreightAlternateBillingPhoneThe phone of the party to be billed.
FreightAlternateBillingStateThe state of the party to be billed.
FreightAlternateBillingStreetAddressThe street address line of the party to be billed.
FreightAlternateBillingZipCodeThe zip code of the party to be billed.
FreightBillingAddress1The first address line of the party to be billed.
FreightBillingAddress2The second address line of the party to be billed.
FreightBillingCityThe city of the party to be billed.
FreightBillingCompanyNameThe name of the company to be billed.
FreightBillingCountryCodeThe country code of the party to be billed.
FreightBillingEmailThe email of the party to be billed.
FreightBillingFaxThe fax number of the party to be billed.
FreightBillingPersonNameThe name of the person to be billed.
FreightBillingPhoneThe phone number of the party to be billed.
FreightBillingStateThe state of the party to be billed.
FreightBillingZipCodeThe zip code of the party to be billed.
FreightClientDiscountPercentEstimated discount rate provided by client for unsecured rate quote.
FreightCollectTermsTypeThe terms of the collect payment for a Freight Shipment.
FreightCommentDescription for the shipment.
FreightDeclaredValueThe declared value for the shipment.
FreightDeclaredValueUnitsThe declared value units.
FreightHazardousMaterialsOfferorThe offeror of the hazardous materials.
FreightItemClass[i]The class of the freight item.
FreightItemCountThe number of freight items.
FreightItemDescription[i]The description for the specified freight item.
FreightItemHeight[i]The height of the specified freight item.
FreightItemLength[i]The length of the specified freight item.
FreightItemPackagingType[i]The packaging type for the specified freight item.
FreightItemVolume[i]Volume of the specified freight item.
FreightItemWeight[i]The weight of the specified freight item.
FreightItemWidth[i]The width of the specified freight item.
FreightLiabilityCoverageAmountThe total amount of liability coverage.
FreightLiabilityCoverageTypeThe type of liability coverage offered.
FreightPalletWeightTotal weight of pallets used in shipment.
FreightRoleIndicates the role of the party submitting the transaction.
FreightShipmentHeightThe overall height of the shipment.
FreightShipmentLengthThe overall length of the shipment.
FreightShipmentWidthThe overall width of the shipment.
FreightTotalHandlingUnitsThe total handling units for the shipment.
LabelFormatTypeIndicates the type of label to be returned.
LabelOrientationTypeIndicates if the top or bottom of the label comes out of the printer.
LabelStockTypeIndicates the size of the label and the location of the doc tab if present.
ListTotalNetCharge[i]Total net charge for list rates applied at package level at index i (if applicable).
MaskedDataSpecifies which data/sections to be masked on the shipping label.
MerchantPhoneNumberThe merchant's phone number.
OverwriteDetermines whether label files will be overwritten.
PackageAlcoholRecipientType[i]The type of recipient for an Alcohol Special Service package.
PackageCountThe number of packages to be picked up.
PackageDocumentFileThe file path for the additional package documents.
PackageDryIceWeight[i]The weight of the dry ice for each package.
PackageRatingAggregate[i]String representing the rating detail on package level (at index i).
PayorPhonePayor's phone number.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
RMANumberThe RMA number.
RMAReasonThe RMA reason description.
ShipmentRatingAggregateString representing the rating detail on shipment level.
ShipTimeLocal Time of shipment based on shipper's time zone.
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.
SmartPostTrackingNumbersContains the tracking numbers for a FedEx SmartPost shipment.
SpecialInstructionsSpecial instructions for the courier.
TESTMODEThis configuration setting will allow you to run test transactions.
UseAccountAddressWhether or not the pickup should be sent to the address associated with the account.
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.

carrier_type Property

The carrier type.

Syntax

def get_carrier_type() -> int: ...
def set_carrier_type(value: int) -> None: ...

carrier_type = property(get_carrier_type, set_carrier_type)

Default Value

1

Remarks

This specifies the carrier to be used when calling schedule_pickup, or cancel_pickup.

The possible values are as follows:

ValueDescription
ctFDXC (0) FedEx Cargo
ctFDXE (1) FedEx Express
ctFDXG (2) FedEx Ground
ctFXCC (3) FedEx Custom Critical
ctFXFR (4) FedEx Freight
ctFXSP (5) FedEx Smart Post

close_date Property

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed.

Syntax

def get_close_date() -> str: ...
def set_close_date(value: str) -> None: ...

close_date = property(get_close_date, set_close_date)

Default Value

""

Remarks

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed. The close_date and close_time are both required to be provided in a close operation request (when close_ground_shipments method is called). If not provided, it will default to the current date.

This property is applicable for FedEx Ground services only. Format: YYYY-MM-DD (e.g. 2006-06-26).

close_report_file Property

File name of the report to be saved and/or printed by customer.

Syntax

def get_close_report_file() -> str: ...
def set_close_report_file(value: str) -> None: ...

close_report_file = property(get_close_report_file, set_close_report_file)

Default Value

""

Remarks

File name of the report to be saved and/or printed by customer. A value (a name for the file) has to be assigned to this property if close_report_type is set to a value other than 0 (Unspecified) when close_ground_shipments is called. Depending on the value assigned to close_report_type, the server response will include only one of the following reports: manifest, multiweight_report, COD Report or haz_mat_certificate. The contents of any of these reports are written to disk in close_report_file. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

close_report_type Property

Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.

Syntax

def get_close_report_type() -> int: ...
def set_close_report_type(value: int) -> None: ...

close_report_type = property(get_close_report_type, set_close_report_type)

Default Value

0

Remarks

Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.

If this is set to a value other than 0 (Unspecified), the server with return that specific report from the last three closed shipping days. Otherwise, the server will return the shipment manifest along with all applicable reports.

When requesting a certain type of report, only one type can be returned per Close request. If you need multiple report types you will have to issue multiple close_ground_shipments requests.

Valid report types are listed below:

Type Meaning
crtUnspecified (0) The Close operation is requested to be processed, but no specific report is requested
crtManifest (1) Only the Ground Manifest Report is requested
crtCOD (2) Only the Ground COD Report is requested
crtHazMat (3) Only the Ground Hazardous Materials Report is requested
crtMultiweight (4) Only the Ground Multiweight Report is requested

This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling reprint_documents.

close_time Property

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed.

Syntax

def get_close_time() -> str: ...
def set_close_time(value: str) -> None: ...

close_time = property(get_close_time, set_close_time)

Default Value

"19:00:00"

Remarks

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed. The close_date and close_time are both required to be provided in a close operation request (when the close_ground_shipments method is called).

Format: HH:MM:SS using a 24 hour clock. This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling reprint_documents.

close_tracking_number Property

Shipment Ground tracking number.

Syntax

def get_close_tracking_number() -> str: ...
def set_close_tracking_number(value: str) -> None: ...

close_tracking_number = property(get_close_tracking_number, set_close_tracking_number)

Default Value

""

Remarks

Shipment Ground tracking number. Provided to obtain the manifest containing this tracking number. If you include the close_tracking_number of a particular Ground shipment for which you want to print Ground reports (Manifest, C.O.D., Hazmat or Multiweight Detail), the report(s) requested in the close_report_type element are returned.

Maximum length: 20 characters.

NOTE: This only takes effect when calling reprint_documents.

cod_label Property

The label that is returned.

Syntax

def get_cod_label() -> str: ...

cod_label = property(get_cod_label, None)

Default Value

""

Remarks

If cod_label_file is not set the image for the COD label this will be used to store the COD label.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

This property is read-only.

cod_label_file Property

The file the COD label should be written to.

Syntax

def get_cod_label_file() -> str: ...
def set_cod_label_file(value: str) -> None: ...

cod_label_file = property(get_cod_label_file, set_cod_label_file)

Default Value

""

Remarks

The COD label will be written to the file specified. If no file is specified then the image will be stored in memory in cod_label.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

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_tracking_number Property

Contains the tracking number for the COD return shipment.

Syntax

def get_cod_tracking_number() -> str: ...

cod_tracking_number = property(get_cod_tracking_number, None)

Default Value

""

Remarks

When shipping COD via any of the domestic FedEx Express services, this is returned in the server response. This value can then be used to track the COD return package.

This property is read-only.

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

company_close_time Property

The time your company closes.

Syntax

def get_company_close_time() -> str: ...
def set_company_close_time(value: str) -> None: ...

company_close_time = property(get_company_close_time, set_company_close_time)

Default Value

""

Remarks

This property is required for pickup_availability and schedule_pickup requests. The ShipTime can be used to set the ready time stamp for the pickup. The ShipTime and the company_close_time must allow a long enough time period for the pickup to occur.

delivery_date Property

Date on which shipment is expected to be delivered.

Syntax

def get_delivery_date() -> str: ...

delivery_date = property(get_delivery_date, None)

Default Value

""

Remarks

When either the get_package_label or the get_shipment_labels method is called, the delivery_date will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

This property is read-only.

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

haz_mat_certificate Property

Image of a Hazardous Materials certification report.

Syntax

def get_haz_mat_certificate() -> bytes: ...

haz_mat_certificate = property(get_haz_mat_certificate, None)

Default Value

""

Remarks

This identifies the buffer containing the Hazardous Materials certification report for FedEx Ground HazMat shipments.

When calling the close_ground_shipments method, the haz_mat_certificate is returned when close_report_type is set to 3 (HazMat).

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by close_report_file.

This property is applicable for FedEx Ground services only.

This property is read-only.

hold_at_location_address1 Property

Street name.

Syntax

def get_hold_at_location_address1() -> str: ...
def set_hold_at_location_address1(value: str) -> None: ...

hold_at_location_address1 = property(get_hold_at_location_address1, set_hold_at_location_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 hold_at_location_address1 should not exceed 35 characters.

hold_at_location_address2 Property

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

Syntax

def get_hold_at_location_address2() -> str: ...
def set_hold_at_location_address2(value: str) -> None: ...

hold_at_location_address2 = property(get_hold_at_location_address2, set_hold_at_location_address2)

Default Value

""

Remarks

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

hold_at_location_city Property

Name of city, town, etc.

Syntax

def get_hold_at_location_city() -> str: ...
def set_hold_at_location_city(value: str) -> None: ...

hold_at_location_city = property(get_hold_at_location_city, set_hold_at_location_city)

Default Value

""

Remarks

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

hold_at_location_country_code Property

Country code.

Syntax

def get_hold_at_location_country_code() -> str: ...
def set_hold_at_location_country_code(value: str) -> None: ...

hold_at_location_country_code = property(get_hold_at_location_country_code, set_hold_at_location_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

hold_at_location_state Property

State or province code.

Syntax

def get_hold_at_location_state() -> str: ...
def set_hold_at_location_state(value: str) -> None: ...

hold_at_location_state = property(get_hold_at_location_state, set_hold_at_location_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.

hold_at_location_zip_code Property

Postal code.

Syntax

def get_hold_at_location_zip_code() -> str: ...
def set_hold_at_location_zip_code(value: str) -> None: ...

hold_at_location_zip_code = property(get_hold_at_location_zip_code, set_hold_at_location_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 hold_at_location_city and hold_at_location_state are not present.

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

hold_at_location_contact_company Property

Identifies the contact person's company name.

Syntax

def get_hold_at_location_contact_company() -> str: ...
def set_hold_at_location_contact_company(value: str) -> None: ...

hold_at_location_contact_company = property(get_hold_at_location_contact_company, set_hold_at_location_contact_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either hold_at_location_contact_first_name and hold_at_location_contact_last_name or hold_at_location_contact_company are required to be provided.

hold_at_location_contact_email Property

Identifies the contact person's email address.

Syntax

def get_hold_at_location_contact_email() -> str: ...
def set_hold_at_location_contact_email(value: str) -> None: ...

hold_at_location_contact_email = property(get_hold_at_location_contact_email, set_hold_at_location_contact_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

hold_at_location_contact_fax Property

Recipient's fax number.

Syntax

def get_hold_at_location_contact_fax() -> str: ...
def set_hold_at_location_contact_fax(value: str) -> None: ...

hold_at_location_contact_fax = property(get_hold_at_location_contact_fax, set_hold_at_location_contact_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

hold_at_location_contact_first_name Property

Sender's first name.

Syntax

def get_hold_at_location_contact_first_name() -> str: ...
def set_hold_at_location_contact_first_name(value: str) -> None: ...

hold_at_location_contact_first_name = property(get_hold_at_location_contact_first_name, set_hold_at_location_contact_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either hold_at_location_contact_first_name and hold_at_location_contact_last_name or hold_at_location_contact_company must be sent.

hold_at_location_contact_last_name Property

Person's last name.

Syntax

def get_hold_at_location_contact_last_name() -> str: ...
def set_hold_at_location_contact_last_name(value: str) -> None: ...

hold_at_location_contact_last_name = property(get_hold_at_location_contact_last_name, set_hold_at_location_contact_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either hold_at_location_contact_first_name and hold_at_location_contact_last_name or hold_at_location_contact_company must be sent. Maximum length: 45 characters for both names or company name.

hold_at_location_contact_middle_initial Property

Middle initial.

Syntax

def get_hold_at_location_contact_middle_initial() -> str: ...
def set_hold_at_location_contact_middle_initial(value: str) -> None: ...

hold_at_location_contact_middle_initial = property(get_hold_at_location_contact_middle_initial, set_hold_at_location_contact_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

hold_at_location_contact_phone Property

Identifies the contact person's phone number.

Syntax

def get_hold_at_location_contact_phone() -> str: ...
def set_hold_at_location_contact_phone(value: str) -> None: ...

hold_at_location_contact_phone = property(get_hold_at_location_contact_phone, set_hold_at_location_contact_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

hold_at_location_phone Property

Phone number of the FedEx location where the shipment will be hold at.

Syntax

def get_hold_at_location_phone() -> str: ...
def set_hold_at_location_phone(value: str) -> None: ...

hold_at_location_phone = property(get_hold_at_location_phone, set_hold_at_location_phone)

Default Value

""

Remarks

When your Hold at Location shipment is received at the designated FedEx station, you will be notified that your shipment is ready to be picked up. It is required to be provided in a HoldAtLocation request.

home_delivery_date Property

Date for Ground Home Delivery service.

Syntax

def get_home_delivery_date() -> str: ...
def set_home_delivery_date(value: str) -> None: ...

home_delivery_date = property(get_home_delivery_date, set_home_delivery_date)

Default Value

""

Remarks

The date when the Home Delivery Premium service is requested to happen. This is required when home_delivery_type is set to 1 (DateCertain). Valid dates are Monday through Saturday.

Format: YYYY-MM-DD.

home_delivery_phone Property

The phone number of the delivery location.

Syntax

def get_home_delivery_phone() -> str: ...
def set_home_delivery_phone(value: str) -> None: ...

home_delivery_phone = property(get_home_delivery_phone, set_home_delivery_phone)

Default Value

""

Remarks

This is required when home_delivery_type is set to 0 (Appointment) or 1 (DateCertain). In a ship request, if this is not specified, it will default to recipient_phone.

home_delivery_type Property

The type of Home Delivery Premium service being requested.

Syntax

def get_home_delivery_type() -> int: ...
def set_home_delivery_type(value: int) -> None: ...

home_delivery_type = property(get_home_delivery_type, set_home_delivery_type)

Default Value

0

Remarks

This property is required to be provided in a ship request when service_type is set to GroundHomeDelivery and shipment_special_services is set to Home Delivery Premium.

Possible values are as follows:

hdtAppointment (0) This option is time-specific. If you want your package delivered at 1:30 on Tuesday, FedEx calls the recipient to confirm this date/time. The recipient_phone is required in the transaction.
hdtDateCertain (1) FedEx contacts the customer (recipient_phone is required in transaction) and schedules a specific date for package delivery.
hdtEvening (2) Just like 'Date Certain Delivery'. FedEx contacts the customer (recipient_phone is required in transaction) and schedules an evening package delivery.

insured_value Property

Total insured amount.

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 element is optional. This is just insurance on the whole shipment if it is lost or stolen. If not provided in the request, FedEx will assume the 0 USD value. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

label_image_type Property

Type of image or printer commands the label is to be formatted in.

Syntax

def get_label_image_type() -> int: ...
def set_label_image_type(value: int) -> None: ...

label_image_type = property(get_label_image_type, set_label_image_type)

Default Value

0

Remarks

This element is required to indicate the format that the shipping label should be printed in. This must be set when either get_package_label or get_shipment_labels are called. The values for the thermal printers indicate the type of printer that is being used.

Valid image types and their meanings with the corresponding usage are listed below:

fitPDF (0) PDF format (plain paper only - laser printer)
fitPNG (1) PNG image (plain paper only - laser printer)
fitEltron (2) Thermal only (to be used with Eltron Orion (EPL2) or Eltron Eclipse (EPL2) printers)
fitZebra (3) Thermal only (to be used with Zebra ZPLII printer series)
fitUniMark (4) Thermal only (to be used with Unimark printer series)
Note: To generate PDF labels, you will need Adobe Reader 6.0 or higher, and the printer driver configuration set to 'none' for print scaling.

There are two types of shipping labels supported:

  • plain paper (to be used in laser printers only. In this case, possible values for the label_image_type are PNG or PDF),
  • thermal (to be used in thermal printers only. In this case, possible values for the label_image_type are ELTRON, ZEBRA, or UNIMARK).

While the content of each of these labels is the same, using the correct image type for the work environment the application will be used in is essential.

You may use the LabelStockType config to specify the size of the label. By default, the class will request a 4x6 label.

location Property

The FedEx location identifier that received the express dispatch request.

Syntax

def get_location() -> str: ...
def set_location(value: str) -> None: ...

location = property(get_location, set_location)

Default Value

""

Remarks

This property is returned after a call to schedule_pickup and contains the Id of the FedEx location that is scheduled to pick up the package.

When calling cancel_pickup, this property must be supplied for the cancel request to be successful.

manifest Property

Image of the manifest for FedEx Ground shipment activity.

Syntax

def get_manifest() -> bytes: ...

manifest = property(get_manifest, None)

Default Value

""

Remarks

This identifies the buffer containing the ASCII data contents of the manifest report for FedEx Ground shipments.

When the close_ground_shipments method is called, the manifest is returned when the close_tracking_number is present in the request and manifest indicates the manifest containing that tracking number, or when the close_report_type is set to 1 (Manifest). In the last case, this will indicate all manifests from the last 3 days' Closes.

The report is generated in TXT format and saved to disk under close_report_file. The manifest is essential at the time of pickup.

This property is applicable for FedEx Ground services only.

This property is read-only.

master_tracking_number Property

Tracking number assigned to the whole MPS shipment.

Syntax

def get_master_tracking_number() -> str: ...

master_tracking_number = property(get_master_tracking_number, None)

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when either the get_package_label or the get_shipment_labels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the cancel_shipment method is called). It can also be used when tracking a MPS.

This property is read-only.

multiweight_report Property

Image of a multiweight report.

Syntax

def get_multiweight_report() -> bytes: ...

multiweight_report = property(get_multiweight_report, None)

Default Value

""

Remarks

This identifies the buffer containing the multiweight report for FedEx Ground multiweight shipments.

When calling the close_ground_shipments method, the multiweight_report is returned when close_report_type is set to 4 (Multiweight)..

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by close_report_file.

This property is applicable for FedEx Ground services only.

This property is read-only.

notify_count Property

The number of records in the Notify arrays.

Syntax

def get_notify_count() -> int: ...
def set_notify_count(value: int) -> None: ...

notify_count = property(get_notify_count, set_notify_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

notify_aggregate Property

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

def get_notify_aggregate(notify_idx: int) -> str: ...
def set_notify_aggregate(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the shipment_special_services.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

  • a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
  • the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
  • the recipient's email address (via the EMailAddress element). This is required.
  • whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
  • the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
  • the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).
The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

This setting is optional. If notify_aggregate is not set it will be automatically created by the class.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

  • a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
  • the recipient's email address (via the EMailAddress element). This is required.
  • the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
  • the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
  • an optional from name.
  • a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this property does not apply for USPS and CanadaPost.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

notify_email Property

Email address of the recipient to be notified.

Syntax

def get_notify_email(notify_idx: int) -> str: ...
def set_notify_email(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

notify_message Property

User defined text that will be included in the email to be sent to Email .

Syntax

def get_notify_message(notify_idx: int) -> str: ...
def set_notify_message(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

User defined text that will be included in the email to be sent to notify_email. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This property is not used by USPS or Canada Post.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

notify_name Property

The name associated with the notification.

Syntax

def get_notify_name(notify_idx: int) -> str: ...
def set_notify_name(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

The name associated with the notification.

For USPS, this name will appear in the text of the Signature Confirmation e-mail message.

This property is not applicable to FedEx, UPS, or Canada Post.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

notify_flags Property

Identifies the type of notification requested.

Syntax

def get_notify_flags(notify_idx: int) -> int: ...
def set_notify_flags(notify_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

Value Meaning
0x00000001 (On Shipment) An email notification is requested to be sent to the notify_email when the package is shipped.
0x00000002 (On Exception) An email notification should be sent to the notify_email when an exception occurs during package movement from origin to destination.
0x00000004 (On Delivery) An email notification is requested to be sent to the notify_email when the package is delivered.
0x00000008 (On Tender) An email notification is requested to be sent to the notify_email when the package is tendered.
0x00000010 (On Return) An email notification is requested to be sent to the notify_email when the package is returned.
0x00000020 (HTML) The email should be sent in HTML format.
0x00000040 (Text) The email should be sent in Text format.
0x00000080 (Wireless) The email should be sent in Wireless format.
0x00000200 (In Transit) An email notification is requested to be sent to the notify_email when the package is in transit.
0x00000400 (ADL) Alternate Delivery Location
0x00000800 (UAP) UAP Shipper.
0x00001000 (On Estimated Delivery) An email notification is requested to be sent to notify_email when the package was estimated to be delivered.

For FedEx notifications, the following flags apply:

  • On Shipment
  • On Exception
  • On Delivery
  • On Tender
  • On Estimated Delivery
  • HTML
  • Text
To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

For UPS notifications, the following flags apply:

  • On Shipment
  • On Exception
  • On Delivery
  • On Return
  • In Transit
  • ADL
  • UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

notify_type Property

Identifies the set of valid email notification recipient types.

Syntax

def get_notify_type(notify_idx: int) -> int: ...
def set_notify_type(notify_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Identifies the set of valid email notification recipient types. Valid values are:

rtUnspecified (0)
rtRecipient (1)
rtShipper (2)
rtBroker (3)
rtOther (4)
rtThirdParty (5)

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the notify_email specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This property does not apply to UPS or Canada Post notifications.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

origin_address1 Property

Street name.

Syntax

def get_origin_address1() -> str: ...
def set_origin_address1(value: str) -> None: ...

origin_address1 = property(get_origin_address1, set_origin_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 origin_address1 should not exceed 35 characters.

origin_address2 Property

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

Syntax

def get_origin_address2() -> str: ...
def set_origin_address2(value: str) -> None: ...

origin_address2 = property(get_origin_address2, set_origin_address2)

Default Value

""

Remarks

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

origin_address_flags Property

Various flags that denote information about the address.

Syntax

def get_origin_address_flags() -> int: ...
def set_origin_address_flags(value: int) -> None: ...

origin_address_flags = property(get_origin_address_flags, set_origin_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.

origin_city Property

Name of city, town, etc.

Syntax

def get_origin_city() -> str: ...
def set_origin_city(value: str) -> None: ...

origin_city = property(get_origin_city, set_origin_city)

Default Value

""

Remarks

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

origin_country_code Property

Country code.

Syntax

def get_origin_country_code() -> str: ...
def set_origin_country_code(value: str) -> None: ...

origin_country_code = property(get_origin_country_code, set_origin_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

origin_state Property

State or province code.

Syntax

def get_origin_state() -> str: ...
def set_origin_state(value: str) -> None: ...

origin_state = property(get_origin_state, set_origin_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.

origin_zip_code Property

Postal code.

Syntax

def get_origin_zip_code() -> str: ...
def set_origin_zip_code(value: str) -> None: ...

origin_zip_code = property(get_origin_zip_code, set_origin_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 origin_city and origin_state are not present.

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

origin_company Property

Identifies the contact person's company name.

Syntax

def get_origin_company() -> str: ...
def set_origin_company(value: str) -> None: ...

origin_company = property(get_origin_company, set_origin_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either origin_first_name and origin_last_name or origin_company are required to be provided.

origin_email Property

Identifies the contact person's email address.

Syntax

def get_origin_email() -> str: ...
def set_origin_email(value: str) -> None: ...

origin_email = property(get_origin_email, set_origin_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

origin_fax Property

Recipient's fax number.

Syntax

def get_origin_fax() -> str: ...
def set_origin_fax(value: str) -> None: ...

origin_fax = property(get_origin_fax, set_origin_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

origin_first_name Property

Sender's first name.

Syntax

def get_origin_first_name() -> str: ...
def set_origin_first_name(value: str) -> None: ...

origin_first_name = property(get_origin_first_name, set_origin_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either origin_first_name and origin_last_name or origin_company must be sent.

origin_last_name Property

Person's last name.

Syntax

def get_origin_last_name() -> str: ...
def set_origin_last_name(value: str) -> None: ...

origin_last_name = property(get_origin_last_name, set_origin_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either origin_first_name and origin_last_name or origin_company must be sent. Maximum length: 45 characters for both names or company name.

origin_middle_initial Property

Middle initial.

Syntax

def get_origin_middle_initial() -> str: ...
def set_origin_middle_initial(value: str) -> None: ...

origin_middle_initial = property(get_origin_middle_initial, set_origin_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

origin_phone Property

Identifies the contact person's phone number.

Syntax

def get_origin_phone() -> str: ...
def set_origin_phone(value: str) -> None: ...

origin_phone = property(get_origin_phone, set_origin_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

package_location Property

The location of pickup.

Syntax

def get_package_location() -> int: ...
def set_package_location(value: int) -> None: ...

package_location = property(get_package_location, set_package_location)

Default Value

0

Remarks

This property is optional when calling schedule_pickup. The allowed values to be selected are: None, Front, Side, or Rear.

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_base_charge Property

Actual Base Charge applicable to this package.

Syntax

def get_package_base_charge(package_idx: int) -> str: ...

Default Value

""

Remarks

Actual Base Charge applicable to this package.

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

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, indicate the rate for that particular package.

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

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

This is not applicable to USPS.

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

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.

This property is read-only.

package_cod_amount Property

The COD monetary value for the package.

Syntax

def get_package_cod_amount(package_idx: int) -> str: ...
def set_package_cod_amount(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

The COD monetary value for the package.

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

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

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

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

This property is not applicable to USPS packages.

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

This is not applicable 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_cod_file Property

Filename and location to save the CODLabel of this package to.

Syntax

def get_package_cod_file(package_idx: int) -> str: ...
def set_package_cod_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

When the package_cod_file is set to a valid path and filename, the contents of the package_cod_label are written to disk when either the get_package_label or get_shipment_labels method is called.

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

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

This property is only applicable to FedEx shipments.

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_cod_label Property

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

Syntax

def get_package_cod_label(package_idx: int) -> bytes: ...

Default Value

""

Remarks

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

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

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

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

This property is only applicable to FedEx.

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.

This property is read-only.

package_cod_type Property

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

Syntax

def get_package_cod_type(package_idx: int) -> int: ...
def set_package_cod_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

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

Valid values are:

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

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

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

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_dangerous_goods_accessible Property

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

Syntax

def get_package_dangerous_goods_accessible(package_idx: int) -> bool: ...
def set_package_dangerous_goods_accessible(package_idx: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

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

There are two types of dangerous goods:

  • Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The package_dangerous_goods_accessible should be set to True.
  • Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The package_dangerous_goods_accessible should be set to False.
The accessibility type affects the service availability and rates.

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

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_dangerous_goods_options Property

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

Syntax

def get_package_dangerous_goods_options(package_idx: int) -> int: ...
def set_package_dangerous_goods_options(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

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

Note: This is only valid when using FedEx.

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_description Property

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

Syntax

def get_package_description(package_idx: int) -> str: ...
def set_package_description(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

This does not apply for USPS and Canada Post.

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_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_net_charge Property

Actual Net Charge applicable to this package.

Syntax

def get_package_net_charge(package_idx: int) -> str: ...
def set_package_net_charge(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Actual Net Charge applicable to this package.

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

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

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, indicate the rate for that particular package.

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

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

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

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

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

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_reference Property

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

Syntax

def get_package_reference(package_idx: int) -> str: ...
def set_package_reference(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

Valid values for types are:

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

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

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

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

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

Valid values for types are:

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

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

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

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

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

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

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_shipping_label Property

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

Syntax

def get_package_shipping_label(package_idx: int) -> bytes: ...

Default Value

""

Remarks

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

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

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.

This property is read-only.

package_shipping_label_file Property

Filename and location to save the ShippingLabel of this package to.

Syntax

def get_package_shipping_label_file(package_idx: int) -> str: ...
def set_package_shipping_label_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

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

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_total_discount Property

Total Actual Discount applicable to this package.

Syntax

def get_package_total_discount(package_idx: int) -> str: ...

Default Value

""

Remarks

Total Actual Discount applicable to this package.

This is normally specific to the FedEx payor_account_number. It is used in the FedExShip and FedExShipIntl classs only.

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

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, indicate the rate for that particular package.

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

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.

This property is read-only.

package_total_surcharges Property

Total Actual Surcharges applicable to this package.

Syntax

def get_package_total_surcharges(package_idx: int) -> str: ...

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

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

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

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, indicate the rate for that particular package.

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

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

This does not apply to USPS packages.

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

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.

This property is read-only.

package_tracking_number Property

Tracking number assigned to this package.

Syntax

def get_package_tracking_number(package_idx: int) -> str: ...

Default Value

""

Remarks

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

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.

This property is read-only.

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.

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.

recipient_company Property

Identifies the contact person's company name.

Syntax

def get_recipient_company() -> str: ...
def set_recipient_company(value: str) -> None: ...

recipient_company = property(get_recipient_company, set_recipient_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either recipient_first_name and recipient_last_name or recipient_company are required to be provided.

recipient_email Property

Identifies the contact person's email address.

Syntax

def get_recipient_email() -> str: ...
def set_recipient_email(value: str) -> None: ...

recipient_email = property(get_recipient_email, set_recipient_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

recipient_fax Property

Recipient's fax number.

Syntax

def get_recipient_fax() -> str: ...
def set_recipient_fax(value: str) -> None: ...

recipient_fax = property(get_recipient_fax, set_recipient_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

recipient_first_name Property

Sender's first name.

Syntax

def get_recipient_first_name() -> str: ...
def set_recipient_first_name(value: str) -> None: ...

recipient_first_name = property(get_recipient_first_name, set_recipient_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either recipient_first_name and recipient_last_name or recipient_company must be sent.

recipient_last_name Property

Person's last name.

Syntax

def get_recipient_last_name() -> str: ...
def set_recipient_last_name(value: str) -> None: ...

recipient_last_name = property(get_recipient_last_name, set_recipient_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either recipient_first_name and recipient_last_name or recipient_company must be sent. Maximum length: 45 characters for both names or company name.

recipient_middle_initial Property

Middle initial.

Syntax

def get_recipient_middle_initial() -> str: ...
def set_recipient_middle_initial(value: str) -> None: ...

recipient_middle_initial = property(get_recipient_middle_initial, set_recipient_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

recipient_phone Property

Identifies the contact person's phone number.

Syntax

def get_recipient_phone() -> str: ...
def set_recipient_phone(value: str) -> None: ...

recipient_phone = property(get_recipient_phone, set_recipient_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

return_address1 Property

Street name.

Syntax

def get_return_address1() -> str: ...
def set_return_address1(value: str) -> None: ...

return_address1 = property(get_return_address1, set_return_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 return_address1 should not exceed 35 characters.

return_address2 Property

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

Syntax

def get_return_address2() -> str: ...
def set_return_address2(value: str) -> None: ...

return_address2 = property(get_return_address2, set_return_address2)

Default Value

""

Remarks

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

return_address_flags Property

Various flags that denote information about the address.

Syntax

def get_return_address_flags() -> int: ...
def set_return_address_flags(value: int) -> None: ...

return_address_flags = property(get_return_address_flags, set_return_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.

return_city Property

Name of city, town, etc.

Syntax

def get_return_city() -> str: ...
def set_return_city(value: str) -> None: ...

return_city = property(get_return_city, set_return_city)

Default Value

""

Remarks

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

return_country_code Property

Country code.

Syntax

def get_return_country_code() -> str: ...
def set_return_country_code(value: str) -> None: ...

return_country_code = property(get_return_country_code, set_return_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

return_state Property

State or province code.

Syntax

def get_return_state() -> str: ...
def set_return_state(value: str) -> None: ...

return_state = property(get_return_state, set_return_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.

return_zip_code Property

Postal code.

Syntax

def get_return_zip_code() -> str: ...
def set_return_zip_code(value: str) -> None: ...

return_zip_code = property(get_return_zip_code, set_return_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 return_city and return_state are not present.

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

return_company Property

Identifies the contact person's company name.

Syntax

def get_return_company() -> str: ...
def set_return_company(value: str) -> None: ...

return_company = property(get_return_company, set_return_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either return_first_name and return_last_name or return_company are required to be provided.

return_email Property

Identifies the contact person's email address.

Syntax

def get_return_email() -> str: ...
def set_return_email(value: str) -> None: ...

return_email = property(get_return_email, set_return_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

return_fax Property

Recipient's fax number.

Syntax

def get_return_fax() -> str: ...
def set_return_fax(value: str) -> None: ...

return_fax = property(get_return_fax, set_return_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

return_first_name Property

Sender's first name.

Syntax

def get_return_first_name() -> str: ...
def set_return_first_name(value: str) -> None: ...

return_first_name = property(get_return_first_name, set_return_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either return_first_name and return_last_name or return_company must be sent.

return_last_name Property

Person's last name.

Syntax

def get_return_last_name() -> str: ...
def set_return_last_name(value: str) -> None: ...

return_last_name = property(get_return_last_name, set_return_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either return_first_name and return_last_name or return_company must be sent. Maximum length: 45 characters for both names or company name.

return_middle_initial Property

Middle initial.

Syntax

def get_return_middle_initial() -> str: ...
def set_return_middle_initial(value: str) -> None: ...

return_middle_initial = property(get_return_middle_initial, set_return_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

return_phone Property

Identifies the contact person's phone number.

Syntax

def get_return_phone() -> str: ...
def set_return_phone(value: str) -> None: ...

return_phone = property(get_return_phone, set_return_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

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.

sender_company Property

Identifies the contact person's company name.

Syntax

def get_sender_company() -> str: ...
def set_sender_company(value: str) -> None: ...

sender_company = property(get_sender_company, set_sender_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either sender_first_name and sender_last_name or sender_company are required to be provided.

sender_email Property

Identifies the contact person's email address.

Syntax

def get_sender_email() -> str: ...
def set_sender_email(value: str) -> None: ...

sender_email = property(get_sender_email, set_sender_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

sender_fax Property

Recipient's fax number.

Syntax

def get_sender_fax() -> str: ...
def set_sender_fax(value: str) -> None: ...

sender_fax = property(get_sender_fax, set_sender_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

sender_first_name Property

Sender's first name.

Syntax

def get_sender_first_name() -> str: ...
def set_sender_first_name(value: str) -> None: ...

sender_first_name = property(get_sender_first_name, set_sender_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either sender_first_name and sender_last_name or sender_company must be sent.

sender_last_name Property

Person's last name.

Syntax

def get_sender_last_name() -> str: ...
def set_sender_last_name(value: str) -> None: ...

sender_last_name = property(get_sender_last_name, set_sender_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either sender_first_name and sender_last_name or sender_company must be sent. Maximum length: 45 characters for both names or company name.

sender_middle_initial Property

Middle initial.

Syntax

def get_sender_middle_initial() -> str: ...
def set_sender_middle_initial(value: str) -> None: ...

sender_middle_initial = property(get_sender_middle_initial, set_sender_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

sender_phone Property

Identifies the contact person's phone number.

Syntax

def get_sender_phone() -> str: ...
def set_sender_phone(value: str) -> None: ...

sender_phone = property(get_sender_phone, set_sender_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

service_type Property

Identifies the FedEx domestic service to use in a ship request.

Syntax

def get_service_type() -> int: ...
def set_service_type(value: int) -> None: ...

service_type = property(get_service_type, set_service_type)

Default Value

0

Remarks

This property is required to be provided in a ship request. FedEx Ground and FedEx Ground Home Delivery are applicable to FedEx Ground carrier only. All other service types are only applicable to FedEx Express carrier.

Valid values for FedEx are:

stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15) package_type should be set to Your Packaging.
stFedExGroundHomeDelivery (16) available to residential addresses only; package_type should be set to Your Packaging.
stFedEx1DayFreight (17) package_type should be set to Your Packaging.
stFedEx2DayFreight (18) package_type should be set to Your Packaging.
stFedEx3DayFreight (19) package_type should be set to Your Packaging.
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExDistanceDeferred (120)
stFedExNextDayAfternoon (121)
stFedExNextDayEarlyMorning (122)
stFedExNextDayEndOfDay (123)
stFedExNextDayFreight (124)
stFedExNextDayMidMorning (125)
stFedExSameDay (126)
stFedExSameDayCity (127)
stFedExSameDayMetroAfternoon (128)
stFedExSameDayMetroMorning (129)
stFedExSameDayMetroRush (130)
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.

ship_date Property

The date on which the package will be tendered to FedEx.

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

This property is also required to be used for the pickup_availability and schedule_pickup methods. It is used by these methods to tell FedEx when to pickup the packages.

Format: YYYY-MM-DD (e.g. 2024-09-30).

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 in a ship request, you must set the shipment_special_services to a set of flags as listed below:

Value Meaning
0x00000001L Broker Select
0x00000002L Call Before Delivery
0x00000004L COD
0x00000008L Custom Delivery Window
0x00000010L Dangerous Goods
0x00000020L Do Not Break Down Pallets
0x00000040L Do Not Stack Pallets
0x00000080L Dry Ice
0x00000100L East Coast Special
0x00000200L Electronic Trade Documents
0x00000400L Event Notification
0x00000800L Extreme Length
0x00001000L Food
0x00002000L Freight Guarantee
0x00008000L Hold At Location
0x00010000L International Controlled Export Service
0x00020000L Home Delivery Premium
0x00040000L Inside Delivery
0x00080000L Inside Pickup
0x00100000L Liftgate Delivery
0x00200000L Liftgate Pickup
0x00400000L Limited Access Delivery
0x00800000L Limited Access Pickup
0x01000000L Pending Shipment
0x02000000L Poison
0x04000000L Protection From Freezing
0x08000000L Return shipment
0x10000000L Saturday Delivery
0x20000000L Saturday Pickup
0x40000000L Top Load
0x10000000000L International Traffic in Arms Regulations
0x0080000000000000LOneRate

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

  • COD: Indicates that this is a COD shipment. 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 COD details must be provided on the Package level.
  • Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested (i.e., when the corresponding Dry Ice flag is contained in the shipment_special_services), then the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). This is allowed for FedEx Express shipments only.
  • 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.
  • Hold At Location: This is applicable for FedEx Express services only. 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, and when the recipient_address_flags is set to Residential (i.e., for residential delivery). When this service is requested (i.e., when the corresponding Hold At Location flag is contained in the shipment_special_services), then the hold_at_location is required to be provided in the request as well.
  • Home Delivery: Indicates that the Home Delivery Premium special service is requested. This is applicable for residential delivery only (i.e., when this is present in the request, the recipient_address_flags is automatically set to Residential in the request). If service_type is set to GROUND HOME DELIVERY, the corresponding flag of Home Delivery is automatically added to the shipment_special_services. In this case, the home_delivery_date, home_delivery_phone, and home_delivery_type properties are required to be provided in the request as well. This property is applicable for FedEx Ground services only.
  • 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. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
  • 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. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
  • Pending Shipment Indicates that an email label has been requested. When this option is selected, you will need to also set the notify property to specify the email address to send to and the message to be sent. You will also need to set the MerchantPhoneNumber and EmailLabelExpirationDate configuration settings. When this option is selected a label will not be saved to the location in package_shipping_label_file, as the label will now be emailed to the recipient(s) specified in notify_email
  • Return Shipment: Indicates that the return label is requested. This might affect the shipping rates and/or service availability. In this case, the RMANumber and RMAReason can be provided in the request. When this option is selected, the return label will be returned in the server response. The recipient can then apply this return label to the return package as needed and drop the package off at a FedEx drop off location. No charges are assessed until the label is used. Express and Ground return labels are interchangeable, regardless of the original shipping service. For example, you can send the original shipment using an express service, but include a Ground return label as part of your packing documents. Express/Ground Return Labels are available for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Ground, FedEx Home Delivery, FedEx 2Day Freight, and FedEx 3Day Freight throughout the 50 United States. FedEx Express Saver and FedEx 1Day Freight services are not available. Also, Dangerous Goods and Hazardous Materials cannot be shipped. Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location. The maximum declared value is $1,000 for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, and FedEx 2Day. The maximum declared value is $50,000 for FedEx 2Day Freight and FedEx 3Day Freight. The maximum declared value is $100 for FedEx Ground and FedEx Home Delivery.
  • Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and you want Saturday delivery, the ground option and some express option will not be valid.
  • Saturday Pickup: Indicates that you request to have the shipment picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. 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 you want Saturday pickup, the ground option and some express option will not be valid.
  • ThirdParty Consignee: Indicates that the third party special service is requested. This might affect the shipping rates and/or service availability.
  • 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.

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

  • East Coast Special: Indicates that East Coast special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.
  • 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.
  • 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.
  • FedEx One Rate Shipping Indicates that FedEx One Rate packaging is being used. This is only applicable for when using a U.S. origin and destination, excluding Hawaii. Valid service types are listed below as both the :
    ServiceType FedEx Service
    stFedExPriorityOvernight (10) PRIORITY_OVERNIGHT
    stFedExStandardOvernight (11) STANDARD_OVERNIGHT
    stFedExFirstOvernight (12) FIRST_OVERNIGHT
    stFedExExpressSaver (14) FEDEX_EXPRESS_SAVER
    stFedEx2Day (13) FEDEX_2_DAY
    stFedEx2DayAM (27) FEDEX_2_DAY_AM

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_net_charge Property

The total net charge applied to the whole shipment (specific to the AccountNumber ).

Syntax

def get_total_net_charge() -> str: ...

total_net_charge = property(get_total_net_charge, None)

Default Value

""

Remarks

In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as package_net_charge at index=0.

This property is read-only.

total_weight Property

Total shipment weight.

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

Identifies the total weight of the shipment being conveyed to FedEx. This element is optional when submitting a ship request. It requires one explicit decimal position (i.e. N.N formatting).

transit_time Property

Expected number of days in transit from pickup to delivery.

Syntax

def get_transit_time() -> str: ...

transit_time = property(get_transit_time, None)

Default Value

""

Remarks

This is an estimate only. When either the get_package_label or get_shipment_labels method is called, the delivery_date will be returned in the server reply. For international shipments, this information is a limited to a number of international countries and it depends on the customs clearance times.

Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN.

This property is read-only.

cancel_package Method

Cancels a single package shipment by deleting it from the shipping log.

Syntax

def cancel_package(tracking_number: str) -> None: ...

Remarks

Cancels FedEx Express and Ground package that have not already been tendered to FedEx.

The TrackingNumber parameter, that identifies the package to be canceled and deleted from the shipping log, is the package_tracking_number assigned to the package by FedEx server when either the get_package_label or the get_shipment_labels method was called.

The following properties can be set prior to calling this method:

To check the status of your cancel request the CancelledShipment config should be inspected.

cancel_pickup Method

Cancels a scheduled Carrier Pickup request.

Syntax

def cancel_pickup(confirmation_number: str) -> str: ...

Remarks

When the CancelPickup method is called, the exact data from the original SchedulePickup request must be entered.

You must enter the following information:

Valid CarrierType values are FDXG (FedEx Ground) or FDXE (FedEx Express).

If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from FedEx about the request to cancel the pickup, if one exists.

cancel_shipment Method

Cancels all packages within the shipment.

Syntax

def cancel_shipment(tracking_number: str) -> None: ...

Remarks

Cancels FedEx Express and Ground shipments that have not already been tendered to FedEx.

The TrackingNumber parameter, that identifies the shipment to be canceled and deleted from the shipping log, is assigned by FedEx server when either the get_package_label or get_shipment_labels method was called.

The following properties can be set prior to calling this method:

To check the status of your cancel request the CancelledShipment config should be inspected.

close_ground_shipments Method

Closes out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.

Syntax

def close_ground_shipments() -> None: ...

Remarks

Closing is a function to be used for FedEx Ground shipments only. Express shipments are automatically closed and do not require you to perform a specific close operation. The Close service allows you to reconcile shipping information for your Ground shipments and print a Ground Manifest for your Ground driver.

At the end of the shipping day, you should perform the FedEx Ground End of Day Close procedure. To do so, call the close_ground_shipments method. The Ground manifest (manifest stored in close_report_file) is generated after a successful close and must be printed before your Ground shipments are tendered to FedEx. This is required to be tendered to FedEx along with your packages if they are being picked up by FedEx Ground. If you are dropping the packages off at a FedEx drop-off location, the manifest is not required.

You may continue to ship Ground packages after a Close has been performed. The Close service may be performed multiple times during your shipping day. Use the Close service to initiate the final stage of processing all shipment data submitted for the day (close of business).

A customer cannot cancel any shipments once they are closed out. However, shipments can be added to a day's shipment after a close operation has been performed and multiple closes can be performed in a day.

When this method is called, the following properties must have been set:

close_report_type specifies the type of report. Only one type of report can be returned per Close request. If you need multiple report types you will have to issue multiple close_ground_shipments requests.

The report will automatically be written to the file specified by close_report_file. These reports can be printed anytime during the shipping day for shipments that have already been closed (up to three days in the past).

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_package_label Method

Generates a shipping label for the specified package.

Syntax

def get_package_label(index: int) -> None: ...

Remarks

When this method is called, the following properties must have been set:

When shipping via FedEx Ground then the package_type should be set to ptYourPackaging.

This method fills in the following properties:

To print out the package_shipping_label, you can save it to the package_shipping_label_file file in label_image_type format.

get_shipment_labels Method

Generates a shipping label for all packages in the shipment.

Syntax

def get_shipment_labels() -> None: ...

Remarks

When this method is called, the following properties must have been set:

When shipping via FedEx Ground then the package_type should be set to ptYourPackaging.

This method fills in the following properties:

To print out the package_shipping_label, you can save it to the package_shipping_label_file file in label_image_type format.

pickup_availability Method

Checks the availability of the courier dispatch service for the given address.

Syntax

def pickup_availability() -> None: ...

Remarks

The PickupAvailability method requires the values for the following properties:

Valid values for CarrierType are FDXE (FedEx Express) or FDXG (FedEx Ground).

The packages property may optionally be populated with dimensions such as package_length, package_width, and package_height.

If the Carrier Pickup service is available to the supplied address, the following properties will be returned. These properties indicate the earliest available pickup date and the carrier that will be picking up your packages:

reprint_documents Method

Reprints the requested document.

Syntax

def reprint_documents() -> None: ...

Remarks

When called this will request the document type specified in close_report_type for the specified.

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.

schedule_pickup Method

This method schedules a courier pickup.

Syntax

def schedule_pickup() -> str: ...

Remarks

Schedules a courier pickup and returns a confirmation number for the scheduled pickup.

The following properties are applicable:

If the courier pickup service is available for the supplied address, the confirmation number will be returned by this method. The location property will also be populated.

Prior to making a SchedulePickup call, it is recommended to first call the pickup_availability method to confirm that the pickup service is available.

on_error Event

Information about errors during data delivery.

Syntax

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

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

# In class FedExShip:
@property
def on_error() -> Callable[[FedExShipErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FedExShipErrorEventParams], 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 FedExShipNotificationEventParams(object):
  @property
  def message() -> str: ...

# In class FedExShip:
@property
def on_notification() -> Callable[[FedExShipNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[FedExShipNotificationEventParams], 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 FedExShipSSLServerAuthenticationEventParams(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 FedExShip:
@property
def on_ssl_server_authentication() -> Callable[[FedExShipSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FedExShipSSLServerAuthenticationEventParams], 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 FedExShipSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

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

FedExShip Config Settings

AccessTime:   Time window for FedEx to pickup up the package.

This is returned after a call to pickup_availability, and contains the window of time in which FedEx requires for pickup. The difference between the package ready time (ShipTime) and the company_close_time must be equal to or greater than this amount of time. This value may vary depending on location.

BlockVisibility:   Whether the visibility of this shipment should be blocked from parties other than shipper/payor.

If True, only the shipper/payor will have visibility of this shipment.

BookingNumber:   Booking confirmation number.

This is applicable when using any of the FedEx Express domestic (U.S.) freight services: FedEx 1Day Freight, FedEx 2Day Freight and FedEx 3Day Freight. (i.e., when the service_type is set to ST_FEDEX1DAYFREIGHT, ST_FEDEX2DAYFREIGHT or ST_FEDEX3DAYFREIGHT).

An advance booking number is required for FedEx Express 1Day Freight. When you call 1.800.332.0807 to book your freight shipment, you will receive a booking number. This booking number must be included in the ship request, and prints on the shipping label.

Values must be 8-12 characters in length.

CancelledShipment:   Indicates whether the shipment has been cancelled or not.

This read only configuration setting is populated from the server when cancel_shipment or cancel_package methods are called. If the value is True, then it indicates that the shipment has been cancelled.

CODRecipientAddress1:   The primary street address of the COD recipient.

This specifies the primary address of the COD Recipient, which will be printed on the COD label. Street name of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Combination of CODRecipientAddress1 and CODRecipientAddress2 should not exceed 35 characters.

CODRecipientAddress1:   The primary street address of the COD recipient.

This specifies the primary address of the COD Recipient, which will be printed on the COD label. Street name of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Combination of CODRecipientAddress1 and CODRecipientAddress2 should not exceed 35 characters.

CODRecipientAddress2:   The secondary street address of the COD recipient.

This specifies the secondary address of the COD Recipient, which will be printed on the COD label. A specific detail on the COD recipient's address (such as building, suite, apartment, floor number etc.).

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Combination of CODRecipientAddress1 and CODRecipientAddress2 should not exceed 35 characters.

CODRecipientAddress2:   The secondary street address of the COD recipient.

This specifies the secondary address of the COD Recipient, which will be printed on the COD label. A specific detail on the COD recipient's address (such as building, suite, apartment, floor number etc.).

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Combination of CODRecipientAddress1 and CODRecipientAddress2 should not exceed 35 characters.

CODRecipientCity:   The city of the COD recipient.

This specifies the city of the COD Recipient, which will be printed on the COD label. Name of city, town, etc. of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: for Express is 35, for Ground is 20.

CODRecipientCity:   The city of the COD recipient.

This specifies the city of the COD Recipient, which will be printed on the COD label. Name of city, town, etc. of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: for Express is 35, for Ground is 20.

CODRecipientCompany:   The company of the COD recipient.

This specifies the company of the COD Recipient, which will be printed on the COD label. Company name of the COD recipient.

Either CODRecipientName or CODRecipientCompany is required to be provided in a COD shipping request. The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientCompany:   The company of the COD recipient.

This specifies the company of the COD Recipient, which will be printed on the COD label. Company name of the COD recipient.

Either CODRecipientName or CODRecipientCompany is required to be provided in a COD shipping request. The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientCountryCode:   The country code of the COD recipient.

This specifies the country code of the COD Recipient, which will be printed on the COD label. Country code of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: 2.

CODRecipientCountryCode:   The country code of the COD recipient.

This specifies the country code of the COD Recipient, which will be printed on the COD label. Country code of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: 2.

CODRecipientName:   The name of the COD recipient.

This specifies the name of the COD Recipient, which will be printed on the COD label. Name of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientName:   The name of the COD recipient.

This specifies the name of the COD Recipient, which will be printed on the COD label. Name of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientPhone:   The phone number of the COD recipient.

This specifies the phone number of the COD Recipient, which will be printed on the COD label. Phone number of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientPhone:   The phone number of the COD recipient.

This specifies the phone number of the COD Recipient, which will be printed on the COD label. Phone number of the COD recipient.

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientResidential:   The residential status of the COD recipient.

This indicates whether the COD recipient is a residential address. Indicates whether the COD recipient address is residential (as opposed to commercial).

If False, the address will be considered as commercial by FedEx server. The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientResidential:   The residential status of the COD recipient.

This indicates whether the COD recipient is a residential address. Indicates whether the COD recipient address is residential (as opposed to commercial).

If False, the address will be considered as commercial by FedEx server. The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientState:   The state of the COD recipient.

This specifies the state of the COD Recipient, which will be printed on the COD label. State or province code of the COD recipient.

This is the identifying abbreviation for US state, Canada province, etc. The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: 14.

CODRecipientState:   The state of the COD recipient.

This specifies the state of the COD Recipient, which will be printed on the COD label. State or province code of the COD recipient.

This is the identifying abbreviation for US state, Canada province, etc. The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: 14.

CODRecipientZipCode:   The zip code of the COD recipient.

This specifies the zip code of the COD Recipient, which will be printed on the COD label. Postal code of the COD recipient.

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

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

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

CODRecipientZipCode:   The zip code of the COD recipient.

This specifies the zip code of the COD Recipient, which will be printed on the COD label. Postal code of the COD recipient.

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

The COD return label uses your sender information (sender_contact and sender_address as the recipient for the COD payment. Use this configuration to override the behavior.

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

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

CODTrackingNumber:   The COD Tracking Number.

When shipping COD via any of the domestic FedEx Express services, this is returned in the server response. This value can then be used to track the COD return package. It is read-only.

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.

CutoffTime:   Latest pickup time.

This is returned after a call to pickup_availability, and will contain the latest time the package can be picked up at the given address.

DeliveryDay:   Day of the week on which shipment is expected to be delivered.

When either the get_package_label or get_shipment_labels method is called, the DeliveryDay will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

DeliveryInstructions:   Delivery instructions.

Used with Ground Home Delivery and Freight services.

DocTabContent:   Custom DocTab content set by the user when preparing a shipping label.

This is applicable to thermal labels with DocTab only.

If provided, thermal labels will include specified doc tab content. If omitted, label will be produced without the doc tab content. This field, if used, should be specified as a JSON.

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.

EmailLabelExpirationDate:   Email label's expiration date.

This must be set if Pending Shipments is set in shipment_special_services. The maximum expiration date must be greater or equal to the day of the label request and not greater than 30 days in the future. The date's format should be YYYY-MM-DD.

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.

FreightAccountNumber:   Account number used with the FedEx Freight service.

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.

FreightAlternateBillingAccountNumber:   The alternate account number to be billed.

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.

FreightAlternateBillingCity:   The city of the party to be billed.

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.

FreightAlternateBillingCompanyName:   The name of the company to be billed.

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.

FreightAlternateBillingCountryCode:   The country code of the party to be billed.

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.

FreightAlternateBillingPersonName:   The name of the person to be billed.

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.

FreightAlternateBillingPhone:   The phone of the party to be billed.

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.

FreightAlternateBillingState:   The state of the party to be billed.

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.

FreightAlternateBillingStreetAddress:   The street address line of the party to be billed.

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.

FreightAlternateBillingZipCode:   The zip code of the party to be billed.

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.

FreightBillingAddress1:   The first address line of the party to be billed.

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.

FreightBillingAddress2:   The second address line of the party to be billed.

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.

FreightBillingCity:   The city of the party to be billed.

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.

FreightBillingCompanyName:   The name of the company to be billed.

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.

FreightBillingCountryCode:   The country code of the party to be billed.

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.

FreightBillingEmail:   The email of the party to be billed.

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.

FreightBillingFax:   The fax number of the party to be billed.

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.

FreightBillingPersonName:   The name of the person to be billed.

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.

FreightBillingPhone:   The phone number of the party to be billed.

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.

FreightBillingState:   The state of the party to be billed.

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.

FreightBillingZipCode:   The zip code of the party to be billed.

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.

FreightClientDiscountPercent:   Estimated discount rate provided by client for unsecured rate quote.

The estimated client discount rate for a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightCollectTermsType:   The terms of the collect payment for a Freight Shipment.

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.

FreightComment:   Description for the shipment.

The description for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightDeclaredValue:   The declared value for the shipment.

The total declared value per unit for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightDeclaredValueUnits:   The declared value units.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightHazardousMaterialsOfferor:   The offeror of the hazardous materials.

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.

FreightItemClass[i]:   The class of the freight item.

This should be set to the freight class for this item.

The valid values are as follows:

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

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemCount:   The number of freight items.

This contains the number of commodity items in the freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemDescription[i]:   The description for the specified freight item.

This should contain a description of what the freight item is.

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemHeight[i]:   The height of the specified freight item.

This should contain the height of the freight item.

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemLength[i]:   The length of the specified freight item.

This should contain the length of the freight item.

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemPackagingType[i]:   The packaging type for the specified freight item.

The physical packaging type for this freight item.

The valid values are as follows:

Value Meaning
0 Bag
2 Barrel
3 Bundle
5 Box
6 Basket
11 Case
13 Container
14 Crate
16 Carton
17 Cylinder
18 Drum
20 Other
21 Pail
22 Piece
25 Pallet
27 Reel
28 Roll
29 Skid
31 Tube
32 Tank
36 Bucket
37 Envelope
38 Hamper

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemVolume[i]:   Volume of the specified freight item.

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.

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemWeight[i]:   The weight of the specified freight item.

This should contain the total weight of the freight item.

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightItemWidth[i]:   The width of the specified freight item.

This should contain the width of the freight item.

Valid array indices are from 0 to FreightItemCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightLiabilityCoverageAmount:   The total amount of liability coverage.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightLiabilityCoverageType:   The type of liability coverage offered.

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.

FreightPalletWeight:   Total weight of pallets used in shipment.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightRole:   Indicates the role of the party submitting the transaction.

This indicates which 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.

FreightShipmentHeight:   The overall height of the shipment.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightShipmentLength:   The overall length of the shipment.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightShipmentWidth:   The overall width of the shipment.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightTotalHandlingUnits:   The total handling units for the shipment.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

LabelFormatType:   Indicates the type of label to be returned.

This element is required when either the get_package_label or get_shipment_labels method is called.

Valid values are:

Value Description
0 Common 2D
1 Label Data Only
2 Freight Straight Bill of Lading
3 VICS Bill of Lading

LabelOrientationType:   Indicates if the top or bottom of the label comes out of the printer.

This setting is applicable only to documents produced on thermal printers with roll stock. Valid printing orientation types are:

Value Description
0 Top Edge of Text First
1 Bottom Edge of Text First
LabelStockType:   Indicates the size of the label and the location of the doc tab if present.

All 'Paper *' items should be used when a laser printer is being used to print the generated label file (ie. LabelImageType is set to fitPDF or fitPNG).

All 'Stock *' items should be used when a thermal printer is being used to print the generated label file (ie. LabelImageType is set to fitEltron, fitZebra or fitUniMark).

By Default, 0 (Paper 4x6) will be used when LabelImageType is set to fitPDF or fitPNG. However if LabelImageType is set to fitEltron, fitZebra or fitUniMark, the default is 2 (Stock 4x6). If an invalid value is passed, the default value for the LabelImageType you are using will be used.

Valid label stock types are:

Value Description
0 Paper 4x6
1 Paper 7x4.75
2 Stock 4x6
3 Stock 4x6.75 Leading Doc Tab
4 Stock 4x8
5 Stock 4x9 Leading Doc Tab
6 Paper 4x8
7 Paper 4x9
8 Paper 8.5x11 Bottom Half Label
9 Paper 8.5x11 Top Half Label
10 Stock 4x6.75 Trailing Doc Tab
11 Stock 4x9 Trailing Doc Tab
12 Paper Letter
13 Paper 4x6.75
14 Stock 4x9
15 Stock 4x8.5 Trailing Doc Tab
16 Stock 4x10.5 Trailing Doc Tab

ListTotalNetCharge[i]:   Total net charge for list rates applied at package level at index i (if applicable).

This returns the list-based rates.

Valid array indices are from 0 to Packages.Count - 1. This setting is read-only.

MaskedData:   Specifies which data/sections to be masked on the shipping label.

Use this config to specify which data/sections on the shipping label to be masked. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

ValueDescription
0x0001 Customs Value
0x0002 Dimensions
0x0004 Duties and Taxes Payor Account Number
0x0008 Insured Value
0x0010 Secondary Barcode
0x0020 Shipper Information
0x0040 Terms and Conditions
0x0080 Total Weight
0x0100 Transportation Charges Payor Account Number
MerchantPhoneNumber:   The merchant's phone number.

This must be set if Pending Shipments is set in shipment_special_services. Include the phone number for the merchant, such as a general customer service phone number.

Overwrite:   Determines whether label files will be overwritten.

If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist.

PackageAlcoholRecipientType[i]:   The type of recipient for an Alcohol Special Service package.

When setting a package's Special Service to Alcohol (0x00000100), this configuration setting should be used to specify the type of recipient for that package.

The applicable values are:

0Consumer (Default)
1Licensee

Valid array indices are from 0 to Packages.Count - 1.

PackageCount:   The number of packages to be picked up.

If set this will be used to specify the number of packages to be picked up during a schedule_pickup request.

PackageDocumentFile:   The file path for the additional package documents.

When package documents are received from FedEx, they will be put in the filepath specified in the following format:

<Base Filename>_<Document Type><Document Number>.<extension>

So if the path "C:\packageDoc.png" is specified and you receive an auxiliary label, the file "C:\packageDoc_AUXILIARY_LABEL1.png" will be created.

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.

PackageRatingAggregate[i]:   String representing the rating detail on package level (at index i).

Valid array indices are from 0 to Packages.Count - 1. This setting is read-only.

PayorPhone:   Payor's phone number.

This setting represents the PhoneNumber of the Payor when using the following PayorType values:

  • ptCollect
  • ptConsignee
  • ptThirdParty

Note: If the PayorType is ptSender or ptRecipient, the component will use SenderContact.Phone or RecipientContact.Phone, respectively.

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.

RMANumber:   The RMA number.

The RMA number associated with the return shipment. This is an alpha-numeric value up to 20 characters in length.

RMAReason:   The RMA reason description.

This is optional to be provided when the ReturnShipment special service is requested and applicable only if the RMANumber was provided. This element allows you to enter up to 60 alpha-numeric characters.

ShipmentRatingAggregate:   String representing the rating detail on shipment level.

Upon a successful ship request, the shipment rating is returned in the server response only if the payor_type is set to 0 (SENDER). This will be stored as a string in the ShipmentRatingAggregate, formatted as XML. This setting is read-only.

ShipTime:   Local Time of shipment based on shipper's time zone.

This config is used in combination with ship_date property. Together, these identify the date and time the package is tendered to FedEx. This is optional to be entered in the ship request. If not provided, defaults to the current U.S. Central Standard Time. Format: HH:MM:SS using a 24 hour clock (e.g. 11:00 a.m. is 11:00:00, whereas 5:00 p.m. is 17:00:00).

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

SmartPostTrackingNumbers:   Contains the tracking numbers for a FedEx SmartPost shipment.

This config contains all the available tracking numbers for a FedEx SmartPost shipment. This will return the tracking numbers as a comma separated string in the form: [TrackingIdType]=[TrackingNumber]

An example of a possible value is: USPS=12345,GROUND=67890

SpecialInstructions:   Special instructions for the courier.

Set this when calling schedule_pickup to add any additional remarks that the courier may need when picking up the packages. This is required when canceling a pickup with FedEx Ground.

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.

UseAccountAddress:   Whether or not the pickup should be sent to the address associated with the account.

Set this to true to tell FedEx to use the address associated with the sender account to pickup the packages when calling schedule_pickup. By default, this value is false, and the address for pickup will be specified by the sender_address.

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.

FedExShip Errors

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