FedExShip Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class dshippingsdk.FedExShip

Remarks

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

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

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

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

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

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

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:

close_date Property

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

Syntax

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

close_date = property(get_close_date, set_close_date)

Default Value

""

Remarks

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

This property is applicable for FedEx Ground services only. Format: YYYY-MM-DD (e.g. 2024-12-30).

close_report_file Property

Filename and location to save the report to.

Syntax

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

close_report_file = property(get_close_report_file, set_close_report_file)

Default Value

""

Remarks

Filename and location to save the report to. When the close_report_file is set to a valid path and filename, the content of the report is written to disk upon successful response. A value (a name for the file) has to be assigned to this property if close_report_type is set to a value other than 0 (Unspecified) when close_ground_shipments is called. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

close_report_type Property

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

Syntax

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

close_report_type = property(get_close_report_type, set_close_report_type)

Default Value

0

Remarks

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

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

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

Valid report types are listed below:

This property is applicable for FedEx Ground services only.

close_tracking_number Property

Shipment Ground tracking number.

Syntax

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

close_tracking_number = property(get_close_tracking_number, set_close_tracking_number)

Default Value

""

Remarks

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

Maximum length: 20 characters.

NOTE: This only takes effect when calling reprint_documents.

cod_label Property

The label that is returned.

Syntax

def get_cod_label() -> str: ...

cod_label = property(get_cod_label, None)

Default Value

""

Remarks

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

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

This property is read-only.

cod_label_file Property

The file the COD label should be written to.

Syntax

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

cod_label_file = property(get_cod_label_file, set_cod_label_file)

Default Value

""

Remarks

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

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

cod_total_amount Property

The total amount to be collected on delivery.

Syntax

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

cod_total_amount = property(get_cod_total_amount, set_cod_total_amount)

Default Value

""

Remarks

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

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

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

cod_tracking_number Property

Contains the tracking number for the COD return shipment.

Syntax

def get_cod_tracking_number() -> str: ...

cod_tracking_number = property(get_cod_tracking_number, None)

Default Value

""

Remarks

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

This property is read-only.

cod_type Property

COD type.

Syntax

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

cod_type = property(get_cod_type, set_cod_type)

Default Value

0

Remarks

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

Possible values are as follows:

company_close_time Property

The time your company closes.

Syntax

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

company_close_time = property(get_company_close_time, set_company_close_time)

Default Value

""

Remarks

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

delivery_date Property

Date on which shipment is expected to be delivered.

Syntax

def get_delivery_date() -> str: ...

delivery_date = property(get_delivery_date, None)

Default Value

""

Remarks

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

This property is read-only.

fed_ex_account_number Property

The account number associated with the shipment.

Syntax

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

fed_ex_account_number = property(get_fed_ex_account_number, set_fed_ex_account_number)

Default Value

""

Remarks

The account number associated with the shipment.

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

fed_ex_authorization_token Property

Authorization Token used to authenticate the request.

Syntax

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

fed_ex_authorization_token = property(get_fed_ex_authorization_token, set_fed_ex_authorization_token)

Default Value

""

Remarks

Authorization Token used to authenticate the request.

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

fed_ex_language_code Property

