FedExFreightShip Class
Properties Methods Events Config Settings Errors
Allows you to generate a FedEx shipping label for any of FedEx freight services complete with addresses and barcode, or cancel a shipment.
Syntax
class dshippingsdk.FedExFreightShip
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 Location, 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.
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.
approved_by_company | Identifies the contact person's company name. |
approved_by_email | Identifies the contact person's email address. |
approved_by_fax | Recipient's fax number. |
approved_by_first_name | Sender's first name. |
approved_by_last_name | Person's last name. |
approved_by_middle_initial | Middle initial. |
approved_by_phone | Identifies the contact person's phone number. |
broker_address1 | Street name. |
broker_address2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
broker_address_flags | Various flags that denote information about the address. |
broker_city | Name of city, town, etc. |
broker_country_code | Country code. |
broker_state | State or province code. |
broker_zip_code | Postal code. |
broker_company | Identifies the contact person's company name. |
broker_email | Identifies the contact person's email address. |
broker_fax | Recipient's fax number. |
broker_first_name | Sender's first name. |
broker_last_name | Person's last name. |
broker_middle_initial | Middle initial. |
broker_phone | Identifies the contact person's phone number. |
broker_type | Identifies the broker type. |
carrier_type | The carrier type. |
clearance_brokerage_type | Specifies the type of brokerage to be applied to a shipment. |
cod_label | The label that is returned. |
cod_label_file | The file the COD label should be written to. |
cod_total_amount | The total amount to be collected on delivery. |
cod_tracking_number | Contains the tracking number for the COD return shipment. |
cod_type | COD type. |
commercial_invoice_comments | Commercial Invoice comments to be uploaded to customs. |
commercial_invoice_freight_charge | Cost to transport the shipment. |
commercial_invoice_insurance | The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. |
commercial_invoice_number | Customer's assigned invoice number. |
commercial_invoice_purpose | Reason to export the current international shipment Required for dutiable international express or ground shipment. |
commercial_invoice_terms | Indicates the rights to the seller from the buyer. |
commodity_count | The number of records in the Commodity arrays. |
commodity_description | Complete and accurate description of this commodity line item. |
commodity_freight_class | Indicates the freight class of the commodity. |
commodity_freight_packaging_type | Identifies the Commodity item's packaging type. |
commodity_handling_units | Number of individual handling units to which this commodity applies. |
commodity_harmonized_code | Unique code representing this commodity line item (for imports only). |
commodity_hazardous_materials_options | Indicates the kind of hazardous material content in this commodity. |
commodity_height | The height of the commodity. |
commodity_id | A unique identifier assigned to this line item. |
commodity_length | The width of the commodity. |
commodity_manufacturer | Country code where the contents of this commodity line were produced, manufactured or grown in their final form. |
commodity_nmfc_code | NMFC Code for commodity. |
commodity_number_of_pieces | The total number of packages, cartons, or containers for the commodity line item. |
commodity_part_number | The part number of this commodity line item. |
commodity_po_number | The PO Number for printed reference per commodity. |
commodity_quantity | Number of units contained in this commodity line item measured in units specified by the QuantityUnit . |
commodity_quantity_unit | Unit of measure used to express the Quantity of this commodity line item. |
commodity_unit_price | Value of each QuantityUnit in Quantity of this commodity line item. |
commodity_value | The value of an individual item being shipped. |
commodity_volume | This should contain the volume of the freight item. |
commodity_weight | The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. |
commodity_width | The width of the commodity. |
company_close_time | The time your company closes. |
delivery_date | Date on which shipment is expected to be delivered. |
duties_payor_account_number | The account number of the party responsible for payment (shipping charges, or duties and taxes). |
duties_payor_country_code | The country code for the payor of the shipment, or duties and taxes. |
duties_payor_type | Method of payment for shipment, or duties and taxes. |
fed_ex_account_number | The account number associated with the shipment. |
fed_ex_authorization_token | Authorization Token used to authenticate the request. |
fed_ex_language_code | Two-letter code for the language (e. |
fed_ex_locale_code | Two-letter code for the region (e. |
fed_ex_server | URL for the FedEx Server where the requests are sent. |
firewall_auto_detect | Whether to automatically detect and use firewall system settings, if available. |
firewall_type | The type of firewall to connect through. |
firewall_host | The name or IP address of the firewall (optional). |
firewall_password | A password if authentication is to be used when connecting through the firewall. |
firewall_port | The Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | A username if authentication is to be used when connecting through a firewall. |
freight_guarantee_date | The date the freight shipment is guaranteed for. |
freight_guarantee_type | Specifies what type of freight guarantee is requested. |
hold_at_location_address1 | Street name. |
hold_at_location_address2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
hold_at_location_city | Name of city, town, etc. |
hold_at_location_country_code | Country code. |
hold_at_location_state | State or province code. |
hold_at_location_zip_code | Postal code. |
hold_at_location_contact_company | Identifies the contact person's company name. |
hold_at_location_contact_email | Identifies the contact person's email address. |
hold_at_location_contact_fax | Recipient's fax number. |
hold_at_location_contact_first_name | Sender's first name. |
hold_at_location_contact_last_name | Person's last name. |
hold_at_location_contact_middle_initial | Middle initial. |
hold_at_location_contact_phone | Identifies the contact person's phone number. |
hold_at_location_phone | Phone number of the FedEx location where the shipment will be hold at. |
insured_value | Total insured amount. |
intl_export_controlled_export_type | The controlled export type. |
intl_export_entry_number | The entry number for the controlled export. |
intl_export_foreign_trade_zone_code | The foreign trade zone code. |
intl_export_license_number | The license or permit number. |
intl_export_license_number_expiration | The license or permit number expiration date. |
label_image_type | Type of image or printer commands the label is to be formatted in. |
location | The FedEx location identifier that received the express dispatch request. |
master_tracking_number | Tracking number assigned to the whole MPS shipment. |
notify_count | The number of records in the Notify arrays. |
notify_aggregate | This can be used to set the entire aggregate xml for the recipient to be notified. |
notify_email | Email address of the recipient to be notified. |
notify_message | User defined text that will be included in the email to be sent to Email . |
notify_name | The name associated with the notification. |
notify_flags | Identifies the type of notification requested. |
notify_type | Identifies the set of valid email notification recipient types. |
package_location | The location of pickup. |
package_count | The number of records in the Package arrays. |
package_base_charge | Actual Base Charge applicable to this package. |
package_dangerous_goods_accessible | Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery. |
package_dangerous_goods_options | Contains the collection of options will be used on the package level when using dangerous goods. |
package_description | For FedEx, this is the description that appears in the email to identify this package. |
package_height | The height of the package to be shipped. |
package_id | An 8-digit Unique Parcel Identification Number. |
package_insured_value | Amount of insurance requested for this package. |
package_length | The length of the package to be shipped. |
package_net_charge | Actual Net Charge applicable to this package. |
package_type | The packaging type of the package being rated and/or shipped. |
package_reference | Indicates the package reference type and value, that associates this package (assigned by the customer). |
package_shipping_label | Image of the shipping label for this package returned by the Server upon a successful ship response. |
package_shipping_label_file | Filename and location to save the ShippingLabel of this package to. |
package_signature_type | Specifies one of the Delivery Signature Options requested for this package. |
package_special_services | Contains the collection of special services offered on the package level. |
package_total_discount | Total Actual Discount applicable to this package. |
package_total_surcharges | Total Actual Surcharges applicable to this package. |
package_tracking_number | Tracking number assigned to this package. |
package_weight | Weight of this package. |
package_width | The width of the package to be shipped. |
payor_account_number | The account number of the party responsible for payment (shipping charges, or duties and taxes). |
payor_address1 | Street name. |
payor_address2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
payor_city | Name of city, town, etc. |
payor_country_code | The country code for the payor of the shipment, or duties and taxes. |
payor_name | Identifies the payor's name. |
payor_type | Method of payment for shipment, or duties and taxes. |
payor_state | State or province code. |
payor_zip_code | Payor's postal code (if applicable). |
pickup_payment_type | The payment type for the pickup. |
pickup_type | Pickup type used for the shipment that rate is requested for. |
proxy_auth_scheme | The type of authorization to perform when connecting to the proxy. |
proxy_auto_detect | Whether to automatically detect and use proxy system settings, if available. |
proxy_password | A password if authentication is to be used for the proxy. |
proxy_port | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
proxy_ssl | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | A username if authentication is to be used for the proxy. |
recipient_address1 | Street name. |
recipient_address2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
recipient_address_flags | Various flags that denote information about the address. |
recipient_city | Name of city, town, etc. |
recipient_country_code | Country code. |
recipient_state | State or province code. |
recipient_zip_code | Postal code. |
recipient_company | Identifies the contact person's company name. |
recipient_email | Identifies the contact person's email address. |
recipient_fax | Recipient's fax number. |
recipient_first_name | Sender's first name. |
recipient_last_name | Person's last name. |
recipient_middle_initial | Middle initial. |
recipient_phone | Identifies the contact person's phone number. |
requested_etd_documents | Specifies which document type to request copies of when using Electronic Trade Document Special Service. |
return_address1 | Street name. |
return_address2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
return_address_flags | Various flags that denote information about the address. |
return_city | Name of city, town, etc. |
return_country_code | Country code. |
return_state | State or province code. |
return_zip_code | Postal code. |
return_company | Identifies the contact person's company name. |
return_email | Identifies the contact person's email address. |
return_fax | Recipient's fax number. |
return_first_name | Sender's first name. |
return_last_name | Person's last name. |
return_middle_initial | Middle initial. |
return_phone | Identifies the contact person's phone number. |
sender_address1 | Street name. |
sender_address2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
sender_address_flags | Various flags that denote information about the address. |
sender_city | Name of city, town, etc. |
sender_country_code | Country code. |
sender_state | State or province code. |
sender_zip_code | Postal code. |
sender_company | Identifies the contact person's company name. |
sender_email | Identifies the contact person's email address. |
sender_fax | Recipient's fax number. |
sender_first_name | Sender's first name. |
sender_last_name | Person's last name. |
sender_middle_initial | Middle initial. |
sender_phone | Identifies the contact person's phone number. |
service_type | Identifies the FedEx domestic service to use in a ship request. |
ship_date | The date on which the package will be tendered to FedEx. |
shipment_info_account_number | This is the account number to be used with a freight shipment. |
shipment_info_alternate_billing_account_number | This should be set to the alternate account number to be billed. |
shipment_info_alternate_billing_city | This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_company_name | This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_country_code | This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_person_name | This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_phone | This should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_state | This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_street_address | This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_alternate_billing_zip_code | This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber . |
shipment_info_billing_address1 | This should be set to the first address line listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_address2 | This should be set to the second address line listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_city | This should be set to the city listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_company_name | This should be set to the name of the company listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_country_code | This should be set to the country code listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_email | This should be set to the email address listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_fax | This should be set to the fax number listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_person_name | This should be set to the name of the person listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_phone | This should be set to the phone number listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_state | This should be set to the state listed on the account associated with the FreightAccountNumber . |
shipment_info_billing_zip_code | This should be set to the zip code listed on the account associated with the FreightAccountNumber . |
shipment_info_client_discount_percent | The estimated client discount rate for a freight shipment. |
shipment_info_collect_terms_type | This sets the terms for how to collect payment for this freight shipment. |
shipment_info_comments | The description for this freight shipment. |
shipment_info_coupons | This contains a semicolon delimited list of identifiers for promotional discounts offered to customers. |
shipment_info_declared_value | The total declared value per unit for this freight shipment. |
shipment_info_declared_value_units | Identifies the declared value units corresponding to the above defined declared value. |
shipment_info_emergency_contact_phone | The phone number for the emergency contact. |
shipment_info_hazardous_materials_offeror | If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials. |
shipment_info_liability_coverage_amount | This should be set to the total value of the liability coverage. |
shipment_info_liability_coverage_type | This should be set to the type of liability coverage offered. |
shipment_info_pallet_weight | This should contain the total weight of all pallets used in this freight shipment. |
shipment_info_role | This indicates the role of the party is submitting the transaction for this freight shipment. |
shipment_info_total_handling_units | Total number of individual handling units in the entire shipment (for unit pricing). |
shipment_info_total_height | This should be set to the total height of the shipment. |
shipment_info_total_length | This should be set to the total length of the shipment. |
shipment_info_total_width | This should be set to the total width of the shipment. |
shipment_special_services | Contains the collection of special services offered by FedEx. |
ssl_accept_server_cert_effective_date | The date on which this certificate becomes valid. |
ssl_accept_server_cert_expiration_date | The date on which the certificate expires. |
ssl_accept_server_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
ssl_accept_server_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_accept_server_cert_issuer | The issuer of the certificate. |
ssl_accept_server_cert_private_key | The private key of the certificate (if available). |
ssl_accept_server_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
ssl_accept_server_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
ssl_accept_server_cert_public_key | The public key of the certificate. |
ssl_accept_server_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
ssl_accept_server_cert_public_key_length | The length of the certificate's public key (in bits). |
ssl_accept_server_cert_serial_number | The serial number of the certificate encoded as a string. |
ssl_accept_server_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
ssl_accept_server_cert_store | The name of the certificate store for the client certificate. |
ssl_accept_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_accept_server_cert_store_type | The type of certificate store for this certificate. |
ssl_accept_server_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
ssl_accept_server_cert_thumbprint_md5 | The MD5 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
ssl_accept_server_cert_usage | The text description of UsageFlags . |
ssl_accept_server_cert_usage_flags | The flags that show intended use for the certificate. |
ssl_accept_server_cert_version | The certificate's version number. |
ssl_accept_server_cert_subject | The subject of the certificate used for client authentication. |
ssl_accept_server_cert_encoded | The certificate (PEM/Base64 encoded). |
ssl_cert_effective_date | The date on which this certificate becomes valid. |
ssl_cert_expiration_date | The date on which the certificate expires. |
ssl_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | The issuer of the certificate. |
ssl_cert_private_key | The private key of the certificate (if available). |
ssl_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | The public key of the certificate. |
ssl_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | The length of the certificate's public key (in bits). |
ssl_cert_serial_number | The serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
ssl_cert_store | The name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | The type of certificate store for this certificate. |
ssl_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | The MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
ssl_cert_usage | The text description of UsageFlags . |
ssl_cert_usage_flags | The flags that show intended use for the certificate. |
ssl_cert_version | The certificate's version number. |
ssl_cert_subject | The subject of the certificate used for client authentication. |
ssl_cert_encoded | The certificate (PEM/Base64 encoded). |
ssl_provider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
ssl_server_cert_effective_date | The date on which this certificate becomes valid. |
ssl_server_cert_expiration_date | The date on which the certificate expires. |
ssl_server_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
ssl_server_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_server_cert_issuer | The issuer of the certificate. |
ssl_server_cert_private_key | The private key of the certificate (if available). |
ssl_server_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
ssl_server_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
ssl_server_cert_public_key | The public key of the certificate. |
ssl_server_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
ssl_server_cert_public_key_length | The length of the certificate's public key (in bits). |
ssl_server_cert_serial_number | The serial number of the certificate encoded as a string. |
ssl_server_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
ssl_server_cert_store | The name of the certificate store for the client certificate. |
ssl_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_server_cert_store_type | The type of certificate store for this certificate. |
ssl_server_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
ssl_server_cert_thumbprint_md5 | The MD5 hash of the certificate. |
ssl_server_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
ssl_server_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
ssl_server_cert_usage | The text description of UsageFlags . |
ssl_server_cert_usage_flags | The flags that show intended use for the certificate. |
ssl_server_cert_version | The certificate's version number. |
ssl_server_cert_subject | The subject of the certificate used for client authentication. |
ssl_server_cert_encoded | The certificate (PEM/Base64 encoded). |
submitted_by_company | Identifies the contact person's company name. |
submitted_by_email | Identifies the contact person's email address. |
submitted_by_fax | Recipient's fax number. |
submitted_by_first_name | Sender's first name. |
submitted_by_last_name | Person's last name. |
submitted_by_middle_initial | Middle initial. |
submitted_by_phone | Identifies the contact person's phone number. |
timeout | The timeout for the class. |
total_customs_value | Total customs value for the shipment. |
total_net_charge | The total net charge applied to the whole shipment (specific to the AccountNumber ). |
total_weight | Total shipment weight. |
trailer_size | The trailer size. |
transit_time | Expected number of days in transit from pickup to delivery. |
truck_type | The type of truck. |
upload_document_detail_count | The number of records in the UploadDocumentDetail arrays. |
upload_document_detail_doc_type | This specifies the document type of the document being uploaded. |
upload_document_detail_document_id | Upon a successful request, this is returned in the server reply for each uploaded document. |
upload_document_detail_file_content | If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded. |
upload_document_detail_local_file_name | This contains the path to the file on the local system. |
upload_document_detail_ship_document | This indicates if the document will be sent in a subsequent call to GetShipmentLabels or GetPackageLabel . |
upload_document_detail_upload_file_name | This contains the name of file to be uploaded to FedEx. |
upload_image_detail_count | The number of records in the UploadImageDetail arrays. |
upload_image_detail_file_content | If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded. |
upload_image_detail_image_index | Specifies the index for the uploaded image. |
upload_image_detail_image_type | This specifies the image type of the image being uploaded. |
upload_image_detail_local_file_name | This contains the path to the file on the local system. |
upload_image_detail_reference | This is an optional property to specify the customer reference for the image to be uploaded (Example: SIGNA202403). |
upload_image_detail_status | Upon a successful request, this is returned in the server reply for each uploaded image. |
upload_image_detail_upload_file_name | This contains the name of file to be uploaded to FedEx (Example: Signature. |
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_package | Cancels a single package shipment by deleting it from the shipping log. |
cancel_pickup | Cancels a scheduled Pickup request. |
cancel_shipment | Cancels all packages within the shipment. |
config | Sets or retrieves a configuration setting. |
get_package_label | Generates a shipping label for the specified package. |
get_shipment_labels | Generates a shipping label for all packages in the shipment. |
pickup_availability | Checks the availability of the courier dispatch service for the given address. |
reprint_documents | Reprints the requested document. |
reset | Resets the internal state of the class and all properties to their default values. |
schedule_pickup | This method schedules a courier pickup. |
upload_documents | Uploads documents to FedEx. |
upload_images | Uploads images to FedEx. |
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_error | Information about errors during data delivery. |
on_notification | Notification returned by the server upon successful request (if applicable). |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AdmissibilityPackageType | Identifies the admissibility package type. |
B13AFiling | Specifies which option is being exercised by the customer to file the B13A. |
BlockVisibility | Whether the visibility of this shipment should be blocked from parties other than shipper/payor. |
BookingNumber | Booking confirmation number. |
CancelledShipment | Indicates whether the shipment has been cancelled or not. |
CODRecipientAddress1 | The primary street address of the COD recipient. |
CODRecipientAddress2 | The secondary street address of the COD recipient. |
CODRecipientCity | The city of the COD recipient. |
CODRecipientCompany | The company of the COD recipient. |
CODRecipientCountryCode | The country code of the COD recipient. |
CODRecipientName | The name of the COD recipient. |
CODRecipientPhone | The phone number of the COD recipient. |
CODRecipientResidential | The residential status of the COD recipient. |
CODRecipientState | The state of the COD recipient. |
CODRecipientZipCode | The zip code of the COD recipient. |
CODReferenceIndicator | The reference information to be added to the COD return label. |
CODType | COD type. |
CurrencyCode | The currency code associated with the monetary values present in the request. |
CustomerImageCount | The number of records in the CustomerImage arrays. |
CustomerImageDocumentType[i] | Document type. |
CustomerImageId[i] | The Image ID. |
CustomerImageProvidedImageType[i] | The provided document image type. |
CustomerImageType[i] | Document image type. |
CustomerTransactionId | Customer transaction id. |
DeclarationStatement | The declarations statement to be sent to the customs office. |
DeliveryDay | Day of the week on which shipment is expected to be delivered. |
DeliveryInstructions | Delivery instructions. |
DocTabContent | Custom DocTab content set by the user when preparing a shipping label. |
Documents | Whether an international shipment contains only documents or no documents. |
DryIceCount | The number of packages which contain dry ice. |
EstimateDelivery | Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day. |
ExportCompliance | This is an export compliance statement. |
InvoiceSpecialInstructions | Special instructions for commercial invoices. |
LabelFormatType | Indicates the type of label to be returned. |
LabelOrientationType | Indicates if the top or bottom of the label comes out of the printer. |
LabelStockType | Indicates the size of the label and the location of the doc tab if present. |
LoadAndCount | Shipper's Load and Count (SLAC) = total shipment pieces. |
MaskedData | Specifies which data/sections to be masked on the shipping label. |
Overwrite | Determines whether label files will be overwritten. |
PackageDocumentFile | The file path for the additional package documents. |
PackageDryIceWeight[i] | The weight of the dry ice for each package. |
PackageFreightCommodityIds[i] | The Freight Commodity Line Item IDs associated with this package. |
PackagePhysicalPackagingType[i] | Additional details about the physical packaging of the item in a FedEx Freight shipment. |
PrintedReferenceBillOfLading | Shipper's Bill of Lading number to be printed on the label. |
PrintedReferenceConsigneeId | Consignee Id to be printed on the label. |
PrintedReferenceShipperId | Shipper Id to be printed on the label. |
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
RecipientTinNumber | Indicates the corresponding Id number for recipient TIN type. |
RecipientTinType | Indicates the type of the recipient tax identification number (TIN). |
RegulatoryControlType | Identifies the type of regulatory control. |
ReturnDescription | Description for the return. |
ReturnType | Identifies the reason for return. |
SenderTinNumber | Indicates the corresponding Id number for shipper TIN type. |
SenderTinType | Indicates the type of the shipper tax identification number (TIN). |
ShipmentRatingAggregate | String representing the rating detail on shipment level. |
ShippingDocumentFile | Identifies the location of the document file. |
ShippingDocumentImageType | Specifies the image or printer commands format of the shipping document. |
ShippingDocumentStockType | Indicates the size of the shipping document and the location of the doc tab if present. |
ShippingDocumentTypes | Specifies which document type to get. |
ShipTime | Local Time of shipment based on shipper's time zone. |
SizeUnit | The dimension unit. |
TESTMODE | This configuration setting will allow you to run test transactions. |
Warning | Warning message returned by the server. |
WeightUnit | Weight unit. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
approved_by_company Property
Identifies the contact person's company name.
Syntax
def get_approved_by_company() -> str: ... def set_approved_by_company(value: str) -> None: ...
approved_by_company = property(get_approved_by_company, set_approved_by_company)
Default Value
""
Remarks
Identifies the contact person's company name. In a ship request, either approved_by_first_name and approved_by_last_name or approved_by_company are required to be provided.
approved_by_email Property
Identifies the contact person's email address.
Syntax
def get_approved_by_email() -> str: ... def set_approved_by_email(value: str) -> None: ...
approved_by_email = property(get_approved_by_email, set_approved_by_email)
Default Value
""
Remarks
Identifies the contact person's email address. Maximum length: 120.
approved_by_fax Property
Recipient's fax number.
Syntax
def get_approved_by_fax() -> str: ... def set_approved_by_fax(value: str) -> None: ...
approved_by_fax = property(get_approved_by_fax, set_approved_by_fax)
Default Value
""
Remarks
Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.
approved_by_first_name Property
Sender's first name.
Syntax
def get_approved_by_first_name() -> str: ... def set_approved_by_first_name(value: str) -> None: ...
approved_by_first_name = property(get_approved_by_first_name, set_approved_by_first_name)
Default Value
""
Remarks
Sender's first name. The value of this property is required. Values for either approved_by_first_name and approved_by_last_name or approved_by_company must be sent.
approved_by_last_name Property
Person's last name.
Syntax
def get_approved_by_last_name() -> str: ... def set_approved_by_last_name(value: str) -> None: ...
approved_by_last_name = property(get_approved_by_last_name, set_approved_by_last_name)
Default Value
""
Remarks
Person's last name. The value of this property is required. Values for either approved_by_first_name and approved_by_last_name or approved_by_company must be sent. Maximum length: 45 characters for both names or company name.
approved_by_middle_initial Property
Middle initial.
Syntax
def get_approved_by_middle_initial() -> str: ... def set_approved_by_middle_initial(value: str) -> None: ...
approved_by_middle_initial = property(get_approved_by_middle_initial, set_approved_by_middle_initial)
Default Value
""
Remarks
Middle initial. The value of this property is optional.
approved_by_phone Property
Identifies the contact person's phone number.
Syntax
def get_approved_by_phone() -> str: ... def set_approved_by_phone(value: str) -> None: ...
approved_by_phone = property(get_approved_by_phone, set_approved_by_phone)
Default Value
""
Remarks
Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.
broker_address1 Property
Street name.
Syntax
def get_broker_address1() -> str: ... def set_broker_address1(value: str) -> None: ...
broker_address1 = property(get_broker_address1, set_broker_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 broker_address1 should not exceed 35 characters.
broker_address2 Property
A specific detail on the address (such as building, suite, apartment, floor number etc.
Syntax
def get_broker_address2() -> str: ... def set_broker_address2(value: str) -> None: ...
broker_address2 = property(get_broker_address2, set_broker_address2)
Default Value
""
Remarks
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS broker_address2 should not exceed 35 characters.
broker_address_flags Property
Various flags that denote information about the address.
Syntax
def get_broker_address_flags() -> int: ... def set_broker_address_flags(value: int) -> None: ...
broker_address_flags = property(get_broker_address_flags, set_broker_address_flags)
Default Value
0
Remarks
Various flags that denote information about the address.
Value | Meaning |
0x00000001 | POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses. |
0x00000002 | Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial. |
broker_city Property
Name of city, town, etc.
Syntax
def get_broker_city() -> str: ... def set_broker_city(value: str) -> None: ...
broker_city = property(get_broker_city, set_broker_city)
Default Value
""
Remarks
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.
broker_country_code Property
Country code.
Syntax
def get_broker_country_code() -> str: ... def set_broker_country_code(value: str) -> None: ...
broker_country_code = property(get_broker_country_code, set_broker_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 Name | Country Code |
Afghanistan | AF |
Albania | AL |
American Samoa | AS |
Andorra | AD |
Angola | AO |
Anguilla | AI |
Antigua | AG* |
Argentina | AR |
Armenia | AM |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaijan | AZ |
Bahamas | BS |
Bahrain | BH |
Bangladesh | BD |
Barbados | BB |
Barbuda | AG* |
Belarus | BY |
Belgium | BE |
Belize | BZ |
Benin | BJ |
Bermuda | BM |
Bhutan | BT |
Bolivia | BO |
Bonaire | AN** |
Bosnia-Herzegovina | BA |
Botswana | BW |
Brazil | BR |
British Virgin Islands | VG* |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cambodia | KH |
Cameroon | CM |
Canada | CA |
Canary Islands | ES** |
Cape Verde | CV |
Cayman Islands | KY** |
Chad | TD |
Channel Islands | GB** |
Chile | CL |
China | CN |
Colombia | CO |
Congo | CG |
Congo Dem. Rep. Of | CD |
Cook Islands | CK |
Costa Rica | CR |
Croatia | HR |
Curacao | AN** |
Cyprus | CY |
Czech Republic | CZ |
Denmark | DK |
Djibouti | DJ |
Dominica | DM |
Dominican Republic | DO |
East Timor | TL |
Ecuador | EC |
Egypt | EG |
El Salvador | SV |
England | GB** |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
Ethiopia | ET |
Faeroe Islands | FO* |
Fiji | FJ |
Finland | FI |
France | FR |
French Guiana | GF |
French Polynesia | PF** |
Gabon | GA |
Gambia | GM |
Georgia | GE |
Germany | DE |
Ghana | GH |
Gibraltar | GI |
Grand Cayman | KY** |
Great Britain | GB** |
Great Thatch Island | VG* |
Great Tobago Islands | VG* |
Greece | GR |
Greenland | GL |
Grenada | GD |
Guadeloupe | GP** |
Guam | GU |
Guatemala | GT |
Guinea | GN |
Guyana | GY |
Haiti | HT |
Holland | NL** |
Honduras | HN |
Hong Kong | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iraq | IQ |
Ireland | IE |
Israel | IL |
Italy | IT** |
Ivory Coast | CI |
Jamaica | JM |
Japan | JP |
Jordan | JO |
Jost Van Dyke Islands | VG* |
Kazakhstan | KZ |
Kenya | KE |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Liechtenstein | LI |
Lithuania | LT |
Luxembourg | LU |
Macau | MO |
Macedonia | MK |
Madagascar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Mexico | MX |
Micronesia | FM |
Moldova | MD |
Monaco | MC |
Mongolia | MN |
Montserrat | MS |
Morocco | MA |
Mozambique | MZ |
Namibia | NA |
Nepal | NP |
Netherlands | NL** |
Netherlands Antilles | AN** |
New Caledonia | NC |
New Zealand | NZ |
Nicaragua | NI |
Niger | NE |
Nigeria | NG |
Norman Island | VG* |
Northern Ireland | GB** |
Northern Mariana Islands | MP** |
Norway | NO |
Oman | OM |
Pakistan | PK |
Palau | PW |
Palestine | PS* |
Panama | PA |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunion | RE |
Romania | RO |
Rota | MP** |
Russia | RU |
Rwanda | RW |
Saba | AN** |
Saipan | MP** |
Samoa | WS |
San Marino | IT** |
Saudi Arabia | SA |
Scotland | GB** |
Senegal | SN |
Serbia & Montenegro | CS |
Seychelles | SC |
Singapore | SG |
Slovak Republic | SK |
Slovenia | SI |
South Africa | ZA |
South Korea | KR |
Spain | ES** |
Sri Lanka | LK |
St. Barthelemy | GP** |
St. Christopher | KN** |
St. Croix Island | VI** |
St. Eustatius | AN** |
St. John | VI** |
St. Kitts and Nevis | KN** |
St. Lucia | LC |
St. Maarten | AN** |
St. Thomas | VI** |
St. Vincent | VC** |
Suriname | SR |
Swaziland | SZ |
Sweden | SE |
Switzerland | CH |
Tahiti | PF** |
Taiwan | TW |
Tanzania | TZ |
Thailand | TH |
Tinian | MP** |
Togo | TG |
Tonga | TO |
Tortola Island | VG* |
Trinidad & Tobago | TT |
Tunisia | TN |
Turkey | TR |
Turkmenistan | TM |
Turks & Caicos Islands | TC |
U.S. Virgin Islands | VI** |
Uganda | UG |
Ukraine | UA |
Union Island | VC** |
United Arab Emirates | AE |
United Kingdom | GB** |
United States | US |
Uruguay | UY |
Uzbekistan | UZ |
Vanuatu | VU |
Vatican City | IT** |
Venezuela | VE |
Vietnam | VN |
Wales | GB** |
Wallis & Futuna Islands | WF |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
Country Name | Country Code |
Cayman Islands | KY |
French Polynesia | PF |
Guadeloupe | GP |
Italy | IT |
Netherlands | NL |
Netherlands Antilles | AN |
Northern Mariana Islands | MP |
Spain | ES |
St. Kitts and Nevis | KN |
St. Vincent | VC |
United Kingdom | GB |
U.S. Virgin Islands | VI |
broker_state Property
State or province code.
Syntax
def get_broker_state() -> str: ... def set_broker_state(value: str) -> None: ...
broker_state = property(get_broker_state, set_broker_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.
broker_zip_code Property
Postal code.
Syntax
def get_broker_zip_code() -> str: ... def set_broker_zip_code(value: str) -> None: ...
broker_zip_code = property(get_broker_zip_code, set_broker_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 broker_city and broker_state are not present.
Valid characters: A-Z; 0-9; a-z. Maximum length: 16.
broker_company Property
Identifies the contact person's company name.
Syntax
def get_broker_company() -> str: ... def set_broker_company(value: str) -> None: ...
broker_company = property(get_broker_company, set_broker_company)
Default Value
""
Remarks
Identifies the contact person's company name. In a ship request, either broker_first_name and broker_last_name or broker_company are required to be provided.
broker_email Property
Identifies the contact person's email address.
Syntax
def get_broker_email() -> str: ... def set_broker_email(value: str) -> None: ...
broker_email = property(get_broker_email, set_broker_email)
Default Value
""
Remarks
Identifies the contact person's email address. Maximum length: 120.
broker_fax Property
Recipient's fax number.
Syntax
def get_broker_fax() -> str: ... def set_broker_fax(value: str) -> None: ...
broker_fax = property(get_broker_fax, set_broker_fax)
Default Value
""
Remarks
Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.
broker_first_name Property
Sender's first name.
Syntax
def get_broker_first_name() -> str: ... def set_broker_first_name(value: str) -> None: ...
broker_first_name = property(get_broker_first_name, set_broker_first_name)
Default Value
""
Remarks
Sender's first name. The value of this property is required. Values for either broker_first_name and broker_last_name or broker_company must be sent.
broker_last_name Property
Person's last name.
Syntax
def get_broker_last_name() -> str: ... def set_broker_last_name(value: str) -> None: ...
broker_last_name = property(get_broker_last_name, set_broker_last_name)
Default Value
""
Remarks
Person's last name. The value of this property is required. Values for either broker_first_name and broker_last_name or broker_company must be sent. Maximum length: 45 characters for both names or company name.
broker_middle_initial Property
Middle initial.
Syntax
def get_broker_middle_initial() -> str: ... def set_broker_middle_initial(value: str) -> None: ...
broker_middle_initial = property(get_broker_middle_initial, set_broker_middle_initial)
Default Value
""
Remarks
Middle initial. The value of this property is optional.
broker_phone Property
Identifies the contact person's phone number.
Syntax
def get_broker_phone() -> str: ... def set_broker_phone(value: str) -> None: ...
broker_phone = property(get_broker_phone, set_broker_phone)
Default Value
""
Remarks
Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.
broker_type Property
Identifies the broker type.
Syntax
def get_broker_type() -> int: ... def set_broker_type(value: int) -> None: ...
broker_type = property(get_broker_type, set_broker_type)
Default Value
0
Remarks
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)
Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.
Possible values are:
btUnassigned (0) | |
btExport (1) | |
btImport (2) |
Note this only applies when shipping internationally.
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:
Value | Description |
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 |
clearance_brokerage_type Property
Specifies the type of brokerage to be applied to a shipment.
Syntax
def get_clearance_brokerage_type() -> int: ... def set_clearance_brokerage_type(value: int) -> None: ...
clearance_brokerage_type = property(get_clearance_brokerage_type, set_clearance_brokerage_type)
Default Value
0
Remarks
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)
Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.
Possible values are:
cbUnassigned (0) | |
cbInclusive (1) | |
cbInclusiveNonResidentImporter (2) | |
cbSelect (3) | |
cbSelectNonResidentImporter (4) |
Note this only applies when shipping internationally.
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 |
commercial_invoice_comments Property
Commercial Invoice comments to be uploaded to customs.
Syntax
def get_commercial_invoice_comments() -> str: ... def set_commercial_invoice_comments(value: str) -> None: ...
commercial_invoice_comments = property(get_commercial_invoice_comments, set_commercial_invoice_comments)
Default Value
""
Remarks
Commercial Invoice comments to be uploaded to customs. This can be any extra information about the current shipment and is optional.
commercial_invoice_freight_charge Property
Cost to transport the shipment.
Syntax
def get_commercial_invoice_freight_charge() -> str: ... def set_commercial_invoice_freight_charge(value: str) -> None: ...
commercial_invoice_freight_charge = property(get_commercial_invoice_freight_charge, set_commercial_invoice_freight_charge)
Default Value
"0.00"
Remarks
Cost to transport the shipment. This is required if commercial_invoice_terms is set to Cfr, Cpt, Cif, or Cip. This charge will be added to the total customs value amount.
Format: Two explicit decimal positions.
commercial_invoice_insurance Property
The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged.
Syntax
def get_commercial_invoice_insurance() -> str: ... def set_commercial_invoice_insurance(value: str) -> None: ...
commercial_invoice_insurance = property(get_commercial_invoice_insurance, set_commercial_invoice_insurance)
Default Value
"0.00"
Remarks
The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. This is required if commercial_invoice_terms is set to Cif or Cip.. This charge will be added to the total customs value amount.
Format: Two explicit decimal positions.
commercial_invoice_number Property
Customer's assigned invoice number.
Syntax
def get_commercial_invoice_number() -> str: ... def set_commercial_invoice_number(value: str) -> None: ...
commercial_invoice_number = property(get_commercial_invoice_number, set_commercial_invoice_number)
Default Value
""
Remarks
Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice.
commercial_invoice_purpose Property
Reason to export the current international shipment Required for dutiable international express or ground shipment.
Syntax
def get_commercial_invoice_purpose() -> int: ... def set_commercial_invoice_purpose(value: int) -> None: ...
commercial_invoice_purpose = property(get_commercial_invoice_purpose, set_commercial_invoice_purpose)
Default Value
0
Remarks
Reason to export the current international shipment
Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.
Valid values are:
Value | FedEx | UPS | |
cipSold (0) | X | X | |
cipGift (1) | X | X | |
cipNotSold (2) | X | ||
cipPersonalEffects (3) | X | ||
cipReturn (4) | X | ||
cipRepair (5) | X | ||
cipRepairAndReturn (6) | X | ||
cipSample (7) | X | X | |
cipInterCompanyData (8) | X |
commercial_invoice_terms Property
Indicates the rights to the seller from the buyer.
Syntax
def get_commercial_invoice_terms() -> int: ... def set_commercial_invoice_terms(value: int) -> None: ...
commercial_invoice_terms = property(get_commercial_invoice_terms, set_commercial_invoice_terms)
Default Value
0
Remarks
Indicates the rights to the seller from the buyer.
Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.
Valid values are:
Value | Meaning | FedEx | UPS | |
citFca (0) | Free Carrier | X | X | |
citFob (1) | Free On Board/Free Carrier | X | X | |
citFas (2) | Free Alongside Ship | X | ||
citCfr (3) | Cost and Freight | X | X | |
citCif (4) | Cost, Insurance and Freight | X | X | |
citCip (5) | Carriage and Insurance Paid | X | X | |
citCpt (6) | Carriage Paid To | X | X | |
citDaf (7) | Delivered at Frontier | X | ||
citDdp (8) | Delivery Duty Paid | X | X | |
citDdu (9) | Delivery Duty Unpaid | X | X | |
citDeq (10) | Delivered Ex Quay | X | ||
citDes (11) | Delivered Ex Ship | X | ||
citExw (12) | Ex Works | X | X |
commodity_count Property
The number of records in the Commodity arrays.
Syntax
def get_commodity_count() -> int: ... def set_commodity_count(value: int) -> None: ...
commodity_count = property(get_commodity_count, set_commodity_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- commodity_description
- commodity_freight_class
- commodity_freight_packaging_type
- commodity_handling_units
- commodity_harmonized_code
- commodity_hazardous_materials_options
- commodity_height
- commodity_id
- commodity_length
- commodity_manufacturer
- commodity_nmfc_code
- commodity_number_of_pieces
- commodity_part_number
- commodity_po_number
- commodity_quantity
- commodity_quantity_unit
- commodity_unit_price
- commodity_value
- commodity_volume
- commodity_weight
- commodity_width
The array indices start at 0 and end at commodity_count - 1.
commodity_description Property
Complete and accurate description of this commodity line item.
Syntax
def get_commodity_description(commodity_idx: int) -> str: ... def set_commodity_description(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
Complete and accurate description of this commodity line item.
It is applicable to all international forms and freight shipments. Optional for Partial Invoice and required for the rest of form types.
Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.
If the shipment contains documents only (i.e., Documents is set to True), then the commodity_description has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.
Description | |
Correspondence/No Commercial Value | Leases |
Accounting Documents | Legal Documents |
Analysis Reports | Letters and Cards |
Applications (Completed) | Letter of Credit Packets |
Bank Statements | Loan Documents |
Bid Quotations | Marriage Certificates |
Birth Certificates | Medical Records |
Bills of Sale | Office Records |
Bonds | Operating Agreements |
Business Correspondence | Patent Applications |
Checks (Completed) | Permits |
Claim Files | Photocopies |
Closing Statements | Proposals |
Conference Reports | Prospectuses |
Contracts | Purchase Orders |
Cost Estimates | Quotations |
Court Transcripts | Reservation Confirmation |
Credit Applications | Resumes |
Data Sheets | Sales Agreements |
Deeds | Sales Reports |
Employment Papers | Shipping Documents |
Escrow Instructions | Statements/Reports |
Export Papers | Statistical Data |
Financial Statements | Stock Information |
Immigration Papers | Tax Papers |
Income Statements | Trade Confirmation |
Insurance Documents | Transcripts |
Interoffice Memos | Warranty Deeds |
Inventory Reports | |
Invoices (Completed) |
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_freight_class Property
Indicates the freight class of the commodity.
Syntax
def get_commodity_freight_class(commodity_idx: int) -> int: ... def set_commodity_freight_class(commodity_idx: int, value: int) -> None: ...
Default Value
0
Remarks
Indicates the freight class of the commodity.
The following table lists freight classes available from FedEx freight services.
Freight Class | |
50 | |
55 | |
60 | |
65 | |
70 | |
77.5 | |
85 | |
92.5 | |
100 | |
110 | |
125 | |
150 | |
175 | |
200 | |
250 | |
300 | |
400 | |
500 |
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_freight_packaging_type Property
Identifies the Commodity item's packaging type.
Syntax
def get_commodity_freight_packaging_type(commodity_idx: int) -> int: ... def set_commodity_freight_packaging_type(commodity_idx: int, value: int) -> None: ...
Default Value
0
Remarks
Identifies the Commodity item's packaging type. Possible values are:
fcptNone (0) | |
fcptBag (1) | |
fcptBarrel (2) | |
fcptBasket (3) | |
fcptBox (4) | |
fcptBucket (5) | |
fcptBundle (6) | |
fcptCage (7) | |
fcptCarton (8) | |
fcptCase (9) | |
fcptChest (10) | |
fcptContainer (11) | |
fcptCrate (12) | |
fcptCylinder (13) | |
fcptDrum (14) | |
fcptEnvelope (15) | |
fcptHamper (16) | |
fcptOther (17) | |
fcptPackage (18) | |
fcptPail (19) | |
fcptPallet (20) | |
fcptParcel (21) | |
fcptPiece (22) | |
fcptReel (23) | |
fcptRoll (24) | |
fcptSack (25) | |
fcptShrinkwrapped (26) | |
fcptSkid (27) | |
fcptTank (28) | |
fcptTotebin (29) | |
fcptTube (30) | |
fcptUnit (31) |
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_handling_units Property
Number of individual handling units to which this commodity applies.
Syntax
def get_commodity_handling_units(commodity_idx: int) -> int: ... def set_commodity_handling_units(commodity_idx: int, value: int) -> None: ...
Default Value
1
Remarks
Number of individual handling units to which this commodity applies. (NOTE: Total of commodity-level handling units may not balance to shipment-level total handling units.)
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_harmonized_code Property
Unique code representing this commodity line item (for imports only).
Syntax
def get_commodity_harmonized_code(commodity_idx: int) -> str: ... def set_commodity_harmonized_code(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
Unique code representing this commodity line item (for imports only).
The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.
It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in commodity_description, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.
If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_harmonized_code is required for each commodity line item for shipments to EU countries.
At least one occurrence is required for U.S. Export shipments if the total_customs_value is greater than 2,500 USD or if a valid U.S. Export license is required.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_hazardous_materials_options Property
Indicates the kind of hazardous material content in this commodity.
Syntax
def get_commodity_hazardous_materials_options(commodity_idx: int) -> int: ... def set_commodity_hazardous_materials_options(commodity_idx: int, value: int) -> None: ...
Default Value
0
Remarks
Indicates the kind of hazardous material content in this commodity.
The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple options:
Value | Meaning |
0x00000001 | Hazardous Materials |
0x00000002 | Battery |
0x00000004 | Other Regulated Materials - Domestic (ORM-D) |
0x00000008 | Reportable Quantities |
0x00000010 | Small Quantity Exception |
0x00000020 | Limited Quantities Commodities |
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_height Property
The height of the commodity.
Syntax
def get_commodity_height(commodity_idx: int) -> int: ... def set_commodity_height(commodity_idx: int, value: int) -> None: ...
Default Value
1
Remarks
The height of the commodity.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_id Property
A unique identifier assigned to this line item.
Syntax
def get_commodity_id(commodity_idx: int) -> str: ... def set_commodity_id(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
A unique identifier assigned to this line item.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_length Property
The width of the commodity.
Syntax
def get_commodity_length(commodity_idx: int) -> int: ... def set_commodity_length(commodity_idx: int, value: int) -> None: ...
Default Value
1
Remarks
The width of the commodity.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_manufacturer Property
Country code where the contents of this commodity line were produced, manufactured or grown in their final form.
Syntax
def get_commodity_manufacturer(commodity_idx: int) -> str: ... def set_commodity_manufacturer(commodity_idx: int, value: str) -> None: ...
Default Value
"US"
Remarks
Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the commodity_manufacturer is required to be entered.
In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the commodity_manufacturer and commodity_description are required to be provided in the request. If the commodity_manufacturer is not provided, it defaults to US.
When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The commodity_manufacturer has to be provided for each commodity item included in that international shipment.
In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.
Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.
Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.
Country Name | Country Code | Currency Code | Max Weight | Address Validation Supported | Postal Code Req. | Euro Country |
Albania | AL | ALL | 70 KGS | No | No | No |
Algeria | DZ | DZD | 70 KGS | No | No | No |
Andorra | AD | PTS | 70 KGS | No | No | No |
Angola | AO | AOK | 70 KGS | No | No | No |
Anguilla | AI | XCD | 150 LBS | No | No | No |
Antigua & Barbuda | AG | XCD | 150 LBS | No | No | No |
Argentina | AR | ARP | 70 KGS | Yes | Yes | No |
Armenia | AM | USD | 70 KGS | No | Yes | No |
Aruba | AW | AWG | 150 LBS | No | No | No |
Australia | AU | AUD | 70 KGS | Yes | Yes | No |
Austria (EU Member) | AT | EUR | 70 KGS | No | Yes | Yes |
Azerbaijan | AZ | RUR | 70 KGS | No | Yes | No |
Bahamas | BS | BSD | 150 LBS | No | No | No |
Bahrain | BH | BHD | 70 KGS | No | No | No |
Bangladesh | BD | BDT | 70 KGS | No | Yes | No |
Barbados | BB | BBD | 150 LBS | No | No | No |
Belarus | BY | RUR | 70 KGS | No | Yes | No |
Belgium (EU Member) | BE | EUR | 70 KGS | No | Yes | Yes |
Belize | BZ | BZD | 150 LBS | No | No | No |
Benin | BJ | XOF | 70 KGS | No | No | No |
Bermuda | BM | BMD | 150 LBS | No | No | No |
Bolivia | BO | BOP | 70 KGS | No | No | No |
Bosnia-Herzegovina | BA | BAD | 70 KGS | No | Yes | No |
Botswana | BW | BWP | 70 KGS | No | No | No |
Brazil | BR | BRC | 70 KGS | Yes | Yes | No |
British Virgin Islands | VG | USD | 150 LBS | No | No | No |
Brunei | BN | BND | 70 KGS | No | No | No |
Bulgaria | BG | BGL | 70 KGS | No | Yes | No |
Burkina Faso | BF | XOF | 70 KGS | No | No | No |
Burundi | BI | BIF | 70 KGS | No | No | No |
Cambodia | KH | USD | 70 KGS | No | No | No |
Cameroon | CM | XAF | 70 KGS | No | No | No |
Canada | CA | CAD | 150 LBS | Yes | Yes | No |
Cape Verde | CV | USD | 70 KGS | No | No | No |
Cayman Islands | KY | KYD | 150 LBS | No | No | No |
Central African Rep | CF | XAF | 70 KGS | No | No | No |
Chad | TD | XAF | 70 KGS | No | No | No |
Channel Islands | CD | GBP | 70 KGS | No | Yes | No |
Chile | CL | CLP | 70 KGS | Yes | No | No |
China | CN | CNY | 70 KGS | Yes | Yes | No |
Colombia | CO | COP | 70 KGS | Yes | No | No |
Congo | CG | XAF | 70 KGS | No | No | No |
Cook Islands | CK | NZD | 70 KGS | No | No | No |
Costa Rica | CR | CRC | 70 KGS | No | No | No |
Croatia | HR | YUD | 70 KGS | No | Yes | No |
Cyprus | CY | CYP | 70 KGS | No | No | No |
Czech Republic | CZ | CZK | 70 KGS | No | Yes | No |
Dem Rep of Congo (Zaire) | ZR | ZRZ | 70 KGS | No | No | No |
Denmark (EU Member) | DK | DKK | 70 KGS | Yes | Yes | Yes |
Djibouti | DJ | DJF | 70 KGS | No | No | No |
Dominica | DM | XCD | 150 LBS | No | No | No |
Dominican Republic | DO | DOP | 150 LBS | No | No | No |
Ecuador | EC | ECS | 70 KGS | No | No | No |
Egypt | EG | EGP | 70 KGS | No | No | No |
El Salvador | SV | SVC | 70 KGS | No | No | No |
Equatorial Guinea | GQ | XAF | 70 KGS | No | No | No |
Eritrea | ER | DKK | 70 KGS | No | No | No |
Estonia | EE | EEK | 70 KGS | No | Yes | No |
Ethiopia | ET | ETB | 70 KGS | No | No | No |
Faeroe Islands | FO | DKK | 70 KGS | No | Yes | No |
Fiji | FJ | FJD | 70 KGS | No | No | No |
Finland (EU Member) | FI | EUR | 70 KGS | No | Yes | Yes |
France (EU Member) | FR | EUR | 70 KGS | Yes | Yes | Yes |
French Guiana | GF | FRF | 70 KGS | No | No | No |
French Polynesia | PF | XPF | 70 KGS | No | No | No |
Gabon | GA | XAF | 70 KGS | No | No | No |
Gambia | GM | GMD | 70 KGS | No | No | No |
Georgia | GE | RUR | 70 KGS | No | Yes | No |
Germany (EU Member) | DE | EUR | 70 KGS | Yes | Yes | Yes |
Ghana | GH | GHC | 70 KGS | No | No | No |
Gibraltar | GI | GIP | 70 KGS | No | No | No |
Greece (EU Member) | GR | EUR | 70 KGS | No | Yes | Yes |
Greenland | GL | DKK | 70 KGS | No | Yes | No |
Grenada | GD | XCD | 150 LBS | No | No | No |
Guadeloupe | GP | FRF | 150 LBS | No | No | No |
Guam | GU | USD | 150 LBS | No | No | No |
Guatemala | GT | GTO | 70 KGS | No | No | No |
Guinea | GN | GNS | 70 KGS | No | No | No |
Guinea-Bissau | GW | GWP | 70 KGS | No | No | No |
Guyana | GY | GYD | 70 KGS | No | No | No |
Haiti | HT | HTG | 150 LBS | No | No | No |
Honduras | HN | HNL | 70 KGS | No | No | No |
Hong Kong | HK | HKD | 70 KGS | No | No | No |
Hungary | HU | HUF | 70 KGS | No | Yes | Yes |
Iceland | IS | ISK | 70 KGS | No | Yes | Yes |
India | IN | INR | 70 KGS | Yes | Yes | No |
Indonesia | ID | IDR | 70 KGS | No | Yes | No |
Iran | IR | IRR | 70 KGS | No | No | No |
Iraq | IQ | IQD | 70 KGS | No | No | No |
Ireland (EU Member) | IE | EUR | 70 KGS | Yes | No | Yes |
Israel | IL | ILS | 70 KGS | No | Yes | Yes |
Italy (EU Member) | IT | EUR | 70 KGS | Yes | Yes | Yes |
Ivory Coast | CI | XOF | 70 KGS | No | No | No |
Jamaica | JM | KMD | 70 KGS | No | No | No |
Japan | JP | JPY | 70 KGS | Yes | Yes | No |
Jordan | JO | JOD | 70 KGS | No | No | No |
Kazakhstan | KZ | RUR | 70 KGS | No | Yes | No |
Kenya | KE | KES | 70 KGS | No | No | No |
Kiribati | KI | AUD | 70 KGS | No | No | No |
Kuwait | KW | KWD | 70 KGS | No | No | No |
Kyrgyzstan | KG | RUR | 70 KGS | No | Yes | No |
Laos | LA | USD | 70 KGS | No | No | No |
Latvia | LV | RUR | 70 KGS | No | Yes | No |
Lebanon | LB | LBP | 70 KGS | No | No | No |
Lesotho | LS | ZAR | 70 KGS | No | No | No |
Liberia | LR | LRD | 70 KGS | No | No | No |
Libya | LY | LYD | 70 KGS | No | No | No |
Liechtenstein | LI | CHF | 70 KGS | No | Yes | No |
Lithuania | LT | LTL | 70 KGS | No | Yes | No |
Luxembourg | LU | LUF | 70 KGS | No | Yes | Yes |
Macau | MO | MOP | 70 KGS | No | No | No |
Macedonia (FYROM) | MK | USD | 70 KGS | No | Yes | Yes |
Madagascar | MG | MGF | 70 KGS | No | No | No |
Malawi | MW | MWK | 70 KGS | No | No | No |
Malaysia | MY | MYR | 70 KGS | Yes | Yes | No |
Maldives | MV | MVR | 70 KGS | No | No | No |
Mali | ML | MLF | 70 KGS | No | No | No |
Malta | MT | MTP | 70 KGS | No | No | No |
Marshall Islands | MH | USD | 70 KGS | No | Yes | No |
Martinique | MQ | FRF | 150 LBS | No | Yes | No |
Mauritania | MR | MRO | 70 KGS | No | No | No |
Mauritius | MU | MUR | 70 KGS | No | No | No |
Mexico | MX | MXP | 70 KGS | Yes | Yes | No |
Micronesia | FM | USD | 70 KGS | No | Yes | No |
Moldova | MD | EUR | 70 KGS | No | Yes | Yes |
Monaco (EU Member) | MC | EUR | 70 KGS | No | Yes | Yes |
Mongolia | MN | USD | 70 KGS | No | Yes | No |
Montserrat | MS | XCD | 150 LBS | No | No | No |
Morocco | MA | MAD | 70 KGS | No | No | No |
Mozambique | MZ | MZM | 70 KGS | No | No | No |
Myanmar | MM | USD | 70 KGS | No | No | No |
N. Mariana Islands | MP | USD | 150 LBS | No | No | No |
Namibia | NA | ZAR | 70 KGS | No | No | No |
Nepal | NP | NPR | 70 KGS | No | Yes | No |
Netherlands (EU Member) | NL | EUR | 70 KGS | Yes | Yes | Yes |
Netherlands Antilles | AN | ANG | 150 LBS | No | No | No |
New Caledonia | NC | XPF | 70 KGS | No | No | No |
New Zealand | NZ | NZD | 70 KGS | Yes | Yes | No |
Nicaragua | NI | NIC | 70 KGS | No | No | No |
Niger | NE | XOF | 70 KGS | No | No | No |
Nigeria | NG | NGN | 70 KGS | No | No | No |
Norfolk Island | NF | AUD | 70 KGS | No | No | No |
Norway | NO | NOK | 70 KGS | No | Yes | Yes |
Oman | OM | OMR | 70 KGS | No | No | No |
Pakistan | PK | PKR | 70 KGS | No | Yes | No |
Palau | PW | USD | 70 KGS | No | Yes | No |
Panama | PA | PAB | 70 KGS | No | No | No |
Papua New Guinea | PG | PGK | 70 KGS | No | No | No |
Paraguay | PY | PYG | 70 KGS | No | No | No |
Peru | PE | PES | 70 KGS | Yes | No | No |
Philippines | PH | PHP | 70 KGS | Yes | Yes | No |
Poland | PL | PLZ | 70 KGS | No | Yes | Yes |
Portugal(EU Member) | PT | EUR | 70 KGS | No | Yes | Yes |
Puerto Rico | PR | USD | 150 LBS | Yes | Yes | No |
Qatar | QA | QAR | 70 KGS | No | No | No |
Reunion Is. | RE | FRF | 70 KGS | No | Yes | No |
Romania | RO | ROL | 70 KGS | No | Yes | Yes |
Russia | RU | RUR | 70 KGS | No | Yes | No |
Rwanda | RW | RWF | 70 KGS | No | No | No |
Samoa (Amer.) | AS | USD | 70 KGS | No | No | No |
Samoa (Western) | WS | NZD | 70 KGS | No | No | No |
San Marino | IT | ITL | 70 KGS | No | Yes | Yes |
Saudi Arabia | SA | SAR | 70 KGS | No | Yes | No |
Senegal | SN | XOF | 70 KGS | No | No | No |
Serbia & Montenegro | CS | YUD | 70 KGS | No | Yes | Yes |
Seychelles | SC | SCR | 70 KGS | No | No | No |
Sierra Leone | SL | SLL | 70 KGS | No | No | No |
Singapore | SG | SGD | 70 KGS | Yes | Yes | No |
Slovak Republic | SK | SKK | 70 KGS | No | Yes | Yes |
Slovenia | SI | SIT | 70 KGS | No | Yes | Yes |
Solomon Islands | SB | SBD | 70 KGS | No | No | No |
South Africa | ZA | GBP | 70 KGS | Yes | Yes | No |
South Korea | KR | KRW | 70 KGS | No | Yes | No |
Spain (EU Member) | ES | EUR | 70 KGS | Yes | Yes | Yes |
Sri Lanka | LK | LKR | 70 KGS | No | Yes | No |
St. Christopher | KN | XCD | 150 LBS | No | No | No |
St. Lucia | LC | XCD | 150 LBS | No | No | No |
St. Vincent/Grenadines | VC | XCD | 150 LBS | No | No | No |
Sudan | SD | SDP | 70 KGS | No | No | No |
Suriname | SR | SRG | 70 KGS | No | No | No |
Swaziland | SZ | SZL | 70 KGS | No | No | No |
Sweden (EU Member) | SE | SEK | 70 KGS | No | Yes | Yes |
Switzerland | CH | CHF | 70 KGS | Yes | Yes | Yes |
Syria | SY | SYP | 70 KGS | No | No | No |
Taiwan | TW | NTD | 70 KGS | No | Yes | No |
Tajikistan | TJ | RUR | 70 KGS | No | Yes | No |
Tanzania | TZ | TZS | 70 KGS | No | No | No |
Thailand | TH | THB | 70 KGS | No | Yes | No |
Togo | TG | XOF | 70 KGS | No | No | No |
Tonga | TO | TOP | 70 KGS | No | No | No |
Trinidad & Tobago | TT | TTD | 150 LBS | No | No | No |
Tunisia | TN | TND | 70 KGS | No | No | No |
Turkey | TR | TRL | 70 KGS | No | Yes | Yes |
Turkmenistan | TM | RUR | 70 KGS | No | Yes | No |
Turks & Caicos Islands | TC | USD | 150 LBS | No | No | No |
Tuvalu | TV | AUD | 70 KGS | No | No | No |
Uganda | UG | UGS | 70 KGS | No | No | No |
Ukraine | UA | UAK | 70 KGS | No | Yes | No |
United Arab Emirates | AE | AED | 70 KGS | No | No | No |
United Kingdom(EU Member) | GB | GBP | 70 KGS | Yes | Yes | Yes |
United States | US | USD | 150 LBS | Yes | Yes | No |
Uruguay | UY | UYP | 70 KGS | No | Yes | No |
US Virgin Islands | VI | USD | 150 LBS | No | Yes | No |
Uzbekistan | UZ | RUR | 70 KGS | No | Yes | No |
Vanuatu | VU | VUV | 70 KGS | No | No | No |
Venezuela | VE | VEB | 70 KGS | Yes | No | No |
Vietnam | VN | USD | 70 KGS | No | Yes | No |
Wake Island | WK | USD | 70 KGS | No | No | No |
Wallis & Futuna Isle | WF | XPF | 70 KGS | No | No | No |
Yemen | YE | YER | 70 KGS | No | No | No |
Zambia | ZM | ZMK | 70 KGS | No | No | No |
Zimbabwe | ZW | ZWD | 70 KGS | No | No | No |
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_nmfc_code Property
NMFC Code for commodity.
Syntax
def get_commodity_nmfc_code(commodity_idx: int) -> str: ... def set_commodity_nmfc_code(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
NMFC Code for commodity.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_number_of_pieces Property
The total number of packages, cartons, or containers for the commodity line item.
Syntax
def get_commodity_number_of_pieces(commodity_idx: int) -> int: ... def set_commodity_number_of_pieces(commodity_idx: int, value: int) -> None: ...
Default Value
1
Remarks
The total number of packages, cartons, or containers for the commodity line item.
If the Documents is set to False in ship request, the commodity_number_of_pieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_part_number Property
The part number of this commodity line item.
Syntax
def get_commodity_part_number(commodity_idx: int) -> str: ... def set_commodity_part_number(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
The part number of this commodity line item.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_po_number Property
The PO Number for printed reference per commodity.
Syntax
def get_commodity_po_number(commodity_idx: int) -> str: ... def set_commodity_po_number(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
The PO Number for printed reference per commodity.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_quantity Property
Number of units contained in this commodity line item measured in units specified by the QuantityUnit .
Syntax
def get_commodity_quantity(commodity_idx: int) -> int: ... def set_commodity_quantity(commodity_idx: int, value: int) -> None: ...
Default Value
1
Remarks
Number of units contained in this commodity line item measured in units specified by the commodity_quantity_unit. This is used in conjunction with the commodity_quantity_unit and commodity_unit_price.
If the Documents is set to False in ship request, the commodity_quantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_quantity_unit Property
Unit of measure used to express the Quantity of this commodity line item.
Syntax
def get_commodity_quantity_unit(commodity_idx: int) -> str: ... def set_commodity_quantity_unit(commodity_idx: int, value: str) -> None: ...
Default Value
"EA"
Remarks
Unit of measure used to express the commodity_quantity of this commodity line item.
If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_quantity_unit is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.
Here is a list of possible values for FedEx:
Value | Description |
AR | Carat |
CG | Centigram |
CM | Centimeters |
CM3 | Cubic Centimeters |
CFT | Cubic Feet |
M3 | Cubic Meters |
DOZ | Dozen |
DPR | Dozen Pair |
EA | Each |
GAL | Gallon |
G | Grams |
GR | Gross |
KGM | Kilogram |
KG | Kilograms |
LFT | Linear Foot |
LNM | Linear Meters |
LYD | Linear Yard |
L | Liter |
LTR | Liters |
M | Meters |
MG | Milligram |
ML | Milliliter |
NO | Number |
OZ | Ounces |
PR | Pair |
PRS | Pairs |
PCS | Pieces |
LB | Pound |
CM2 | Square centimeters |
SFT | Square feet |
SQI | Square inches |
M2 | Square meters |
SYD | Square yards |
YD | Yard |
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_unit_price Property
Value of each QuantityUnit in Quantity of this commodity line item.
Syntax
def get_commodity_unit_price(commodity_idx: int) -> str: ... def set_commodity_unit_price(commodity_idx: int, value: str) -> None: ...
Default Value
"1.00"
Remarks
Value of each commodity_quantity_unit in commodity_quantity of this commodity line item. This is used in conjunction with the commodity_quantity_unit and commodity_quantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.
When the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_unit_price is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.
Format: Limit to 6 digits after the decimal (e.g. 900.000000).
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_value Property
The value of an individual item being shipped.
Syntax
def get_commodity_value(commodity_idx: int) -> str: ... def set_commodity_value(commodity_idx: int, value: str) -> None: ...
Default Value
""
Remarks
The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_volume Property
This should contain the volume of the freight item.
Syntax
def get_commodity_volume(commodity_idx: int) -> str: ... def set_commodity_volume(commodity_idx: int, value: str) -> None: ...
Default Value
"0.0"
Remarks
This should contain the volume of the freight item. This should be specified in cubic feet if SizeUnit is set to IN and cubic meters if SizeUnit is set to CM.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_weight Property
The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.
Syntax
def get_commodity_weight(commodity_idx: int) -> str: ... def set_commodity_weight(commodity_idx: int, value: str) -> None: ...
Default Value
"0.00"
Remarks
The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.
If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_weight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
commodity_width Property
The width of the commodity.
Syntax
def get_commodity_width(commodity_idx: int) -> int: ... def set_commodity_width(commodity_idx: int, value: int) -> None: ...
Default Value
1
Remarks
The width of the commodity.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.
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.
duties_payor_account_number Property
The account number of the party responsible for payment (shipping charges, or duties and taxes).
Syntax
def get_duties_payor_account_number() -> str: ... def set_duties_payor_account_number(value: str) -> None: ...
duties_payor_account_number = property(get_duties_payor_account_number, set_duties_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 duties_payor_payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to duties_payor_account_number.
duties_payor_country_code Property
The country code for the payor of the shipment, or duties and taxes.
Syntax
def get_duties_payor_country_code() -> str: ... def set_duties_payor_country_code(value: str) -> None: ...
duties_payor_country_code = property(get_duties_payor_country_code, set_duties_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 duties_payor_country_code is required to be provided in the ship request only if duties_payor_payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the duties_payor_country_code is required only if duties_payor_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.
duties_payor_type Property
Method of payment for shipment, or duties and taxes.
Syntax
def get_duties_payor_type() -> int: ... def set_duties_payor_type(value: int) -> None: ...
duties_payor_type = property(get_duties_payor_type, set_duties_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 duties_payor_account_number and duties_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 duties_payor_account_number is automatically set to ups_account_number. When ptRecipient is specified, duties_payor_account_number and duties_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 duties_payor_account_number, duties_payor_zip_code and duties_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.
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
Whether 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
Whether to automatically detect and use firewall system settings, if available.
firewall_type Property
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
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
The name or IP address of the 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
The name or IP address of the 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
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
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
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
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
A username if authentication is to be used when 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
A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property 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 |
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 Name | Country Code |
Afghanistan | AF |
Albania | AL |
American Samoa | AS |
Andorra | AD |
Angola | AO |
Anguilla | AI |
Antigua | AG* |
Argentina | AR |
Armenia | AM |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaijan | AZ |
Bahamas | BS |
Bahrain | BH |
Bangladesh | BD |
Barbados | BB |
Barbuda | AG* |
Belarus | BY |
Belgium | BE |
Belize | BZ |
Benin | BJ |
Bermuda | BM |
Bhutan | BT |
Bolivia | BO |
Bonaire | AN** |
Bosnia-Herzegovina | BA |
Botswana | BW |
Brazil | BR |
British Virgin Islands | VG* |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cambodia | KH |
Cameroon | CM |
Canada | CA |
Canary Islands | ES** |
Cape Verde | CV |
Cayman Islands | KY** |
Chad | TD |
Channel Islands | GB** |
Chile | CL |
China | CN |
Colombia | CO |
Congo | CG |
Congo Dem. Rep. Of | CD |
Cook Islands | CK |
Costa Rica | CR |
Croatia | HR |
Curacao | AN** |
Cyprus | CY |
Czech Republic | CZ |
Denmark | DK |
Djibouti | DJ |
Dominica | DM |
Dominican Republic | DO |
East Timor | TL |
Ecuador | EC |
Egypt | EG |
El Salvador | SV |
England | GB** |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
Ethiopia | ET |
Faeroe Islands | FO* |
Fiji | FJ |
Finland | FI |
France | FR |
French Guiana | GF |
French Polynesia | PF** |
Gabon | GA |
Gambia | GM |
Georgia | GE |
Germany | DE |
Ghana | GH |
Gibraltar | GI |
Grand Cayman | KY** |
Great Britain | GB** |
Great Thatch Island | VG* |
Great Tobago Islands | VG* |
Greece | GR |
Greenland | GL |
Grenada | GD |
Guadeloupe | GP** |
Guam | GU |
Guatemala | GT |
Guinea | GN |
Guyana | GY |
Haiti | HT |
Holland | NL** |
Honduras | HN |
Hong Kong | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iraq | IQ |
Ireland | IE |
Israel | IL |
Italy | IT** |
Ivory Coast | CI |
Jamaica | JM |
Japan | JP |
Jordan | JO |
Jost Van Dyke Islands | VG* |
Kazakhstan | KZ |
Kenya | KE |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Liechtenstein | LI |
Lithuania | LT |
Luxembourg | LU |
Macau | MO |
Macedonia | MK |
Madagascar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Mexico | MX |
Micronesia | FM |
Moldova | MD |
Monaco | MC |
Mongolia | MN |
Montserrat | MS |
Morocco | MA |
Mozambique | MZ |
Namibia | NA |
Nepal | NP |
Netherlands | NL** |
Netherlands Antilles | AN** |
New Caledonia | NC |
New Zealand | NZ |
Nicaragua | NI |
Niger | NE |
Nigeria | NG |
Norman Island | VG* |
Northern Ireland | GB** |
Northern Mariana Islands | MP** |
Norway | NO |
Oman | OM |
Pakistan | PK |
Palau | PW |
Palestine | PS* |
Panama | PA |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunion | RE |
Romania | RO |
Rota | MP** |
Russia | RU |
Rwanda | RW |
Saba | AN** |
Saipan | MP** |
Samoa | WS |
San Marino | IT** |
Saudi Arabia | SA |
Scotland | GB** |
Senegal | SN |
Serbia & Montenegro | CS |
Seychelles | SC |
Singapore | SG |
Slovak Republic | SK |
Slovenia | SI |
South Africa | ZA |
South Korea | KR |
Spain | ES** |
Sri Lanka | LK |
St. Barthelemy | GP** |
St. Christopher | KN** |
St. Croix Island | VI** |
St. Eustatius | AN** |
St. John | VI** |
St. Kitts and Nevis | KN** |
St. Lucia | LC |
St. Maarten | AN** |
St. Thomas | VI** |
St. Vincent | VC** |
Suriname | SR |
Swaziland | SZ |
Sweden | SE |
Switzerland | CH |
Tahiti | PF** |
Taiwan | TW |
Tanzania | TZ |
Thailand | TH |
Tinian | MP** |
Togo | TG |
Tonga | TO |
Tortola Island | VG* |
Trinidad & Tobago | TT |
Tunisia | TN |
Turkey | TR |
Turkmenistan | TM |
Turks & Caicos Islands | TC |
U.S. Virgin Islands | VI** |
Uganda | UG |
Ukraine | UA |
Union Island | VC** |
United Arab Emirates | AE |
United Kingdom | GB** |
United States | US |
Uruguay | UY |
Uzbekistan | UZ |
Vanuatu | VU |
Vatican City | IT** |
Venezuela | VE |
Vietnam | VN |
Wales | GB** |
Wallis & Futuna Islands | WF |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
Country Name | Country Code |
Cayman Islands | KY |
French Polynesia | PF |
Guadeloupe | GP |
Italy | IT |
Netherlands | NL |
Netherlands Antilles | AN |
Northern Mariana Islands | MP |
Spain | ES |
St. Kitts and Nevis | KN |
St. Vincent | VC |
United Kingdom | GB |
U.S. Virgin Islands | VI |
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.
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.
When shipping internationally, this cannot exceed the total_customs_value
intl_export_controlled_export_type Property
The controlled export type.
Syntax
def get_intl_export_controlled_export_type() -> int: ... def set_intl_export_controlled_export_type(value: int) -> None: ...
intl_export_controlled_export_type = property(get_intl_export_controlled_export_type, set_intl_export_controlled_export_type)
Default Value
0
Remarks
This specifies the type of permit to be used for shipments that are controlled by the US State Department or the US Drug Enforcement Agency.
This only applies when the service_type is stFedExInternationalPriority or stFedExInternationalPriorityFreight.
Note this only applies when shipping internationally.
intl_export_entry_number Property
The entry number for the controlled export.
Syntax
def get_intl_export_entry_number() -> str: ... def set_intl_export_entry_number(value: str) -> None: ...
intl_export_entry_number = property(get_intl_export_entry_number, set_intl_export_entry_number)
Default Value
""
Remarks
This specifies the entry number for any shipments that are controlled by the US State Department or the US Drug Enforcement Agency.
This only applies when the service_type is stFedExInternationalPriority or stFedExInternationalPriorityFreight.
Note this only applies when shipping internationally.
intl_export_foreign_trade_zone_code Property
The foreign trade zone code.
Syntax
def get_intl_export_foreign_trade_zone_code() -> str: ... def set_intl_export_foreign_trade_zone_code(value: str) -> None: ...
intl_export_foreign_trade_zone_code = property(get_intl_export_foreign_trade_zone_code, set_intl_export_foreign_trade_zone_code)
Default Value
""
Remarks
This specifies the trade zone for shipments that are controlled by the US State Department or the US Drug Enforcement Agency.
This only applies when the service_type is stFedExInternationalPriority or stFedExInternationalPriorityFreight.
Note this only applies when shipping internationally.
intl_export_license_number Property
The license or permit number.
Syntax
def get_intl_export_license_number() -> str: ... def set_intl_export_license_number(value: str) -> None: ...
intl_export_license_number = property(get_intl_export_license_number, set_intl_export_license_number)
Default Value
""
Remarks
This should be set to the license or permit number to be used when the International Controlled Export option (0x00010000L) or International Traffic in arms Regulations option (0x10000000000L) is selected in the shipment_special_services
Note this only applies when shipping internationally.
intl_export_license_number_expiration Property
The license or permit number expiration date.
Syntax
def get_intl_export_license_number_expiration() -> str: ... def set_intl_export_license_number_expiration(value: str) -> None: ...
intl_export_license_number_expiration = property(get_intl_export_license_number_expiration, set_intl_export_license_number_expiration)
Default Value
""
Remarks
This should be set to the expiration date for the license or permit to be used when the International Controlled Export option (0x00010000L) is selected in the shipment_special_services
Note this only applies when shipping internationally.
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) |
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.
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.
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).
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
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.
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:
- package_base_charge
- package_dangerous_goods_accessible
- package_dangerous_goods_options
- package_description
- package_height
- package_id
- package_insured_value
- package_length
- package_net_charge
- package_reference
- package_shipping_label
- package_shipping_label_file
- package_signature_type
- package_special_services
- package_total_discount
- package_total_surcharges
- package_tracking_number
- package_type
- package_weight
- package_width
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_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.
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_id Property
An 8-digit Unique Parcel Identification Number.
Syntax
def get_package_id(package_idx: int) -> str: ... def set_package_id(package_idx: int, value: str) -> None: ...
Default Value
""
Remarks
An 8-digit Unique Parcel Identification Number.
Unique number used to identify the package. This property is optional, and only applies to USPS return labels.
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 value | Meaning |
CR | Customer Reference - this gets printed on shipping label and invoice. |
BL | Bill Of Lading - this gets printed on shipping label, Ground shipping reports, and in the Customer Reference element on the invoice. |
IN | Invoice Number - this gets printed on shipping label and invoice. |
PO | Purchase Order Number - this gets printed on shipping label and invoice. |
DN | Department Number - this gets printed on shipping label and invoice. |
SI | Shipment Integrity - this gets printed on invoice only. |
SN | Store Number - this gets printed on shipping label and invoice. |
IR | Intracountry Reglatory Reference |
EPC | Electronic Product Code |
RMA | RMA Number |
The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the 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 Freight | UPS | |
0x00000001 | Appointment Delivery | X | |||
0x00000002 | Dangerous Goods | X | X | X | |
0x00000004 | Dry Ice | X | |||
0x00000008 | Priority Alert | X | |||
0x00000010 | Non Standard Container | X | X | ||
0x00000020 | COD | X | X | ||
0x00000040 | Additional Handling | X | |||
0x00000080 | Signature Option | X | |||
0x00000100 | Alcohol | X |
For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the 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_payment_type Property
The payment type for the pickup.
Syntax
def get_pickup_payment_type() -> int: ... def set_pickup_payment_type(value: int) -> None: ...
pickup_payment_type = property(get_pickup_payment_type, set_pickup_payment_type)
Default Value
0
Remarks
This indicates the payment method to be used for a pickup.
Note that if pptCreditCard is selected, FedEx will use the credit card on file with the account associated with the fed_ex_account_number
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
The 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
The 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 class 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
Whether 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
Whether to automatically detect and use proxy system settings, if available. The default value is False.
proxy_password Property
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
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 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.
proxy_port Property
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
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
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
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
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
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.
Value | Meaning |
0x00000001 | POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses. |
0x00000002 | Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial. |
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 Name | Country Code |
Afghanistan | AF |
Albania | AL |
American Samoa | AS |
Andorra | AD |
Angola | AO |
Anguilla | AI |
Antigua | AG* |
Argentina | AR |
Armenia | AM |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaijan | AZ |
Bahamas | BS |
Bahrain | BH |
Bangladesh | BD |
Barbados | BB |
Barbuda | AG* |
Belarus | BY |
Belgium | BE |
Belize | BZ |
Benin | BJ |
Bermuda | BM |
Bhutan | BT |
Bolivia | BO |
Bonaire | AN** |
Bosnia-Herzegovina | BA |
Botswana | BW |
Brazil | BR |
British Virgin Islands | VG* |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cambodia | KH |
Cameroon | CM |
Canada | CA |
Canary Islands | ES** |
Cape Verde | CV |
Cayman Islands | KY** |
Chad | TD |
Channel Islands | GB** |
Chile | CL |
China | CN |
Colombia | CO |
Congo | CG |
Congo Dem. Rep. Of | CD |
Cook Islands | CK |
Costa Rica | CR |
Croatia | HR |
Curacao | AN** |
Cyprus | CY |
Czech Republic | CZ |
Denmark | DK |
Djibouti | DJ |
Dominica | DM |
Dominican Republic | DO |
East Timor | TL |
Ecuador | EC |
Egypt | EG |
El Salvador | SV |
England | GB** |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
Ethiopia | ET |
Faeroe Islands | FO* |
Fiji | FJ |
Finland | FI |
France | FR |
French Guiana | GF |
French Polynesia | PF** |
Gabon | GA |
Gambia | GM |
Georgia | GE |
Germany | DE |
Ghana | GH |
Gibraltar | GI |
Grand Cayman | KY** |
Great Britain | GB** |
Great Thatch Island | VG* |
Great Tobago Islands | VG* |
Greece | GR |
Greenland | GL |
Grenada | GD |
Guadeloupe | GP** |
Guam | GU |
Guatemala | GT |
Guinea | GN |
Guyana | GY |
Haiti | HT |
Holland | NL** |
Honduras | HN |
Hong Kong | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iraq | IQ |
Ireland | IE |
Israel | IL |
Italy | IT** |
Ivory Coast | CI |
Jamaica | JM |
Japan | JP |
Jordan | JO |
Jost Van Dyke Islands | VG* |
Kazakhstan | KZ |
Kenya | KE |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Liechtenstein | LI |
Lithuania | LT |
Luxembourg | LU |
Macau | MO |
Macedonia | MK |
Madagascar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Mexico | MX |
Micronesia | FM |
Moldova | MD |
Monaco | MC |
Mongolia | MN |
Montserrat | MS |
Morocco | MA |
Mozambique | MZ |
Namibia | NA |
Nepal | NP |
Netherlands | NL** |
Netherlands Antilles | AN** |
New Caledonia | NC |
New Zealand | NZ |
Nicaragua | NI |
Niger | NE |
Nigeria | NG |
Norman Island | VG* |
Northern Ireland | GB** |
Northern Mariana Islands | MP** |
Norway | NO |
Oman | OM |
Pakistan | PK |
Palau | PW |
Palestine | PS* |
Panama | PA |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunion | RE |
Romania | RO |
Rota | MP** |
Russia | RU |
Rwanda | RW |
Saba | AN** |
Saipan | MP** |
Samoa | WS |
San Marino | IT** |
Saudi Arabia | SA |
Scotland | GB** |
Senegal | SN |
Serbia & Montenegro | CS |
Seychelles | SC |
Singapore | SG |
Slovak Republic | SK |
Slovenia | SI |
South Africa | ZA |
South Korea | KR |
Spain | ES** |
Sri Lanka | LK |
St. Barthelemy | GP** |
St. Christopher | KN** |
St. Croix Island | VI** |
St. Eustatius | AN** |
St. John | VI** |
St. Kitts and Nevis | KN** |
St. Lucia | LC |
St. Maarten | AN** |
St. Thomas | VI** |
St. Vincent | VC** |
Suriname | SR |
Swaziland | SZ |
Sweden | SE |
Switzerland | CH |
Tahiti | PF** |
Taiwan | TW |
Tanzania | TZ |
Thailand | TH |
Tinian | MP** |
Togo | TG |
Tonga | TO |
Tortola Island | VG* |
Trinidad & Tobago | TT |
Tunisia | TN |
Turkey | TR |
Turkmenistan | TM |
Turks & Caicos Islands | TC |
U.S. Virgin Islands | VI** |
Uganda | UG |
Ukraine | UA |
Union Island | VC** |
United Arab Emirates | AE |
United Kingdom | GB** |
United States | US |
Uruguay | UY |
Uzbekistan | UZ |
Vanuatu | VU |
Vatican City | IT** |
Venezuela | VE |
Vietnam | VN |
Wales | GB** |
Wallis & Futuna Islands | WF |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
Country Name | Country Code |
Cayman Islands | KY |
French Polynesia | PF |
Guadeloupe | GP |
Italy | IT |
Netherlands | NL |
Netherlands Antilles | AN |
Northern Mariana Islands | MP |
Spain | ES |
St. Kitts and Nevis | KN |
St. Vincent | VC |
United Kingdom | GB |
U.S. Virgin Islands | VI |
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.
requested_etd_documents Property
Specifies which document type to request copies of when using Electronic Trade Document Special Service.
Syntax
def get_requested_etd_documents() -> int: ... def set_requested_etd_documents(value: int) -> None: ...
requested_etd_documents = property(get_requested_etd_documents, set_requested_etd_documents)
Default Value
0
Remarks
This specifies which documents you would like to get copies of when using FedEx Special Services to generate and send the documents electronically (Electronic Trade Documents option is set in the shipment_special_services). Note that not all customs offices support 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.
Make sure to specify in the ShippingDocumentFile config the location where you want to save the documents.
To request one or more ETD documents be generated by FedEx you will need to set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Description |
0x0 | None |
0x1 | Certificate of Origin |
0x2 | Commercial Invoice |
0x4 | NAFTA Certificate of Origin |
Note this only applies when shipping internationally.
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.
Value | Meaning |
0x00000001 | POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses. |
0x00000002 | Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial. |
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 Name | Country Code |
Afghanistan | AF |
Albania | AL |
American Samoa | AS |
Andorra | AD |
Angola | AO |
Anguilla | AI |
Antigua | AG* |
Argentina | AR |
Armenia | AM |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaijan | AZ |
Bahamas | BS |
Bahrain | BH |
Bangladesh | BD |
Barbados | BB |
Barbuda | AG* |
Belarus | BY |
Belgium | BE |
Belize | BZ |
Benin | BJ |
Bermuda | BM |
Bhutan | BT |
Bolivia | BO |
Bonaire | AN** |
Bosnia-Herzegovina | BA |
Botswana | BW |
Brazil | BR |
British Virgin Islands | VG* |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cambodia | KH |
Cameroon | CM |
Canada | CA |
Canary Islands | ES** |
Cape Verde | CV |
Cayman Islands | KY** |
Chad | TD |
Channel Islands | GB** |
Chile | CL |
China | CN |
Colombia | CO |
Congo | CG |
Congo Dem. Rep. Of | CD |
Cook Islands | CK |
Costa Rica | CR |
Croatia | HR |
Curacao | AN** |
Cyprus | CY |
Czech Republic | CZ |
Denmark | DK |
Djibouti | DJ |
Dominica | DM |
Dominican Republic | DO |
East Timor | TL |
Ecuador | EC |
Egypt | EG |
El Salvador | SV |
England | GB** |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
Ethiopia | ET |
Faeroe Islands | FO* |
Fiji | FJ |
Finland | FI |
France | FR |
French Guiana | GF |
French Polynesia | PF** |
Gabon | GA |
Gambia | GM |
Georgia | GE |
Germany | DE |
Ghana | GH |
Gibraltar | GI |
Grand Cayman | KY** |
Great Britain | GB** |
Great Thatch Island | VG* |
Great Tobago Islands | VG* |
Greece | GR |
Greenland | GL |
Grenada | GD |
Guadeloupe | GP** |
Guam | GU |
Guatemala | GT |
Guinea | GN |
Guyana | GY |
Haiti | HT |
Holland | NL** |
Honduras | HN |
Hong Kong | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iraq | IQ |
Ireland | IE |
Israel | IL |
Italy | IT** |
Ivory Coast | CI |
Jamaica | JM |
Japan | JP |
Jordan | JO |
Jost Van Dyke Islands | VG* |
Kazakhstan | KZ |
Kenya | KE |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Liechtenstein | LI |
Lithuania | LT |
Luxembourg | LU |
Macau | MO |
Macedonia | MK |
Madagascar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Mexico | MX |
Micronesia | FM |
Moldova | MD |
Monaco | MC |
Mongolia | MN |
Montserrat | MS |
Morocco | MA |
Mozambique | MZ |
Namibia | NA |
Nepal | NP |
Netherlands | NL** |
Netherlands Antilles | AN** |
New Caledonia | NC |
New Zealand | NZ |
Nicaragua | NI |
Niger | NE |
Nigeria | NG |
Norman Island | VG* |
Northern Ireland | GB** |
Northern Mariana Islands | MP** |
Norway | NO |
Oman | OM |
Pakistan | PK |
Palau | PW |
Palestine | PS* |
Panama | PA |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunion | RE |
Romania | RO |
Rota | MP** |
Russia | RU |
Rwanda | RW |
Saba | AN** |
Saipan | MP** |
Samoa | WS |
San Marino | IT** |
Saudi Arabia | SA |
Scotland | GB** |
Senegal | SN |
Serbia & Montenegro | CS |
Seychelles | SC |
Singapore | SG |
Slovak Republic | SK |
Slovenia | SI |
South Africa | ZA |
South Korea | KR |
Spain | ES** |
Sri Lanka | LK |
St. Barthelemy | GP** |
St. Christopher | KN** |
St. Croix Island | VI** |
St. Eustatius | AN** |
St. John | VI** |
St. Kitts and Nevis | KN** |
St. Lucia | LC |
St. Maarten | AN** |
St. Thomas | VI** |
St. Vincent | VC** |
Suriname | SR |
Swaziland | SZ |
Sweden | SE |
Switzerland | CH |
Tahiti | PF** |
Taiwan | TW |
Tanzania | TZ |
Thailand | TH |
Tinian | MP** |
Togo | TG |
Tonga | TO |
Tortola Island | VG* |
Trinidad & Tobago | TT |
Tunisia | TN |
Turkey | TR |
Turkmenistan | TM |
Turks & Caicos Islands | TC |
U.S. Virgin Islands | VI** |
Uganda | UG |
Ukraine | UA |
Union Island | VC** |
United Arab Emirates | AE |
United Kingdom | GB** |
United States | US |
Uruguay | UY |
Uzbekistan | UZ |
Vanuatu | VU |
Vatican City | IT** |
Venezuela | VE |
Vietnam | VN |
Wales | GB** |
Wallis & Futuna Islands | WF |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
Country Name | Country Code |
Cayman Islands | KY |
French Polynesia | PF |
Guadeloupe | GP |
Italy | IT |
Netherlands | NL |
Netherlands Antilles | AN |
Northern Mariana Islands | MP |
Spain | ES |
St. Kitts and Nevis | KN |
St. Vincent | VC |
United Kingdom | GB |
U.S. Virgin Islands | VI |
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.
Value | Meaning |
0x00000001 | POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses. |
0x00000002 | Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial. |
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 Name | Country Code |
Afghanistan | AF |
Albania | AL |
American Samoa | AS |
Andorra | AD |
Angola | AO |
Anguilla | AI |
Antigua | AG* |
Argentina | AR |
Armenia | AM |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaijan | AZ |
Bahamas | BS |
Bahrain | BH |
Bangladesh | BD |
Barbados | BB |
Barbuda | AG* |
Belarus | BY |
Belgium | BE |
Belize | BZ |
Benin | BJ |
Bermuda | BM |
Bhutan | BT |
Bolivia | BO |
Bonaire | AN** |
Bosnia-Herzegovina | BA |
Botswana | BW |
Brazil | BR |
British Virgin Islands | VG* |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cambodia | KH |
Cameroon | CM |
Canada | CA |
Canary Islands | ES** |
Cape Verde | CV |
Cayman Islands | KY** |
Chad | TD |
Channel Islands | GB** |
Chile | CL |
China | CN |
Colombia | CO |
Congo | CG |
Congo Dem. Rep. Of | CD |
Cook Islands | CK |
Costa Rica | CR |
Croatia | HR |
Curacao | AN** |
Cyprus | CY |
Czech Republic | CZ |
Denmark | DK |
Djibouti | DJ |
Dominica | DM |
Dominican Republic | DO |
East Timor | TL |
Ecuador | EC |
Egypt | EG |
El Salvador | SV |
England | GB** |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
Ethiopia | ET |
Faeroe Islands | FO* |
Fiji | FJ |
Finland | FI |
France | FR |
French Guiana | GF |
French Polynesia | PF** |
Gabon | GA |
Gambia | GM |
Georgia | GE |
Germany | DE |
Ghana | GH |
Gibraltar | GI |
Grand Cayman | KY** |
Great Britain | GB** |
Great Thatch Island | VG* |
Great Tobago Islands | VG* |
Greece | GR |
Greenland | GL |
Grenada | GD |
Guadeloupe | GP** |
Guam | GU |
Guatemala | GT |
Guinea | GN |
Guyana | GY |
Haiti | HT |
Holland | NL** |
Honduras | HN |
Hong Kong | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iraq | IQ |
Ireland | IE |
Israel | IL |
Italy | IT** |
Ivory Coast | CI |
Jamaica | JM |
Japan | JP |
Jordan | JO |
Jost Van Dyke Islands | VG* |
Kazakhstan | KZ |
Kenya | KE |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Liechtenstein | LI |
Lithuania | LT |
Luxembourg | LU |
Macau | MO |
Macedonia | MK |
Madagascar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Mexico | MX |
Micronesia | FM |
Moldova | MD |
Monaco | MC |
Mongolia | MN |
Montserrat | MS |
Morocco | MA |
Mozambique | MZ |
Namibia | NA |
Nepal | NP |
Netherlands | NL** |
Netherlands Antilles | AN** |
New Caledonia | NC |
New Zealand | NZ |
Nicaragua | NI |
Niger | NE |
Nigeria | NG |
Norman Island | VG* |
Northern Ireland | GB** |
Northern Mariana Islands | MP** |
Norway | NO |
Oman | OM |
Pakistan | PK |
Palau | PW |
Palestine | PS* |
Panama | PA |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunion | RE |
Romania | RO |
Rota | MP** |
Russia | RU |
Rwanda | RW |
Saba | AN** |
Saipan | MP** |
Samoa | WS |
San Marino | IT** |
Saudi Arabia | SA |
Scotland | GB** |
Senegal | SN |
Serbia & Montenegro | CS |
Seychelles | SC |
Singapore | SG |
Slovak Republic | SK |
Slovenia | SI |
South Africa | ZA |
South Korea | KR |
Spain | ES** |
Sri Lanka | LK |
St. Barthelemy | GP** |
St. Christopher | KN** |
St. Croix Island | VI** |
St. Eustatius | AN** |
St. John | VI** |
St. Kitts and Nevis | KN** |
St. Lucia | LC |
St. Maarten | AN** |
St. Thomas | VI** |
St. Vincent | VC** |
Suriname | SR |
Swaziland | SZ |
Sweden | SE |
Switzerland | CH |
Tahiti | PF** |
Taiwan | TW |
Tanzania | TZ |
Thailand | TH |
Tinian | MP** |
Togo | TG |
Tonga | TO |
Tortola Island | VG* |
Trinidad & Tobago | TT |
Tunisia | TN |
Turkey | TR |
Turkmenistan | TM |
Turks & Caicos Islands | TC |
U.S. Virgin Islands | VI** |
Uganda | UG |
Ukraine | UA |
Union Island | VC** |
United Arab Emirates | AE |
United Kingdom | GB** |
United States | US |
Uruguay | UY |
Uzbekistan | UZ |
Vanuatu | VU |
Vatican City | IT** |
Venezuela | VE |
Vietnam | VN |
Wales | GB** |
Wallis & Futuna Islands | WF |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
Country Name | Country Code |
Cayman Islands | KY |
French Polynesia | PF |
Guadeloupe | GP |
Italy | IT |
Netherlands | NL |
Netherlands Antilles | AN |
Northern Mariana Islands | MP |
Spain | ES |
St. Kitts and Nevis | KN |
St. Vincent | VC |
United Kingdom | GB |
U.S. Virgin Islands | VI |
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.
Possible values are:
stFedEx1DayFreight (17) | A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment. |
stFedEx2DayFreight (18) | |
stFedEx3DayFreight (19) | |
stFedExInternationalPriorityFreight (23) | package_type should be set to Your Packaging. A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment. |
stFedExInternationalEconomyFreight (24) | package_type should be set to Your Packaging. Advanced confirmation is required for this service. Call 1.800.332.0807 to book your freight shipment. |
stFedExFirstFreight (28) | package_type should be set to Your Packaging. Also the maximum declared value for the shipment is $50,000 USD. |
stFedExFreightEconomy (30) | |
stFedExFreightPriority (31) |
For all services, the following guidelines apply:
- Packages/skids must wight more than 150 lbs.
- Individual pallets/skids weighing in excess of 2200 lbs or larger than 70" in height, 119" in length, or 80" in width require prior approval by FedEx.
- Service days are Monday through Friday, with Saturday pickup and delivery available to many major markets.
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_info_account_number Property
This is the account number to be used with a freight shipment.
Syntax
def get_shipment_info_account_number() -> str: ... def set_shipment_info_account_number(value: str) -> None: ...
shipment_info_account_number = property(get_shipment_info_account_number, set_shipment_info_account_number)
Default Value
""
Remarks
This is the account number to be used with a freight shipment. This is required when submitting a freight shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_account_number Property
This should be set to the alternate account number to be billed.
Syntax
def get_shipment_info_alternate_billing_account_number() -> str: ... def set_shipment_info_alternate_billing_account_number(value: str) -> None: ...
shipment_info_alternate_billing_account_number = property(get_shipment_info_alternate_billing_account_number, set_shipment_info_alternate_billing_account_number)
Default Value
""
Remarks
This should be set to the alternate account number to be billed. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_city Property
This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_city() -> str: ... def set_shipment_info_alternate_billing_city(value: str) -> None: ...
shipment_info_alternate_billing_city = property(get_shipment_info_alternate_billing_city, set_shipment_info_alternate_billing_city)
Default Value
""
Remarks
This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_company_name Property
This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_company_name() -> str: ... def set_shipment_info_alternate_billing_company_name(value: str) -> None: ...
shipment_info_alternate_billing_company_name = property(get_shipment_info_alternate_billing_company_name, set_shipment_info_alternate_billing_company_name)
Default Value
""
Remarks
This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_country_code Property
This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_country_code() -> str: ... def set_shipment_info_alternate_billing_country_code(value: str) -> None: ...
shipment_info_alternate_billing_country_code = property(get_shipment_info_alternate_billing_country_code, set_shipment_info_alternate_billing_country_code)
Default Value
""
Remarks
This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_person_name Property
This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_person_name() -> str: ... def set_shipment_info_alternate_billing_person_name(value: str) -> None: ...
shipment_info_alternate_billing_person_name = property(get_shipment_info_alternate_billing_person_name, set_shipment_info_alternate_billing_person_name)
Default Value
""
Remarks
This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_phone Property
This should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_phone() -> str: ... def set_shipment_info_alternate_billing_phone(value: str) -> None: ...
shipment_info_alternate_billing_phone = property(get_shipment_info_alternate_billing_phone, set_shipment_info_alternate_billing_phone)
Default Value
""
Remarks
This should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_state Property
This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_state() -> str: ... def set_shipment_info_alternate_billing_state(value: str) -> None: ...
shipment_info_alternate_billing_state = property(get_shipment_info_alternate_billing_state, set_shipment_info_alternate_billing_state)
Default Value
""
Remarks
This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_street_address Property
This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_street_address() -> str: ... def set_shipment_info_alternate_billing_street_address(value: str) -> None: ...
shipment_info_alternate_billing_street_address = property(get_shipment_info_alternate_billing_street_address, set_shipment_info_alternate_billing_street_address)
Default Value
""
Remarks
This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_alternate_billing_zip_code Property
This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber .
Syntax
def get_shipment_info_alternate_billing_zip_code() -> str: ... def set_shipment_info_alternate_billing_zip_code(value: str) -> None: ...
shipment_info_alternate_billing_zip_code = property(get_shipment_info_alternate_billing_zip_code, set_shipment_info_alternate_billing_zip_code)
Default Value
""
Remarks
This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_address1 Property
This should be set to the first address line listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_address1() -> str: ... def set_shipment_info_billing_address1(value: str) -> None: ...
shipment_info_billing_address1 = property(get_shipment_info_billing_address1, set_shipment_info_billing_address1)
Default Value
""
Remarks
This should be set to the first address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_address2 Property
This should be set to the second address line listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_address2() -> str: ... def set_shipment_info_billing_address2(value: str) -> None: ...
shipment_info_billing_address2 = property(get_shipment_info_billing_address2, set_shipment_info_billing_address2)
Default Value
""
Remarks
This should be set to the second address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_city Property
This should be set to the city listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_city() -> str: ... def set_shipment_info_billing_city(value: str) -> None: ...
shipment_info_billing_city = property(get_shipment_info_billing_city, set_shipment_info_billing_city)
Default Value
""
Remarks
This should be set to the city listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_company_name Property
This should be set to the name of the company listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_company_name() -> str: ... def set_shipment_info_billing_company_name(value: str) -> None: ...
shipment_info_billing_company_name = property(get_shipment_info_billing_company_name, set_shipment_info_billing_company_name)
Default Value
""
Remarks
This should be set to the name of the company listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_country_code Property
This should be set to the country code listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_country_code() -> str: ... def set_shipment_info_billing_country_code(value: str) -> None: ...
shipment_info_billing_country_code = property(get_shipment_info_billing_country_code, set_shipment_info_billing_country_code)
Default Value
""
Remarks
This should be set to the country code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_email Property
This should be set to the email address listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_email() -> str: ... def set_shipment_info_billing_email(value: str) -> None: ...
shipment_info_billing_email = property(get_shipment_info_billing_email, set_shipment_info_billing_email)
Default Value
""
Remarks
This should be set to the email address listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_fax Property
This should be set to the fax number listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_fax() -> str: ... def set_shipment_info_billing_fax(value: str) -> None: ...
shipment_info_billing_fax = property(get_shipment_info_billing_fax, set_shipment_info_billing_fax)
Default Value
""
Remarks
This should be set to the fax number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_person_name Property
This should be set to the name of the person listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_person_name() -> str: ... def set_shipment_info_billing_person_name(value: str) -> None: ...
shipment_info_billing_person_name = property(get_shipment_info_billing_person_name, set_shipment_info_billing_person_name)
Default Value
""
Remarks
This should be set to the name of the person listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_phone Property
This should be set to the phone number listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_phone() -> str: ... def set_shipment_info_billing_phone(value: str) -> None: ...
shipment_info_billing_phone = property(get_shipment_info_billing_phone, set_shipment_info_billing_phone)
Default Value
""
Remarks
This should be set to the phone number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_state Property
This should be set to the state listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_state() -> str: ... def set_shipment_info_billing_state(value: str) -> None: ...
shipment_info_billing_state = property(get_shipment_info_billing_state, set_shipment_info_billing_state)
Default Value
""
Remarks
This should be set to the state listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_billing_zip_code Property
This should be set to the zip code listed on the account associated with the FreightAccountNumber .
Syntax
def get_shipment_info_billing_zip_code() -> str: ... def set_shipment_info_billing_zip_code(value: str) -> None: ...
shipment_info_billing_zip_code = property(get_shipment_info_billing_zip_code, set_shipment_info_billing_zip_code)
Default Value
""
Remarks
This should be set to the zip code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_client_discount_percent Property
The estimated client discount rate for a freight shipment.
Syntax
def get_shipment_info_client_discount_percent() -> str: ... def set_shipment_info_client_discount_percent(value: str) -> None: ...
shipment_info_client_discount_percent = property(get_shipment_info_client_discount_percent, set_shipment_info_client_discount_percent)
Default Value
""
Remarks
The estimated client discount rate for a freight shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_collect_terms_type Property
This sets the terms for how to collect payment for this freight shipment.
Syntax
def get_shipment_info_collect_terms_type() -> int: ... def set_shipment_info_collect_terms_type(value: int) -> None: ...
shipment_info_collect_terms_type = property(get_shipment_info_collect_terms_type, set_shipment_info_collect_terms_type)
Default Value
0
Remarks
This sets the terms for how to collect payment for this freight shipment. Default value is 0.
Valid values are as follows:
Value | Meaning |
0 | Standard |
1 | Non-Recourse Shipper Signed |
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_comments Property
The description for this freight shipment.
Syntax
def get_shipment_info_comments() -> str: ... def set_shipment_info_comments(value: str) -> None: ...
shipment_info_comments = property(get_shipment_info_comments, set_shipment_info_comments)
Default Value
""
Remarks
The description for this freight shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_coupons Property
This contains a semicolon delimited list of identifiers for promotional discounts offered to customers.
Syntax
def get_shipment_info_coupons() -> str: ... def set_shipment_info_coupons(value: str) -> None: ...
shipment_info_coupons = property(get_shipment_info_coupons, set_shipment_info_coupons)
Default Value
""
Remarks
This contains a semicolon delimited list of identifiers for promotional discounts offered to customers. For example: coupon1; coupon2; coupon3.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_declared_value Property
The total declared value per unit for this freight shipment.
Syntax
def get_shipment_info_declared_value() -> str: ... def set_shipment_info_declared_value(value: str) -> None: ...
shipment_info_declared_value = property(get_shipment_info_declared_value, set_shipment_info_declared_value)
Default Value
""
Remarks
The total declared value per unit for this freight shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_declared_value_units Property
Identifies the declared value units corresponding to the above defined declared value.
Syntax
def get_shipment_info_declared_value_units() -> str: ... def set_shipment_info_declared_value_units(value: str) -> None: ...
shipment_info_declared_value_units = property(get_shipment_info_declared_value_units, set_shipment_info_declared_value_units)
Default Value
""
Remarks
Identifies the declared value units corresponding to the above defined declared value.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_emergency_contact_phone Property
The phone number for the emergency contact.
Syntax
def get_shipment_info_emergency_contact_phone() -> str: ... def set_shipment_info_emergency_contact_phone(value: str) -> None: ...
shipment_info_emergency_contact_phone = property(get_shipment_info_emergency_contact_phone, set_shipment_info_emergency_contact_phone)
Default Value
""
Remarks
The phone number for the emergency contact. This is required if any of the commodities line items contain hazardous materials.
shipment_info_hazardous_materials_offeror Property
If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.
Syntax
def get_shipment_info_hazardous_materials_offeror() -> str: ... def set_shipment_info_hazardous_materials_offeror(value: str) -> None: ...
shipment_info_hazardous_materials_offeror = property(get_shipment_info_hazardous_materials_offeror, set_shipment_info_hazardous_materials_offeror)
Default Value
""
Remarks
If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_liability_coverage_amount Property
This should be set to the total value of the liability coverage.
Syntax
def get_shipment_info_liability_coverage_amount() -> str: ... def set_shipment_info_liability_coverage_amount(value: str) -> None: ...
shipment_info_liability_coverage_amount = property(get_shipment_info_liability_coverage_amount, set_shipment_info_liability_coverage_amount)
Default Value
""
Remarks
This should be set to the total value of the liability coverage.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_liability_coverage_type Property
This should be set to the type of liability coverage offered.
Syntax
def get_shipment_info_liability_coverage_type() -> int: ... def set_shipment_info_liability_coverage_type(value: int) -> None: ...
shipment_info_liability_coverage_type = property(get_shipment_info_liability_coverage_type, set_shipment_info_liability_coverage_type)
Default Value
0
Remarks
This should be set to the type of liability coverage offered.
Valid values are as follows:
Value | Meaning |
0 | New |
1 | Used or Reconditioned |
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_pallet_weight Property
This should contain the total weight of all pallets used in this freight shipment.
Syntax
def get_shipment_info_pallet_weight() -> str: ... def set_shipment_info_pallet_weight(value: str) -> None: ...
shipment_info_pallet_weight = property(get_shipment_info_pallet_weight, set_shipment_info_pallet_weight)
Default Value
""
Remarks
This should contain the total weight of all pallets used in this freight shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_role Property
This indicates the role of the party is submitting the transaction for this freight shipment.
Syntax
def get_shipment_info_role() -> int: ... def set_shipment_info_role(value: int) -> None: ...
shipment_info_role = property(get_shipment_info_role, set_shipment_info_role)
Default Value
0
Remarks
This indicates the role of the party is submitting the transaction for this freight shipment.
Valid values are as follows:
Value | Meaning |
0 | Shipper |
1 | Consignee |
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_total_handling_units Property
Total number of individual handling units in the entire shipment (for unit pricing).
Syntax
def get_shipment_info_total_handling_units() -> int: ... def set_shipment_info_total_handling_units(value: int) -> None: ...
shipment_info_total_handling_units = property(get_shipment_info_total_handling_units, set_shipment_info_total_handling_units)
Default Value
1
Remarks
Total number of individual handling units in the entire shipment (for unit pricing).
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_total_height Property
This should be set to the total height of the shipment.
Syntax
def get_shipment_info_total_height() -> int: ... def set_shipment_info_total_height(value: int) -> None: ...
shipment_info_total_height = property(get_shipment_info_total_height, set_shipment_info_total_height)
Default Value
0
Remarks
This should be set to the total height of the shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_total_length Property
This should be set to the total length of the shipment.
Syntax
def get_shipment_info_total_length() -> int: ... def set_shipment_info_total_length(value: int) -> None: ...
shipment_info_total_length = property(get_shipment_info_total_length, set_shipment_info_total_length)
Default Value
0
Remarks
This should be set to the total length of the shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_info_total_width Property
This should be set to the total width of the shipment.
Syntax
def get_shipment_info_total_width() -> int: ... def set_shipment_info_total_width(value: int) -> None: ...
shipment_info_total_width = property(get_shipment_info_total_width, set_shipment_info_total_width)
Default Value
0
Remarks
This should be set to the total width of the shipment.
This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
shipment_special_services Property
Contains the collection of special services offered by FedEx.
Syntax
def get_shipment_special_services() -> int: ... def set_shipment_special_services(value: int) -> None: ...
shipment_special_services = property(get_shipment_special_services, set_shipment_special_services)
Default Value
0
Remarks
To request any of the special services offered by FedEx, you must set the shipment_special_services to a set of flags as listed below, the following flags can be or-ed together in order to select multiple options:
Value | Meaning |
0x00000001L | Broker Select |
0x00000004L | COD |
0x00000010L | Dangerous Goods |
0x00000020L | Do Not Break Down Pallets |
0x00000040L | Do Not Stack Pallets |
0x00000080L | Dry Ice |
0x00000200L | Electronic Trade Documents |
0x00000400L | Event Notification |
0x00000800L | Extreme Length |
0x00001000L | Food |
0x00002000L | Freight Guarantee |
0x00008000L | Hold At Location |
0x00010000L | International Controlled Export Service |
0x00040000L | Inside Delivery |
0x00080000L | Inside Pickup |
0x00100000L | Liftgate Delivery |
0x00200000L | Liftgate Pickup |
0x02000000L | Poison |
0x04000000L | Protection From Freezing |
0x10000000L | Saturday Delivery |
0x20000000L | Saturday Pickup |
0x40000000L | Top Load |
0x10000000000L | International Traffic in Arms Regulations |
The meaning and limitations for each special service option are listed below:
- Broker Select:
Indicates that the broker select special service is requested.
When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs
purposes). To request such service, the BrokerSelect option should be set in the 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)
Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
- COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. When set, the cod_total_amount and cod_type properties must be set. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx Freight Economy, and FedEx Freight Priority.
- Dangerous Goods: Indicates that the shipment contains dangerous goods. This service will affect shipping rates and service availability. When set, at least one commodity_hazardous_materials_options must be selected and the shipment_info_emergency_contact_phone must be set Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
- Do Not Break Down Pallets: Indicates that the pallets should not be broken down. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
- Do Not Stack Pallets: Indicates that the pallets should not be stacked. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
- Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
- Electronic Trade Documents:
This only applies when shipping internationally. FedEx will generate and submit your trade documents specified in the
ShippingDocumentTypes electronically and you no longer need to print and attach them. Note that some
countries do not accept Electronic Trade Documents (ETD). For a full list of countries that support ETD you can go to
http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.
If you also want to receive copies of the FedEx generated documents use the requested_etd_documents property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them. Note: This is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
- Event Notification: Indicates that event notification is requested. This might affect the service availability. If this is requested in a ship request, then the notify collection is required to be set. Note that this is only valid for FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
- Extreme Length: This indicates that the pallet is longer than typically allowed. This requires prior clearance with FedEx.
- Food: This indicates that the shipment contains food items. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
- Freight Guarantee: This indicates that the freight shipment is guaranteed for a specific date and time. When set, the freight_guarantee property should be set. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
- Hold At Location: Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, or when recipient_address_flags is set to Residential (i.e., for residential delivery). When this service is requested hold_at_location is required to be provided in the request as well. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Economy Freight, and FedEx International Priority Freight.
- Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Contact FedEx for current surcharge rates. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
- Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Contact FedEx for current surcharge rates. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
- International Controlled Export Service Indicates that the Controlled Export service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability. When set, the intl_export_controlled_export_type, intl_export_entry_number, intl_export_foreign_trade_zone_code, and intl_export_license_number_expiration properties should be set. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
- International Traffic in Arms Regulations Indicates that the Traffic in Arms Regulations service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability. When set, the intl_export_controlled_export_type, intl_export_entry_number, intl_export_foreign_trade_zone_code, and intl_export_license_number_expiration properties should be set. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
- Liftgate Delivery: This indicates that the liftgate delivery service is requested for this shipment. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
- Liftgate Pickup: This indicates that the liftgate pickup service is requested for this shipment. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
- Poison: This indicates that the shipment contains poisonous materials. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
- Protection From Freezing: This indicates that the shipment should be protected from freezing. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
- Saturday Delivery: Requests the shipment be delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and Saturday delivery is desired, the ground option and some express option will not be valid. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx International Priority Freight, and FedEx Freight Priority.
- Saturday Pickup: Requests that the shipment be picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and Saturday pickup is desired, the ground option and some express option will not be valid. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx First Overnight Freight, FedEx International Priority Freight, FedEx Freight Economy, and FedEx Freight Priority.
- Top Load: This indicates that the pallets in this shipment should not have anything stacked on top of them. This might affect the shipping rates and/or service availability. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
ssl_accept_server_cert_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssl_accept_server_cert_effective_date() -> str: ...
ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_accept_server_cert_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssl_accept_server_cert_expiration_date() -> str: ...
ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_accept_server_cert_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_accept_server_cert_extended_key_usage() -> str: ...
ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_accept_server_cert_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint() -> str: ...
ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_accept_server_cert_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...
ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_accept_server_cert_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...
ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_accept_server_cert_issuer Property
The issuer of the certificate.
Syntax
def get_ssl_accept_server_cert_issuer() -> str: ...
ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_accept_server_cert_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key() -> str: ...
ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.
This property is read-only.
ssl_accept_server_cert_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_accept_server_cert_private_key_available() -> bool: ...
ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_accept_server_cert_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key_container() -> str: ...
ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)
Default Value
""
Remarks
The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_accept_server_cert_public_key Property
The public key of the certificate.
Syntax
def get_ssl_accept_server_cert_public_key() -> str: ...
ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_accept_server_cert_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...
ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_accept_server_cert_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssl_accept_server_cert_public_key_length() -> int: ...
ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_accept_server_cert_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssl_accept_server_cert_serial_number() -> str: ...
ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_accept_server_cert_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssl_accept_server_cert_signature_algorithm() -> str: ...
ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_accept_server_cert_store Property
The name of the certificate store for the client certificate.
Syntax
def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ...
ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.
ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
ssl_accept_server_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_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ...
ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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_accept_server_cert_store_type Property
The type of certificate store for this certificate.
Syntax
def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ...
ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)
Default Value
0
Remarks
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_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
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_accept_server_cert_subject_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_accept_server_cert_subject_alt_names() -> str: ...
ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_accept_server_cert_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...
ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...
ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...
ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_usage Property
The text description of UsageFlags .
Syntax
def get_ssl_accept_server_cert_usage() -> str: ...
ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)
Default Value
""
Remarks
The text description of ssl_accept_server_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_accept_server_cert_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssl_accept_server_cert_usage_flags() -> int: ...
ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_accept_server_cert_version Property
The certificate's version number.
Syntax
def get_ssl_accept_server_cert_version() -> str: ...
ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_accept_server_cert_subject Property
The subject of the certificate used for client authentication.
Syntax
def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ...
ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)
Default Value
""
Remarks
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_accept_server_cert_encoded Property
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
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_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_cert_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_cert_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_cert_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_cert_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_cert_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_cert_issuer Property
The issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_cert_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.
This property is read-only.
ssl_cert_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_cert_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
Default Value
""
Remarks
The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_cert_public_key Property
The public key of the certificate.
Syntax
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_cert_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_cert_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_cert_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_cert_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_cert_store Property
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
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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
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
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:
|
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_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_usage Property
The text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
The text description of ssl_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_cert_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_cert_version Property
The certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_cert_subject Property
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
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_cert_encoded Property
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
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_provider Property
The Secure Sockets Layer/Transport Layer Security (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 as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, 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_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssl_server_cert_effective_date() -> str: ...
ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_server_cert_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssl_server_cert_expiration_date() -> str: ...
ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_server_cert_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_server_cert_extended_key_usage() -> str: ...
ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_server_cert_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint() -> str: ...
ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_server_cert_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha1() -> str: ...
ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_server_cert_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha256() -> str: ...
ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_server_cert_issuer Property
The issuer of the certificate.
Syntax
def get_ssl_server_cert_issuer() -> str: ...
ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_server_cert_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssl_server_cert_private_key() -> str: ...
ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.
This property is read-only.
ssl_server_cert_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_server_cert_private_key_available() -> bool: ...
ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_server_cert_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_server_cert_private_key_container() -> str: ...
ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)
Default Value
""
Remarks
The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_server_cert_public_key Property
The public key of the certificate.
Syntax
def get_ssl_server_cert_public_key() -> str: ...
ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_server_cert_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssl_server_cert_public_key_algorithm() -> str: ...
ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_server_cert_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssl_server_cert_public_key_length() -> int: ...
ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_server_cert_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssl_server_cert_serial_number() -> str: ...
ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_server_cert_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssl_server_cert_signature_algorithm() -> str: ...
ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_server_cert_store Property
The name of the certificate store for the client certificate.
Syntax
def get_ssl_server_cert_store() -> bytes: ...
ssl_server_cert_store = property(get_ssl_server_cert_store, None)
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.
ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
This property is read-only.
ssl_server_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_server_cert_store_password() -> str: ...
ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)
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.
This property is read-only.
ssl_server_cert_store_type Property
The type of certificate store for this certificate.
Syntax
def get_ssl_server_cert_store_type() -> int: ...
ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)
Default Value
0
Remarks
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_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
This property is read-only.
ssl_server_cert_subject_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_server_cert_subject_alt_names() -> str: ...
ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_server_cert_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_md5() -> str: ...
ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha1() -> str: ...
ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha256() -> str: ...
ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_usage Property
The text description of UsageFlags .
Syntax
def get_ssl_server_cert_usage() -> str: ...
ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)
Default Value
""
Remarks
The text description of ssl_server_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_server_cert_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssl_server_cert_usage_flags() -> int: ...
ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_server_cert_version Property
The certificate's version number.
Syntax
def get_ssl_server_cert_version() -> str: ...
ssl_server_cert_version = property(get_ssl_server_cert_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_server_cert_subject Property
The subject of the certificate used for client authentication.
Syntax
def get_ssl_server_cert_subject() -> str: ...
ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)
Default Value
""
Remarks
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
ssl_server_cert_encoded Property
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
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.
submitted_by_company Property
Identifies the contact person's company name.
Syntax
def get_submitted_by_company() -> str: ... def set_submitted_by_company(value: str) -> None: ...
submitted_by_company = property(get_submitted_by_company, set_submitted_by_company)
Default Value
""
Remarks
Identifies the contact person's company name. In a ship request, either submitted_by_first_name and submitted_by_last_name or submitted_by_company are required to be provided.
submitted_by_email Property
Identifies the contact person's email address.
Syntax
def get_submitted_by_email() -> str: ... def set_submitted_by_email(value: str) -> None: ...
submitted_by_email = property(get_submitted_by_email, set_submitted_by_email)
Default Value
""
Remarks
Identifies the contact person's email address. Maximum length: 120.
submitted_by_fax Property
Recipient's fax number.
Syntax
def get_submitted_by_fax() -> str: ... def set_submitted_by_fax(value: str) -> None: ...
submitted_by_fax = property(get_submitted_by_fax, set_submitted_by_fax)
Default Value
""
Remarks
Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.
submitted_by_first_name Property
Sender's first name.
Syntax
def get_submitted_by_first_name() -> str: ... def set_submitted_by_first_name(value: str) -> None: ...
submitted_by_first_name = property(get_submitted_by_first_name, set_submitted_by_first_name)
Default Value
""
Remarks
Sender's first name. The value of this property is required. Values for either submitted_by_first_name and submitted_by_last_name or submitted_by_company must be sent.
submitted_by_last_name Property
Person's last name.
Syntax
def get_submitted_by_last_name() -> str: ... def set_submitted_by_last_name(value: str) -> None: ...
submitted_by_last_name = property(get_submitted_by_last_name, set_submitted_by_last_name)
Default Value
""
Remarks
Person's last name. The value of this property is required. Values for either submitted_by_first_name and submitted_by_last_name or submitted_by_company must be sent. Maximum length: 45 characters for both names or company name.
submitted_by_middle_initial Property
Middle initial.
Syntax
def get_submitted_by_middle_initial() -> str: ... def set_submitted_by_middle_initial(value: str) -> None: ...
submitted_by_middle_initial = property(get_submitted_by_middle_initial, set_submitted_by_middle_initial)
Default Value
""
Remarks
Middle initial. The value of this property is optional.
submitted_by_phone Property
Identifies the contact person's phone number.
Syntax
def get_submitted_by_phone() -> str: ... def set_submitted_by_phone(value: str) -> None: ...
submitted_by_phone = property(get_submitted_by_phone, set_submitted_by_phone)
Default Value
""
Remarks
Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.
timeout Property
The 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.
Note: By default, all timeouts are inactivity timeouts, that is, 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_customs_value Property
Total customs value for the shipment.
Syntax
def get_total_customs_value() -> str: ... def set_total_customs_value(value: str) -> None: ...
total_customs_value = property(get_total_customs_value, set_total_customs_value)
Default Value
"0.00"
Remarks
The total_customs_value is required to be provided in an international shipment request. It represents the sum of the values of all commodities, and may include freight, miscellaneous, and insurance charges.
Format: Two explicit decimal positions (e.g. 100.00) with a maximum length of 17 including the decimal.
The following countries require a minimum customs value of $1 USD for all shipment, including document shipments:
Country Name | |
Algeria | |
Australia | |
Belarus | |
Canada | |
China | |
Serbia and Montenegro | |
Georgia | |
Indonesia | |
Japan | |
Kyrgyzstan | |
South Korea | |
Kuwait | |
Libya | |
Moldova | |
Montenegro | |
Mongolia | |
Nepal | |
New Zealand | |
Papua New Guinea | |
Romania | |
Serbia | |
Russian | |
Slovenia | |
Slovak Republic | |
El Salvador | |
Turkmenistan | |
Tonga | |
Uzbekistan | |
Samoa | |
Montenegro |
Note this only applies when shipping internationally.
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).
trailer_size Property
The trailer size.
Syntax
def get_trailer_size() -> int: ... def set_trailer_size(value: int) -> None: ...
trailer_size = property(get_trailer_size, set_trailer_size)
Default Value
0
Remarks
The size of the trailer needed when calling schedule_pickup.
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.
truck_type Property
The type of truck.
Syntax
def get_truck_type() -> int: ... def set_truck_type(value: int) -> None: ...
truck_type = property(get_truck_type, set_truck_type)
Default Value
0
Remarks
This indicates the type of truck needed when schedule_pickup is called.
upload_document_detail_count Property
The number of records in the UploadDocumentDetail arrays.
Syntax
def get_upload_document_detail_count() -> int: ... def set_upload_document_detail_count(value: int) -> None: ...
upload_document_detail_count = property(get_upload_document_detail_count, set_upload_document_detail_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- upload_document_detail_doc_type
- upload_document_detail_document_id
- upload_document_detail_file_content
- upload_document_detail_local_file_name
- upload_document_detail_ship_document
- upload_document_detail_upload_file_name
The array indices start at 0 and end at upload_document_detail_count - 1.
upload_document_detail_doc_type Property
This specifies the document type of the document being uploaded.
Syntax
def get_upload_document_detail_doc_type(upload_document_detail_index: int) -> int: ... def set_upload_document_detail_doc_type(upload_document_detail_index: int, value: int) -> None: ...
Default Value
0
Remarks
This specifies the document type of the document being uploaded.
The valid values are as follows:
Value | Description |
fdtCommercialInvoice (0) | Commercial Invoice |
fdtCertificateOfOrigin (1) | Certificate of Origin |
fdtNAFTACertificateOfOrigin (2) | NAFTA Certificate of Origin |
fdtProFormaInvoice (3) | Pro Forma Invoice |
fdtOther (4) | Other document type |
The upload_document_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_document_detail_count property.
upload_document_detail_document_id Property
Upon a successful request, this is returned in the server reply for each uploaded document.
Syntax
def get_upload_document_detail_document_id(upload_document_detail_index: int) -> str: ...
Default Value
""
Remarks
Upon a successful request, this is returned in the server reply for each uploaded document.
The upload_document_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_document_detail_count property.
This property is read-only.
upload_document_detail_file_content Property
If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded.
Syntax
def get_upload_document_detail_file_content(upload_document_detail_index: int) -> str: ... def set_upload_document_detail_file_content(upload_document_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
If upload_document_detail_local_file_name is not set, this will be used to specify the contents of the file to be uploaded.
The upload_document_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_document_detail_count property.
upload_document_detail_local_file_name Property
This contains the path to the file on the local system.
Syntax
def get_upload_document_detail_local_file_name(upload_document_detail_index: int) -> str: ... def set_upload_document_detail_local_file_name(upload_document_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This contains the path to the file on the local system. If this is not set, upload_document_detail_file_content will be used instead.
The upload_document_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_document_detail_count property.
upload_document_detail_ship_document Property
This indicates if the document will be sent in a subsequent call to GetShipmentLabels or GetPackageLabel .
Syntax
def get_upload_document_detail_ship_document(upload_document_detail_index: int) -> bool: ... def set_upload_document_detail_ship_document(upload_document_detail_index: int, value: bool) -> None: ...
Default Value
FALSE
Remarks
This indicates if the document will be sent in a subsequent call to get_shipment_labels or get_package_label.
The upload_document_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_document_detail_count property.
upload_document_detail_upload_file_name Property
This contains the name of file to be uploaded to FedEx.
Syntax
def get_upload_document_detail_upload_file_name(upload_document_detail_index: int) -> str: ... def set_upload_document_detail_upload_file_name(upload_document_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This contains the name of file to be uploaded to FedEx.
The upload_document_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_document_detail_count property.
upload_image_detail_count Property
The number of records in the UploadImageDetail arrays.
Syntax
def get_upload_image_detail_count() -> int: ... def set_upload_image_detail_count(value: int) -> None: ...
upload_image_detail_count = property(get_upload_image_detail_count, set_upload_image_detail_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- upload_image_detail_file_content
- upload_image_detail_image_index
- upload_image_detail_image_type
- upload_image_detail_local_file_name
- upload_image_detail_reference
- upload_image_detail_status
- upload_image_detail_upload_file_name
The array indices start at 0 and end at upload_image_detail_count - 1.
upload_image_detail_file_content Property
If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded.
Syntax
def get_upload_image_detail_file_content(upload_image_detail_index: int) -> str: ... def set_upload_image_detail_file_content(upload_image_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
If upload_image_detail_local_file_name is not set, this will be used to specify the contents of the file to be uploaded.
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
upload_image_detail_image_index Property
Specifies the index for the uploaded image.
Syntax
def get_upload_image_detail_image_index(upload_image_detail_index: int) -> str: ... def set_upload_image_detail_image_index(upload_image_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
Specifies the index for the uploaded image. Valid Values are: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5.
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
upload_image_detail_image_type Property
This specifies the image type of the image being uploaded.
Syntax
def get_upload_image_detail_image_type(upload_image_detail_index: int) -> int: ... def set_upload_image_detail_image_type(upload_image_detail_index: int, value: int) -> None: ...
Default Value
0
Remarks
This specifies the image type of the image being uploaded.
The valid values are as follows:
Value | Description |
uitSignature (0) | SIGNATURE |
uitLetterhead (1) | LETTERHEAD |
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
upload_image_detail_local_file_name Property
This contains the path to the file on the local system.
Syntax
def get_upload_image_detail_local_file_name(upload_image_detail_index: int) -> str: ... def set_upload_image_detail_local_file_name(upload_image_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This contains the path to the file on the local system. If this is not set, upload_image_detail_file_content will be used instead.
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
upload_image_detail_reference Property
This is an optional property to specify the customer reference for the image to be uploaded (Example: SIGNA202403).
Syntax
def get_upload_image_detail_reference(upload_image_detail_index: int) -> str: ... def set_upload_image_detail_reference(upload_image_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This is an optional field to specify the customer reference for the image to be uploaded (Example: SIGNA202403).
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
upload_image_detail_status Property
Upon a successful request, this is returned in the server reply for each uploaded image.
Syntax
def get_upload_image_detail_status(upload_image_detail_index: int) -> str: ...
Default Value
""
Remarks
Upon a successful request, this is returned in the server reply for each uploaded image.
Possible values are:
SUCCESS | |
FAILURE | |
ERROR |
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
This property is read-only.
upload_image_detail_upload_file_name Property
This contains the name of file to be uploaded to FedEx (Example: Signature.
Syntax
def get_upload_image_detail_upload_file_name(upload_image_detail_index: int) -> str: ... def set_upload_image_detail_upload_file_name(upload_image_detail_index: int, value: str) -> None: ...
Default Value
""
Remarks
This contains the name of file to be uploaded to FedEx (Example: Signature.PNG).
The upload_image_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the upload_image_detail_count property.
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:
- fed_ex_account_number (required)
- sender_country_code
To check the status of your cancel request the CancelledShipment config should be inspected.
cancel_pickup Method
Cancels a scheduled Pickup request.
Syntax
def cancel_pickup(confirmation_number: str, reason: 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:
- ConfirmationNumber (required)
- Reason (required)
- fed_ex_account_number (required)
- sender_contact (required)
- ship_date (required)
- SpecialInstructions (optional)
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:
- fed_ex_account_number (required)
- sender_country_code
To check the status of your cancel request the CancelledShipment config should be inspected.
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:
- fed_ex_authorization_token (required)
- fed_ex_server (optional)
- fed_ex_account_number (required)
- ship_date (required)
- ShipTime (optional)
- service_type (required)
- package_type (required)
- total_weight (optional; applicable to international shipments only)
- WeightUnit (required; defaults to LB)
- SizeUnit (required; defaults to IN)
- insured_value (optional)
- sender_contact (required)
- sender_address (required)
- recipient_contact (required)
- recipient_address (required)
- payor (required)
- shipment_special_services (optional)
- duties_payor (required for international shipments only)
- packages (required)
- label_image_type (required)
- commercial_invoice (required if Documents is set to False; applicable to international shipments only)
- commodities (required, regardless of the Documents value; applicable to international shipments only)
- clearance_brokerage_type (optional)
- broker_type (optional)
- broker_contact (optional)
- broker_address (optional)
- Documents (optional)
- BlockVisibility (optional)
In express international shipments, at least one commodity line item has to be included in the request. However, the customer has to print out its own Commercial Invoice (a required document for international shipments). The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the commodities (required, regardless of the Documents value).
This method fills in the following properties:
- package_tracking_number for each package included in the shipment;
- package_shipping_label for each package included in the shipment;
- package_net_charge for each package included in the shipment;
- package_base_charge for each package included in the shipment;
- package_total_discount for each package included in the shipment;
- package_total_surcharges for each package included in the shipment;
- delivery_date (applicable to the whole shipment);
- total_net_charge (applicable to the whole shipment);
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:
- fed_ex_authorization_token (required)
- fed_ex_server (optional)
- fed_ex_account_number (required)
- ship_date (required)
- ShipTime (optional)
- service_type (required)
- package_type (required)
- total_weight (optional; applicable to international shipments only)
- WeightUnit (required; defaults to LB)
- SizeUnit (required; defaults to IN)
- insured_value (optional)
- sender_contact (required)
- sender_address (required)
- recipient_contact (required)
- recipient_address (required)
- payor (required)
- shipment_special_services (optional)
- duties_payor (required for international shipments only)
- packages (required)
- label_image_type (required)
- commercial_invoice (required if Documents is set to False; applicable to international shipments only)
- commodities (required, regardless of the Documents value; applicable to international shipments only)
- clearance_brokerage_type (optional)
- broker_type (optional)
- broker_contact (optional)
- broker_address (optional)
- Documents (optional)
- BlockVisibility (optional)
In express international shipments, at least one commodity line item has to be included in the request. However, the customer has to print out its own Commercial Invoice (a required document for international shipments). The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the commodities (required, regardless of the Documents value).
This method fills in the following properties:
- package_tracking_number for each package included in the shipment;
- package_shipping_label for each package included in the shipment;
- package_net_charge for each package included in the shipment;
- package_base_charge for each package included in the shipment;
- package_total_discount for each package included in the shipment;
- package_total_surcharges for each package included in the shipment;
- delivery_date (applicable to the whole shipment);
- total_net_charge (applicable to the whole shipment);
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:
- service_type (required)
- carrier_type (required)
- sender_address1 (required)
- sender_city (optional)
- sender_state (optional)
- sender_zip_code (required)
- sender_country_code (required)
- ship_date (optional)
- ShipTime (optional)
- company_close_time (optional)
- pickup_type (optional)
- packages (optional)
- total_weight (optional)
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:
- ship_date
- ShipTime
- carrier_type
- CutoffTime
- AccessTime (Example: 'PT1H0M' means Pickup Time is 1 Hour and 0 Minutes)
The PickupAvailability method requires the values for the following properties:
- service_type (required)
- sender_address1 (required)
- sender_city (optional)
- sender_state (optional)
- sender_zip_code (required)
- sender_country_code (required)
- ship_date (optional)
- ShipTime (optional)
- company_close_time (optional)
- packages (optional)
- total_weight (optional)
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:
- carrier_type
- CutoffTime
- AccessTime (Example: 'PT1H0M' means Pickup Time is 1 Hour and 0 Minutes)
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:
- approved_by_company (optional)
- approved_by_email (optional)
- approved_by_fax (optional)
- approved_by_first_name (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- approved_by_last_name (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- approved_by_middle_initial (optional)
- approved_by_phone (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- BookingNumber (required when service_type is set to stFedEx1DayFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
- carrier_type (required, should be set to ctFXFR only if service_type is set to stFedExFreightEconomy or stFedExFreightPriority, otherwise should be set to ctFDXE.)
- commodity_freight_packaging_type (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- commodity_weight (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- commodity_handling_units (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- commodity_po_number (optional, only applies if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- company_close_time (required)
- package_location (required)
- packages (optional)
- PackageCount (required if packages are not provided)
- pickup_payment_type (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- recipient_address1 (optional)
- recipient_address2 (optional)
- recipient_city(required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- recipient_state(required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- recipient_zip_code(required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- recipient_country_code (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- sender_address1 (required when UseAccountAddress is false)
- sender_address2 (optional)
- sender_city (required when UseAccountAddress is false)
- sender_state (required when UseAccountAddress is false)
- sender_zip_code (required when UseAccountAddress is false)
- sender_country_code (required when UseAccountAddress is false)
- sender_company (required when UseAccountAddress is false)
- sender_email (optional)
- sender_fax (optional)
- sender_first_name (required when UseAccountAddress is false)
- sender_last_name (required when UseAccountAddress is false)
- sender_middle_initial (optional)
- sender_phone (required when UseAccountAddress is false)
- service_type (required)
- ship_date (required)
- ShipTime (optional)
- SpecialInstructions (optional)
- submitted_by_company (optional)
- submitted_by_email (optional)
- submitted_by_fax (optional)
- submitted_by_first_name (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- submitted_by_last_name (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- submitted_by_middle_initial (optional)
- submitted_by_phone (required if service_type is set to stFedExFreightEconomy or stFedExFreightPriority)
- total_weight (required)
- truck_type (required when service_type is set to an Express Freight type, such as stFedEx1DayFreight, stFedEx2DayFreight, stFedEx3DayFreight, stFedExFirstFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
- trailer_size (required when service_type is set to an Express Freight type, such as stFedEx1DayFreight, stFedEx2DayFreight, stFedEx3DayFreight, stFedExFirstFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
- UseAccountAddress (optional)
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.
upload_documents Method
Uploads documents to FedEx.
Syntax
def upload_documents() -> None: ...
Remarks
When called this will upload any documents specified in upload_document_details to FedEx.
upload_images Method
Uploads images to FedEx.
Syntax
def upload_images() -> None: ...
Remarks
When called this will upload any images specified in upload_image_details to FedEx.
on_error Event
Information about errors during data delivery.
Syntax
class FedExFreightShipErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class FedExFreightShip: @property def on_error() -> Callable[[FedExFreightShipErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[FedExFreightShipErrorEventParams], 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 FedExFreightShipNotificationEventParams(object): @property def message() -> str: ... # In class FedExFreightShip: @property def on_notification() -> Callable[[FedExFreightShipNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[FedExFreightShipNotificationEventParams], 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 FedExFreightShipSSLServerAuthenticationEventParams(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 FedExFreightShip: @property def on_ssl_server_authentication() -> Callable[[FedExFreightShipSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[FedExFreightShipSSLServerAuthenticationEventParams], 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 FedExFreightShipSSLStatusEventParams(object): @property def message() -> str: ... # In class FedExFreightShip: @property def on_ssl_status() -> Callable[[FedExFreightShipSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[FedExFreightShipSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
FedExFreightShip 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.FedExFreightShip Config Settings
If you set the package_type to YOUR_PACKAGING, the AdmissibilityPackageType is required for packages traveling to and from the U.S., Canada, and Puerto Rico, in order to designate the package description.
Possible values are:
BAG | |
BBL | |
BDL | |
BOX | |
BSK | |
BXT | |
CAG | |
CAS | |
CHS | |
CNT | |
CRT | |
CTN | |
CYL | |
DRM | |
ENV | |
PAL | |
PCL | |
PCS | |
PKG | |
PLT | |
REL | |
ROL | |
SAK | |
SHW | |
SKD | |
TBE | |
TBN | |
TNK | |
UNT |
The B13A is an export declaration form filed with Canada Customs by the Canadian exporter. Canadian shippers are required to submit a B13A Canada Export Declaration for shipments of commodities or documents (which value exceeds $1,999.99 CAD, $999.00 USD, or $0.00 for any other currency type), or for shipments of controlled commodities, as defined by Revenue Canada Customs and related agencies, regardless of the value of the shipment. This is not needed for outbound shipments consigned to countries other than the United States (US), U.S. Virgin Islands (VI), or Puerto Rico (PR).
The B13AFiling is required to be provided in the ship request for all FedEx Express International non-document shipments outbound from Canada that are not destined to above listed countries, and :
Possible values are: 'NOT_REQUIRED', 'MANUALLY_ATTACHED', 'FILED_ELECTRONICALLY', 'SUMMARY_REPORTING', and 'FEDEX_TO_STAMP'.
If 'NOT_REQUIRED' is specified, the B13A Exemption Number should be provided in the request (via the ExportCompliance).
If 'MANUALLY_ATTACHED' is specified, your manually filed B13A must be time/date stamped at a Canada Customs office before you ship. The shipment tracking number must be indicated on the stamped B13A. One original copy of the stamped B13A must be attached to the shipping documentation. You are not required to enter the 21-character B13A transaction number at the time of shipping.
If 'FILED_ELECTRONICALLY' is specified, your B13A authorization code must be obtained by submitting your B13A information using the CAED software (and be provided in the ship request via the ExportCompliance). To add the required shipment tracking number to your B13A declaration, return to the CAED software after you create your shipping label and update your original B13A declaration with this information.
If 'SUMMARY_REPORTING' is specified, a prior written authorization from Canada Customs is required.
Note: If you have questions regarding B13A shipping requirements, see fedex.com/ca_english/international/regulatorynews/b13afaqs.html for more information.
If True, only the shipper/payor will have visibility of this shipment.
It is required and applicable only for the following international freight services: International Priority Freight (IPFS) and International Economy Freight (IEFS) (i.e., when the service_type is set to either ST_INTERNATIONALPRIORITY_FREIGHT (14) or ST_INTERNATIONALECONOMY_FREIGHT (15)).
Values must be 8-12 characters in length.
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.
This specifies the primary address of the COD Recipient, which will be printed on the COD label.
This specifies the secondary address of the COD Recipient, which will be printed on the COD label.
This specifies the city of the COD Recipient, which will be printed on the COD label.
This specifies the company of the COD Recipient, which will be printed on the COD label.
This specifies the country code of the COD Recipient, which will be printed on the COD label.
This specifies the name of the COD Recipient, which will be printed on the COD label.
This specifies the phone number of the COD Recipient, which will be printed on the COD label.
This indicates whether the COD recipient is a residential address.
This specifies the state of the COD Recipient, which will be printed on the COD label.
This specifies the zip code of the COD Recipient, which will be printed on the COD label.
The reference information to be added to the COD return label.
Possible values are:
0 | None (default) |
1 | INVOICE |
2 | PO |
3 | REFERENCE |
4 | TRACKING |
This identifies the type of funds FedEx driver should collect upon package delivery. It is available for FedEx Ground services only. 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: ANY (Unsecured form of payment: personal check, certified check, cashier's check, official check, money order, or company check), GUARANTEED_FUNDS (Secured form of payment: cashier's check, official check, or money order), or CASH.
The amount to be collected has to be specified on package level by setting the package_cod_amount per each package where COD is requested.
This optional field identifies the preferred currency of the requestor.
This contains the number of records in the CustomerImage arrays. For ShippingDocumentTypes (Certificate of Origin(1) or Commercial Invoice(2)) that you are requesting, you can use any of the 5 images you have uploaded to your FedEx account as a Signature or as a Letter_Head.
This property controls the size of the following arrays:
NOTE: If you are using the CustomerImage configs, you must upload them first on the FedEx portal.For example, you can choose to use IMAGE_1 as the LETTER_HEAD for the Commercial Invoice, IMAGE_5 as the SIGNATURE for the Commercial Invoice, and IMAGE_1 as the LETTER_HEAD for the Certificate of Origin. In this case, you will need to set the CustomerImageCount to 3.
class.Config("CustomerImageCount=3")
int index = 0;
class.Config("CustomerImageDocumentType(" + index + ")=2") //2=Commercial Invoice
class.Config("CustomerImageId(" + index + ")=IMAGE_1")
class.Config("CustomerImageType(" + index + ")= LETTER_HEAD")
class.Config("CustomerImageProvidedImageType(" + index + ")= LETTER_HEAD")
index = 1;
class.Config("CustomerImageDocumentType(" + index + ")=2") //2=Commercial Invoice
class.Config("CustomerImageId(" + index + ")=IMAGE_5")
class.Config("CustomerImageType(" + index + ")=SIGNATURE")
class.Config("CustomerImageProvidedImageType(" + index + ")=SIGNATURE")
index = 2;
class.Config("CustomerImageDocumentType(" + index + ")=1") //1=Certificate of Origine
class.Config("CustomerImageId(" + index + ")=IMAGE_1")
class.Config("CustomerImageType(" + index + ")=LETTER_HEAD")
class.Config("CustomerImageProvidedImageType(" + index + ")=LETTER_HEAD")
Valid values are:
Value | Description |
1 | Certificate of Origin |
2 | Commercial Invoice |
Valid values are: "IMAGE_1", "IMAGE_2", "IMAGE_3", "IMAGE_4", "IMAGE_5". The size of the array is controlled by CustomerImageCount.
Valid values: "LETTER_HEAD", "SIGNATURE". The size of the array is controlled by CustomerImageCount.
Valid values are: "SIGNATURE", "LETTER_HEAD". The size of the array is controlled by CustomerImageCount.
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.
This is the legal explanation, used by Customs, for the delivery of this shipment. It must be identical to the set of declarations actually used by Customs. Examples of declarations that might be entered in this field are:
EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly
indicated these products are of EEA preferential origin.
Invoice statement: I hereby certify that the information on this invoice is true and correct and the contents and
value of this shipment is as stated above.
NAFTA statement: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes
of preferential tariff treatment under the NAFTA.
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.
Used with Freight services only.
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.
This is applicable for international shipments only.
If False (default value), this means that this shipment contains NO documents. In this case, the data for commodity items (included in the shipment) have to be provided in the request. The Commercial Invoice is required to associate the shipment (see respective commodity elements defined by the commodities for more details).
If True, it means that this shipment contains ONLY documents. An international shipment can either contain documents only, or no documents. Documents and other commodities cannot be mixed in a shipment.
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.
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.
General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
For international shipments requiring an EEI/SED (Electronic Export information/Shipper's Export Declaration), the ExportCompliance should be set to: either a FTR (Foreign Trade Regulations) exemption number or an ITN number (Internal Transaction Number) received from filing your EEI/SED shipment data with AESDirect (go to www.aesdirect.gov to use this application) as proof of filing citation.
For shipments originating in Canada, the following rules apply:
- if B13AFiling is set to 'NOT_REQUIRED', this field should contain a valid B13A Exemption Number;
- if B13AFiling is set to 'MANUALLY_ATTACHED', you are not required to enter the 21-character B13A transaction number at the time of shipping;
- if B13AFiling is set to 'FILED_ELECTRONICALLY', this field should contain a valid 17 or 23 alphanumeric authorization code for your B13A;
- if B13AFiling is set to 'SUMMARY_REPORTING': this option requires a prior written authorization from Canada Customs;
This number will print on the international shipping label and it is used by customs office. Maximum length: 50.
Two most common exemptions are: 'NO EEI 30.36' (for shipments to Canada) and 'NO EEI 30.37(a)' (for commodity value less than $2,500). However, for the official list of FTR Exemption codes and definitions, please refer to Code of Federal Regulations (CFR) Title 15, Part 30, Subpart D (located at http://ecfr.gpoaccess.gov or http://www.census.gov/foreign-trade/regulations).
This will allow you to add special instructions to the commercial invoice.
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 |
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 |
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 |
This is required for a single piece or on the first piece of an MPS for international freight shipping. It is applicable only for International Priority Freight (IPFS) and International Economy Freight (IEFS) (i.e., when the service_type is set to either ST_INTERNATIONALPRIORITY_FREIGHT (14) or ST_INTERNATIONALECONOMY_FREIGHT (15)).
This indicates the total shipment pieces (e.g. 3 boxes and 3 pallets of 100 pieces each = SLAC of 303). Maximum length: 5. Values must be in the range of 1 - 99999.
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:
Value | Description |
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 |
If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist.
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.
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.
For FedEx Freight Shipments, set this config to specify the Freight Commodity Line Item IDs associated with this package. This setting accepts multiple, comma separated IDs. For example:
class.Commodities[0].Id = "Item1";
...
class.Commodities[1].Id = "Item2";
class.Config("PackageFreightCommodityIds[0]=Item1,Item2");
Note: This only applies when using the FedExFreightEconomy and FedExFreightPriority services.
Set this config to specify additional details about how the item has been physically packaged for a FedEx Freight shipment.
The applicable values include the following:
0 (default) | Not Set |
1 | BAG |
2 | BARREL |
3 | BASKET |
4 | BOX |
5 | BUCKET |
6 | BUNDLE |
7 | CAGE |
8 | CARTON |
9 | CASE |
10 | CHEST |
11 | CONTAINER |
12 | CRATE |
13 | CYLINDER |
14 | DRUM |
15 | ENVELOPE |
16 | HAMPER |
17 | OTHER |
18 | PACKAGE |
19 | PAIL |
20 | PALLET |
21 | PARCEL |
22 | PIECE |
23 | REEL |
24 | ROLL |
25 | SACK |
26 | SHRINKWRAPPED |
27 | SKID |
28 | TANK |
29 | TOTEBIN |
30 | TUBE |
31 | UNIT |
Shipper's Bill of Lading number to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.
Consignee Id to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.
Shipper Id to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.
This returns the complete request as sent to the server. Used for debugging purposes.
This returns the complete response as received from the server. Used for debugging purposes.
This element should be included in the request in order to produce a Commercial Invoice. You can specify the recipient TIN type by setting the RecipientTinType. When this is set, you must also specify the Taxpayer Identification Number (RecipientTinNumber) with the corresponding Id number for shipper TIN Type.
You can specify the recipient TIN type by setting the RecipientTinType. When this is set, you must also provide the corresponding Taxpayer Identification Number.
This type must match the data entered in the RecipientTinNumber.
Valid values for the taxpayer identification number's (TIN) type are:
BUSINESS_NATIONAL | |
BUSINESS_STATE | |
BUSINESS_UNION | |
PERSONAL_NATIONAL | |
PERSONAL_STATE |
Possible values are: 'FOOD_OR_PERISHABLE', 'USMCA', 'NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS', 'NOT_IN_FREE_CIRCULATION'. 'FOOD_OR_PERISHABLE' value is required by FDA/BTA for food/perishable items coming to US or PR from non-US/non-PR origin.
If ReturnType is set to Other then ReturnDescription must be set, otherwise it is optional.
Identifies the reason for a global return, as recognized by Customs.
Valid values are:
Value | Meaning |
0 | Exhibition Trade Show. |
1 | Faulty Item. |
2 | For Repair. |
3 | Item For Loan. |
4 | Other. |
5 | Rejected. |
6 | Trial. |
As the shipper, your tax identification information must be uploaded to FedEx for EEI/SED shipments. This element should be included in the request in order to produce a Commercial Invoice. You can specify the shipper TIN type by setting the SenderTinType. When this is set, you must also specify the Taxpayer Identification Number (SenderTinNumber) with the corresponding Id number for shipper TIN Type.
As the shipper, your tax identification information must be uploaded to FedEx for EEI/SED shipments. This element should be included in the request in order to produce a Commercial Invoice. You can specify the shipper TIN type by setting the SenderTinType. When this is set, you must also provide the corresponding Taxpayer Identification Number.
This type must match the data entered in the SenderTinNumber.
Valid values for the taxpayer identification number's (TIN) type are:
BUSINESS_NATIONAL | |
BUSINESS_STATE | |
BUSINESS_UNION | |
PERSONAL_NATIONAL | |
PERSONAL_STATE |
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.
When a document file is received, it will be put at the location specified with the following format:
>ShippingDocumentFile<_>type<>sequence number<.pdf
Note that there will not be a sequence number if the file is the only file of its type.
This element indicates the format in which the shipping document should be printed.
Possible values are:
0 | PDF (default) |
1 | PNG |
2 | ELP2 |
3 | ZPLII |
4 | DPL |
All 'Paper *' items should be used when a laser printer is being used to print the generated document file (ie. ShippingDocumentImageType is set to PDF or PNG).
All 'Stock *' items should be used when a thermal printer is being used to print the generated document file (ie. ShippingDocumentImageType is set to ELP2, ZPLII or DPL).
By Default, 7 (PAPER_LETTER) will be used. Valid label stock types are:
1 | OP_900_LG |
2 | OP_900_LG_B |
3 | OP_900_LL |
4 | OP_900_LL_B |
5 | OP_950 |
6 | PAPER_4X6 |
7 | PAPER_LETTER (default) |
8 | STOCK_4X6 |
9 | STOCK_4X6.75_LEADING_DOC_TAB |
10 | STOCK_4X6.75_TRAILING_DOC_TAB |
11 | STOCK_4X8 |
12 | STOCK_4X9_LEADING_DOC_TAB |
13 | STOCK_4X9_TRAILING_DOC_TAB |
This specifies which documents you would like FedEx to generate and send back to you.
To request one or more documents be generated by FedEx you will need to set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Description |
0x0 | None |
0x0001 | Certificate of Origin |
0x0002 | Commercial Invoice |
0x0004 | NAFTA Certificate of Origin |
0x0040 | Freight Address Label |
0x1000 | FedEx Freight Straight Bill of Lading |
0x2000 | VICS Bill of Lading |
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).
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.
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.
This might be returned by the server even upon successful response. These warnings are usually informational.
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
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.
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.
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.
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.
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]".
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.
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.
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.
If set to True, the URL passed to the class will be URL encoded. The default value is False.
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
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.
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.
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") or HTTP/3 ("3.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.
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.
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.
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.
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).
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.
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.
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.
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.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting returns the complete set of raw headers as sent by the client.
This configuration setting contains the result code 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].
This configuration setting contains the contents of the last response from the server.
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.
This configuration setting returns the complete set of raw headers as received from the server.
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"));
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.
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.
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.
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.
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
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.
This configuration setting is provided for use by classs that do not directly expose Firewall properties.
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.
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.
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.
Possible values are as follows:
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
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.
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.
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.
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 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.
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 multihomed 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 multihomed hosts (machines with more than one IP interface).
This configuration setting 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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
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.
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
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.
When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this configuration setting is set to False.
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 as follows:
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When ssl_provider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only 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 configuration setting has no effect if ssl_provider is set to Platform.
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). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
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.
This configuration 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 as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When ssl_provider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) 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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
This configuration 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 Online Certificate Status Protocol (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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
This minimum cipher strength is 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.
Note: This configuration 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 configuration 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 configuration setting.
This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client'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 configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting enables the 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 include the following:
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 the following:
- 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
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_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include the following:
- 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_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.
This configuration setting is used to enable or disable the supported security protocols.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (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 that 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 supported only 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 available only 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, these 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.
This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is False by default, but it can be set to True to enable the extension.
This configuration setting is applicable only when ssl_provider is set to Internal.
This configuration 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.
This configuration 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 traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
This configuration setting returns the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
This configuration setting 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 configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
This configuration setting returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and 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 configuration setting should be set only 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 configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration 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 configuration 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 configuration 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.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
This configuration 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)
This configuration 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 roundtrip 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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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"
This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:
- "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)
This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only 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
If AbsoluteTimeout is set to True, any method that 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 User Datagram Protocol (UDP) ports.
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).
This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.
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.
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. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.
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
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
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.
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.
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.
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.
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.
FedExFreightShip Errors
FedExFreightShip 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.