Two-letter code for the language (e.

Syntax

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

fed_ex_language_code = property(get_fed_ex_language_code, set_fed_ex_language_code)

Default Value

"en"

Remarks

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

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

fed_ex_locale_code Property

Two-letter code for the region (e.

Syntax

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

fed_ex_locale_code = property(get_fed_ex_locale_code, set_fed_ex_locale_code)

Default Value

"US"

Remarks

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

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

fed_ex_server Property

URL for the FedEx Server where the requests are sent.

Syntax

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

fed_ex_server = property(get_fed_ex_server, set_fed_ex_server)

Default Value

""

Remarks

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

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

firewall_auto_detect Property

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

Syntax

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

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

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

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

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

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

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

firewall_password Property

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

Syntax

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

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

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

Syntax

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

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

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

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

freight_guarantee_date Property

The date the freight shipment is guaranteed for.

Syntax

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

freight_guarantee_date = property(get_freight_guarantee_date, set_freight_guarantee_date)

Default Value

""

Remarks

The date the freight shipment is guaranteed for.

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

freight_guarantee_type Property

Specifies what type of freight guarantee is requested.

Syntax

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

freight_guarantee_type = property(get_freight_guarantee_type, set_freight_guarantee_type)

Default Value

0

Remarks

Specifies what type of freight guarantee is requested.

The valid values are:

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.

* Not supported by USPS

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

hold_at_location_state Property

State or province code.

Syntax

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

hold_at_location_state = property(get_hold_at_location_state, set_hold_at_location_state)

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

hold_at_location_zip_code Property

Postal code.

Syntax

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

hold_at_location_zip_code = property(get_hold_at_location_zip_code, set_hold_at_location_zip_code)

Default Value

""

Remarks

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

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both hold_at_location_city and hold_at_location_state are not present.

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

hold_at_location_contact_company Property

Identifies the contact person's company name.

Syntax

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

hold_at_location_contact_company = property(get_hold_at_location_contact_company, set_hold_at_location_contact_company)

Default Value

""

Remarks

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

hold_at_location_contact_email Property

Identifies the contact person's email address.

Syntax

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

hold_at_location_contact_email = property(get_hold_at_location_contact_email, set_hold_at_location_contact_email)

Default Value

""

Remarks

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

hold_at_location_contact_fax Property

Recipient's fax number.

Syntax

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

hold_at_location_contact_fax = property(get_hold_at_location_contact_fax, set_hold_at_location_contact_fax)

Default Value

""

Remarks

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

hold_at_location_contact_first_name Property

Sender's first name.

Syntax

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

hold_at_location_contact_first_name = property(get_hold_at_location_contact_first_name, set_hold_at_location_contact_first_name)

Default Value

""

Remarks

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

hold_at_location_contact_last_name Property

Person's last name.

Syntax

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

hold_at_location_contact_last_name = property(get_hold_at_location_contact_last_name, set_hold_at_location_contact_last_name)

Default Value

""

Remarks

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

hold_at_location_contact_middle_initial Property

Middle initial.

Syntax

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

hold_at_location_contact_middle_initial = property(get_hold_at_location_contact_middle_initial, set_hold_at_location_contact_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

hold_at_location_contact_phone Property

Identifies the contact person's phone number.

Syntax

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

hold_at_location_contact_phone = property(get_hold_at_location_contact_phone, set_hold_at_location_contact_phone)

Default Value

""

Remarks

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

hold_at_location_phone Property

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

Syntax

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

hold_at_location_phone = property(get_hold_at_location_phone, set_hold_at_location_phone)

Default Value

""

Remarks

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

home_delivery_date Property

Date for Ground Home Delivery service.

Syntax

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

home_delivery_date = property(get_home_delivery_date, set_home_delivery_date)

Default Value

""

Remarks

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

Format: YYYY-MM-DD.

home_delivery_phone Property

The phone number of the delivery location.

Syntax

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

home_delivery_phone = property(get_home_delivery_phone, set_home_delivery_phone)

Default Value

""

Remarks

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

home_delivery_type Property

The type of Home Delivery Premium service being requested.

Syntax

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

home_delivery_type = property(get_home_delivery_type, set_home_delivery_type)

Default Value

0

Remarks

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

Possible values are as follows:

insured_value Property

Total insured amount.

Syntax

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

insured_value = property(get_insured_value, set_insured_value)

Default Value

"0.00"

Remarks

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

label_image_type Property

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

Syntax

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

label_image_type = property(get_label_image_type, set_label_image_type)

Default Value

0

Remarks

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

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

Note: To generate PDF labels, you will need Adobe Reader 6.0 or higher, and the printer driver configuration set to 'none' for print scaling.

There are two types of shipping labels supported:

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

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

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

location Property

The FedEx location identifier that received the express dispatch request.

Syntax

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

location = property(get_location, set_location)

Default Value

""

Remarks

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

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

manifest Property

Image of the manifest for FedEx Ground shipment activity.

Syntax

def get_manifest() -> bytes: ...

manifest = property(get_manifest, None)

Default Value

""

Remarks

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

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

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

This property is applicable for FedEx Ground services only.

This property is read-only.

master_tracking_number Property

Tracking number assigned to the whole MPS shipment.

Syntax

def get_master_tracking_number() -> str: ...

master_tracking_number = property(get_master_tracking_number, None)

Default Value

""

Remarks

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

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

This property is read-only.

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:

• notify_aggregate
• notify_email
• notify_flags
• notify_message
• notify_name
• notify_type

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

notify_aggregate Property

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

Syntax

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

Default Value

""

Remarks

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

FedEx

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

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

In this aggregate, you can specify:

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

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

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

UPS

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

In this aggregate, you can specify:

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

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

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

notify_email Property

Email address of the recipient to be notified.

Syntax

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

Default Value

""

Remarks

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

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

notify_message Property

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

Syntax

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

Default Value

""

Remarks

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

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

This property is not used by USPS or Canada Post.

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

notify_name Property

The name associated with the notification.

Syntax

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

Default Value

""

Remarks

The name associated with the notification.

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

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

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

notify_flags Property

Identifies the type of notification requested.

Syntax

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

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Tender
• On Estimated Delivery
• HTML
• Text

To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

For UPS notifications, the following flags apply:

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

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

This field is not used by USPS.

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

notify_type Property

Identifies the set of valid email notification recipient types.

Syntax

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

Default Value

0

Remarks

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

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.

op950_certificate Property

Image of the OP_950 certification report.

Syntax

def get_op950_certificate() -> bytes: ...

op950_certificate = property(get_op950_certificate, None)

Default Value

""

Remarks

This identifies the buffer containing the OP_950 certification report for FedEx Ground shipments.

When calling the close_ground_shipments method, the op950_certificate is returned when close_report_type is set to 2 (OP950).

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

This property is applicable for FedEx Ground services only.

This property is read-only.

origin_address1 Property

Street name.

Syntax

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

origin_address1 = property(get_origin_address1, set_origin_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS origin_address1 should not exceed 35 characters.

origin_address2 Property

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

Syntax

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

origin_address2 = property(get_origin_address2, set_origin_address2)

Default Value

""

Remarks

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

origin_address_flags Property

Various flags that denote information about the address.

Syntax

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

origin_address_flags = property(get_origin_address_flags, set_origin_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

origin_city Property

Name of city, town, etc.

Syntax

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

origin_city = property(get_origin_city, set_origin_city)

Default Value

""

Remarks

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

origin_country_code Property

Country code.

Syntax

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

origin_country_code = property(get_origin_country_code, set_origin_country_code)

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

origin_state Property

State or province code.

Syntax

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

origin_state = property(get_origin_state, set_origin_state)

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

origin_zip_code Property

Postal code.

Syntax

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

origin_zip_code = property(get_origin_zip_code, set_origin_zip_code)

Default Value

""

Remarks

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

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both origin_city and origin_state are not present.

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

origin_company Property

Identifies the contact person's company name.

Syntax

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

origin_company = property(get_origin_company, set_origin_company)

Default Value

""

Remarks

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

origin_email Property

Identifies the contact person's email address.

Syntax

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

origin_email = property(get_origin_email, set_origin_email)

Default Value

""

Remarks

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

origin_fax Property

Recipient's fax number.

Syntax

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

origin_fax = property(get_origin_fax, set_origin_fax)

Default Value

""

Remarks

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

origin_first_name Property

Sender's first name.

Syntax

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

origin_first_name = property(get_origin_first_name, set_origin_first_name)

Default Value

""

Remarks

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

origin_last_name Property

Person's last name.

Syntax

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

origin_last_name = property(get_origin_last_name, set_origin_last_name)

Default Value

""

Remarks

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

origin_middle_initial Property

Middle initial.

Syntax

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

origin_middle_initial = property(get_origin_middle_initial, set_origin_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

origin_phone Property

Identifies the contact person's phone number.

Syntax

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

origin_phone = property(get_origin_phone, set_origin_phone)

Default Value

""

Remarks

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

package_location Property

The location of pickup.

Syntax

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

package_location = property(get_package_location, set_package_location)

Default Value

0

Remarks

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

package_count Property

The number of records in the Package arrays.

Syntax

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

package_count = property(get_package_count, set_package_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• package_base_charge
• package_cod_amount
• package_cod_file
• package_cod_label
• package_cod_type
• package_dangerous_goods_accessible
• package_dangerous_goods_options
• package_description
• package_height
• 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_cod_amount Property

The COD monetary value for the package.

Syntax

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

Default Value

""

Remarks

The COD monetary value for the package.

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

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

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

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

This property is not applicable to USPS packages.

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

This is not applicable for Canada Post.

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

package_cod_file Property

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

This property is only applicable to FedEx shipments.

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

package_cod_label Property

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

This property is only applicable to FedEx.

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

This property is read-only.

package_cod_type Property

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

Syntax

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

Default Value

0

Remarks

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

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

Valid values are:

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

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

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

package_dangerous_goods_accessible Property

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

Syntax

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

Default Value

FALSE

Remarks

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

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

There are two types of dangerous goods:

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

The accessibility type affects the service availability and rates.

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

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

package_dangerous_goods_options Property

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

Syntax

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

Default Value

0

Remarks

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

Note: This is only valid when using FedEx.

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

package_description Property

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

Syntax

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

Default Value

""

Remarks

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

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

This does not apply for USPS and Canada Post.

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

package_height Property

The height of the package to be shipped.

Syntax

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

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the package_height is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_length and package_width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

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

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

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

For USPS, this only applies to get_rates and is only required if the package is irregular and the package_packaging_type property is set to ptNonRectangular. (In this case package_width and package_height must still be set). For parcels, package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_girth is the measurement around the thickest part of the package, perpendicular to the length.

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

Note that the package_length, package_width, and package_height are required for Priority Mail packages when the package_size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

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

package_insured_value Property

Amount of insurance requested for this package.

Syntax

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

Default Value

""

Remarks

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

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

package_length Property

The length of the package to be shipped.

Syntax

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

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the package_length is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_width and package_height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

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

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

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

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

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

Note: For parcels, the package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_girth is the measurement around the thickest part of the package, perpendicular to the length.

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

Note that the package_length, package_width, and package_height are required for Priority Mail packages when the package_size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

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

package_net_charge Property

Actual Net Charge applicable to this package.

Syntax

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

Default Value

""

Remarks

Actual Net Charge applicable to this package.

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

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

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

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

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

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

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

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

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

package_type Property

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

Syntax

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

Default Value

0

Remarks

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

Possible values are:

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:

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:

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:

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:

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:

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:

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

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

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

payor_state Property

State or province code.

Syntax

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

payor_state = property(get_payor_state, set_payor_state)

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

payor_zip_code Property

Payor's postal code (if applicable).

Syntax

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

payor_zip_code = property(get_payor_zip_code, set_payor_zip_code)

Default Value

""

Remarks

Payor's postal code (if applicable).

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

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

Maximum length: 10.

pickup_type Property

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

Syntax

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

pickup_type = property(get_pickup_type, set_pickup_type)

Default Value

0

Remarks

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

Valid values are:

proxy_auth_scheme Property

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

Syntax

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

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

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

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

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

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

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

proxy_auto_detect Property

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

Syntax

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

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

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

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

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

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

proxy_port Property

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

Syntax

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

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

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

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

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

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

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

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

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

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

recipient_address1 Property

Street name.

Syntax

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

recipient_address1 = property(get_recipient_address1, set_recipient_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS recipient_address1 should not exceed 35 characters.

recipient_address2 Property

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

Syntax

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

recipient_address2 = property(get_recipient_address2, set_recipient_address2)

Default Value

""

Remarks

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

recipient_address_flags Property

Various flags that denote information about the address.

Syntax

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

recipient_address_flags = property(get_recipient_address_flags, set_recipient_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

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.

* Not supported by USPS

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

recipient_state Property

State or province code.

Syntax

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

recipient_state = property(get_recipient_state, set_recipient_state)

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

recipient_zip_code Property

Postal code.

Syntax

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

recipient_zip_code = property(get_recipient_zip_code, set_recipient_zip_code)

Default Value

""

Remarks

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

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both recipient_city and recipient_state are not present.

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

recipient_company Property

Identifies the contact person's company name.

Syntax

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

recipient_company = property(get_recipient_company, set_recipient_company)

Default Value

""

Remarks

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

recipient_email Property

Identifies the contact person's email address.

Syntax

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

recipient_email = property(get_recipient_email, set_recipient_email)

Default Value

""

Remarks

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

recipient_fax Property

Recipient's fax number.

Syntax

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

recipient_fax = property(get_recipient_fax, set_recipient_fax)

Default Value

""

Remarks

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

recipient_first_name Property

Sender's first name.

Syntax

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

recipient_first_name = property(get_recipient_first_name, set_recipient_first_name)

Default Value

""

Remarks

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

recipient_last_name Property

Person's last name.

Syntax

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

recipient_last_name = property(get_recipient_last_name, set_recipient_last_name)

Default Value

""

Remarks

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

recipient_middle_initial Property

Middle initial.

Syntax

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

recipient_middle_initial = property(get_recipient_middle_initial, set_recipient_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

recipient_phone Property

Identifies the contact person's phone number.

Syntax

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

recipient_phone = property(get_recipient_phone, set_recipient_phone)

Default Value

""

Remarks

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

return_address1 Property

Street name.

Syntax

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

return_address1 = property(get_return_address1, set_return_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS return_address1 should not exceed 35 characters.

return_address2 Property

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

Syntax

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

return_address2 = property(get_return_address2, set_return_address2)

Default Value

""

Remarks

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

return_address_flags Property

Various flags that denote information about the address.

Syntax

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

return_address_flags = property(get_return_address_flags, set_return_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

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.

* Not supported by USPS

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

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.

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.

* Not supported by USPS

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

sender_state Property

State or province code.

Syntax

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

sender_state = property(get_sender_state, set_sender_state)

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

sender_zip_code Property

Postal code.

Syntax

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

sender_zip_code = property(get_sender_zip_code, set_sender_zip_code)

Default Value

""

Remarks

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

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both sender_city and sender_state are not present.

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

sender_company Property

Identifies the contact person's company name.

Syntax

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

sender_company = property(get_sender_company, set_sender_company)

Default Value

""

Remarks

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

sender_email Property

Identifies the contact person's email address.

Syntax

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

sender_email = property(get_sender_email, set_sender_email)

Default Value

""

Remarks

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

sender_fax Property

Recipient's fax number.

Syntax

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

sender_fax = property(get_sender_fax, set_sender_fax)

Default Value

""

Remarks

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

sender_first_name Property

Sender's first name.

Syntax

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

sender_first_name = property(get_sender_first_name, set_sender_first_name)

Default Value

""

Remarks

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

sender_last_name Property

Person's last name.

Syntax

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

sender_last_name = property(get_sender_last_name, set_sender_last_name)

Default Value

""

Remarks

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

sender_middle_initial Property

Middle initial.

Syntax

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

sender_middle_initial = property(get_sender_middle_initial, set_sender_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

sender_phone Property

Identifies the contact person's phone number.

Syntax

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

sender_phone = property(get_sender_phone, set_sender_phone)

Default Value

""

Remarks

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

service_type Property

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

Syntax

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

service_type = property(get_service_type, set_service_type)

Default Value

0

Remarks

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

Valid values for FedEx are:

ship_date Property

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

Syntax

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

ship_date = property(get_ship_date, set_ship_date)

Default Value

""

Remarks

This is required to be provided in a ship request. The date should be the current date, or a date no more than 10 days in the future.

Defaults to current system date if not present.

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

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

shipment_special_services Property

Contains the collection of special services offered by FedEx.

Syntax

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

shipment_special_services = property(get_shipment_special_services, set_shipment_special_services)

Default Value

0

Remarks

To request any of the special services offered by FedEx in a ship request, you must set the shipment_special_services to a set of flags as listed below:

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

• COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery Premium. When shipping COD via FedEx Ground, the COD details must be provided on the Package level.
• Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested (i.e., when the corresponding Dry Ice flag is contained in the shipment_special_services), then the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). This is allowed for FedEx Express shipments only.
• Event Notification: Indicates that event notification is requested. This might affect the service availability. If this is requested in a ship request, then the notify collection is required to be set.
• Hold At Location: This is applicable for FedEx Express services only. Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, and when the recipient_address_flags is set to Residential (i.e., for residential delivery). When this service is requested (i.e., when the corresponding Hold At Location flag is contained in the shipment_special_services), then the hold_at_location is required to be provided in the request as well.
• Home Delivery: Indicates that the Home Delivery Premium special service is requested. This is applicable for residential delivery only (i.e., when this is present in the request, the recipient_address_flags is automatically set to Residential in the request). If service_type is set to GROUND HOME DELIVERY, the corresponding flag of Home Delivery is automatically added to the shipment_special_services. In this case, the home_delivery_date, home_delivery_phone, and home_delivery_type properties are required to be provided in the request as well. This property is applicable for FedEx Ground services only.
• Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Pending Shipment Indicates that an email label has been requested. When this option is selected, you will need to also set the notify property to specify the email address to send to and the message to be sent. You will also need to set the MerchantPhoneNumber and EmailLabelExpirationDate configuration settings. When this option is selected a label will not be saved to the location in package_shipping_label_file, as the label will now be emailed to the recipient(s) specified in notify_email
• Return Shipment: Indicates that the return label is requested. This might affect the shipping rates and/or service availability. In this case, the RMANumber and RMAReason can be provided in the request. When this option is selected, the return label will be returned in the server response. The recipient can then apply this return label to the return package as needed and drop the package off at a FedEx drop off location. No charges are assessed until the label is used. Express and Ground return labels are interchangeable, regardless of the original shipping service. For example, you can send the original shipment using an express service, but include a Ground return label as part of your packing documents. Express/Ground Return Labels are available for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Ground, FedEx Home Delivery, FedEx 2Day Freight, and FedEx 3Day Freight throughout the 50 United States. FedEx Express Saver and FedEx 1Day Freight services are not available. Also, Dangerous Goods and Hazardous Materials cannot be shipped. Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location. The maximum declared value is $1,000 for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, and FedEx 2Day. The maximum declared value is $50,000 for FedEx 2Day Freight and FedEx 3Day Freight. The maximum declared value is $100 for FedEx Ground and FedEx Home Delivery.
• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and you want Saturday delivery, the ground option and some express option will not be valid.
• Saturday Pickup: Indicates that you request to have the shipment picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and you want Saturday pickup, the ground option and some express option will not be valid.
• ThirdParty Consignee: Indicates that the third party special service is requested. This might affect the shipping rates and/or service availability.
• Electronic Trade Documents: This only applies when shipping internationally. FedEx will generate and submit your trade documents specified in the ShippingDocumentTypes electronically and you no longer need to print and attach them. Note that some countries do not accept Electronic Trade Documents (ETD). For a full list of countries that support ETD you can go to http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.

  If you also want to receive copies of the FedEx generated documents use the requested_etd_documents property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them.

• Broker Select: Indicates that the broker select special service is requested. When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the shipment_special_services value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:
  • stFedExInternationalPriority (20)
  • stFedExInternationalEconomy (21)
  • stFedExInternationalPriorityFreight (23)
  • stFedExInternationalEconomyFreight (24)
  • stFedExInternationalPriorityExpress (32)
  • stFedExInternationalConnectPlus (33)
  FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the clearance_brokerage_type, broker_type, broker_contact, and broker_address are required to be provided in the ship request as well.

  Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

• East Coast Special: Indicates that East Coast special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.
• International Controlled Export Service Indicates that the Controlled Export service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
• International Traffic in Arms Regulations Indicates that the Traffic in Arms Regulations service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
• FedEx One Rate Shipping Indicates that FedEx One Rate packaging is being used. This is only applicable for when using a U.S. origin and destination, excluding Hawaii. Valid service types are listed below as both the :

  ServiceType	FedEx Service
  stFedExPriorityOvernight (10)	PRIORITY_OVERNIGHT
  stFedExStandardOvernight (11)	STANDARD_OVERNIGHT
  stFedExFirstOvernight (12)	FIRST_OVERNIGHT
  stFedExExpressSaver (14)	FEDEX_EXPRESS_SAVER
  stFedEx2Day (13)	FEDEX_2_DAY
  stFedEx2DayAM (27)	FEDEX_2_DAY_AM

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

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

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

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

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

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

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

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

Syntax

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

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

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

If timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the timeout property is 60 seconds.

total_net_charge Property

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

Syntax

def get_total_net_charge() -> str: ...

total_net_charge = property(get_total_net_charge, None)

Default Value

""

Remarks

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

This property is read-only.

total_weight Property

Total shipment weight.

Syntax

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

total_weight = property(get_total_weight, set_total_weight)

Default Value

""

Remarks

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

transit_time Property

Expected number of days in transit from pickup to delivery.

Syntax

def get_transit_time() -> str: ...

transit_time = property(get_transit_time, None)

Default Value

""

Remarks

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

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

This property is read-only.

cancel_package Method

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

Syntax

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

Remarks

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

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

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

• 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 Carrier Pickup request.

Syntax

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

Remarks

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

You must enter the following information:

• ConfirmationNumber (required)
• fed_ex_account_number (required)
• carrier_type (required)
• ship_date (required)
• location (required for canceling an express pickup)
• SpecialInstructions (required for canceling ground pickup)

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

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

cancel_shipment Method

Cancels all packages within the shipment.

Syntax

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

Remarks

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

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

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

• fed_ex_account_number (required)
• sender_country_code

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

close_ground_shipments Method

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

Syntax

def close_ground_shipments() -> None: ...

Remarks

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

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

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

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

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

• fed_ex_authorization_token (required)
• fed_ex_server (optional)
• fed_ex_account_number (required)
• close_request (required)

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

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

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_package_label Method

Generates a shipping label for the specified package.

Syntax

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

Remarks

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

• 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)
• packages (required)
• label_image_type (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

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

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

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

get_shipment_labels Method

Generates a shipping label for all packages in the shipment.

Syntax

def get_shipment_labels() -> None: ...

Remarks

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

• 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)
• packages (required)
• label_image_type (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

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

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

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

pickup_availability Method

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

Syntax

def pickup_availability() -> None: ...

Remarks

The PickupAvailability method requires the values for the following properties:

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

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:

• carrier_type (required, valid values are ctFDXG (FedEx Ground) or ctFDXE (FedEx Express))
• company_close_time
• packages (required if PackageCount is not set)
• package_location
• 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)
• ship_date
• ShipTime
• PackageCount (optional)
• total_weight (required)
• SpecialInstructions (optional)
• 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.

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_notification Event

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

Syntax

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

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

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the on_notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

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

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

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

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

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

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

Remarks

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

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

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

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

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

Remarks

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

FedExShip Config Settings

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

FedExShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

FedExShip Errors

FedExShip Errors

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

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