FedExTrack Class

Properties   Methods   Events   Config Settings   Errors  

Provides tracking information, SPOD, and notification for a given tracking number or other shipment identifier.

Syntax

class dshippingsdk.FedExTrack

Remarks

This class provides Tracking, Signature Proof of Delivery (SPOD), and Notification services:

• Tracking Service: to obtain real-time tracking information for FedEx Express, FedEx Ground, FedEx Home Delivery, FedEx Express Freight, and FedEx Custom Critical shipments.
• Signature Proof of Delivery (SPOD): to request a proof of delivery letter that includes a graphic image of your recipient's signature after your shipment has been delivered.
• Notification to have FedEx automatically notify you and/or your customer and/or another third party by e-mail, fax, or wireless of significant shipment events, such as clearance delays, delivery attempts, releases, consolidated proofs of delivery, and pre-alerts.

The available options for Tracking service are:

Track by Tracking Number

On Single Piece Shipments, the tracking number represents the package's tracking number. This option applies to Express, Ground, Freight and Custom Critical shipments. You can track any package shipped by FedEx using track_shipment method by providing this number as the value of idValue parameter. No extra qualifiers (date range, etc.) are required in such case, but are recommended. It is also recommended that you provide the Carrier Code to ensure the desired results for your request. This class handles tracking numbers individually, not in batch.

On Multiple Package Shipments (MPS), the tracking number represents either the master tracking number or one of the associated sequential tracking numbers for child packages. This option is available for: Express and Ground (Domestic and International) multiple-package shipments, Express and Ground (Domestic and International) C.O.D. multiple-package shipments.

Tracking by the master tracking number returns tracking data for all child tracking numbers associated with the master.

Tracking by the child tracking number returns tracking data on the specific shipment associated with that tracking number.

Track by other identifier

This identifier can be a:

• Reference Number This option applies to Express, Ground, Freight, and Custom Critical shipments. You can track packages by a reference number entered during the shipping transaction. Track by Reference Number can use any of the following sources: Shipper/Customer Reference, Invoice Number, Purchase Order (PO), Department, Part Number, Returns Material Authorization (RMA), Transportation Control Number (TCN), Bill of Lading (BOL).
• Door Tag Number This option is available for Express and Ground U.S. and Canadian shipments. This option allows you to track by a FedEx Door Tag number. A Door Tag is left at the recipient's shipping address if the recipient is not there to receive the package. A Door Tag number is linked at FedEx with the package's original tracking number. This tracking functionality allows you to track using only the Door Tag number without requiring the associated tracking number. No additional search elements are required to track by Door Tag. You may request tracking scan information for any packages shipped by FedEx by providing a valid Door Tag Number.

To track by identifiers other than tracking number, the track_shipment method should be called by providing an idValue and the identifier_type, as well as other required values described in detail in this method description depending on the identifier type.

When the track request has been made for an identifier of type other than Tracking Number, either the shipper_account_number or the recipient_country_code and recipient_zip_code (where applicable) are required to be provided in the request.

Upon successful request, the user will receive the current shipment status with a detailed tracking activity.

To confirm a shipment has been received and signed for, you can call the get_proof_of_delivery or save_proof_of_delivery methods. With this feature, you can request a letter that includes a graphic of the recipient's signature for FedEx Express and FedEx Ground shipments. The SPOD is returned in PDF format and may be printed, browsed, or e-mailed. There is no charge for Signature Proof of Delivery.

You can use Tracking service to check the status of your shipment at any time during delivery and up to 18 months after delivery. You can use SPOD service to obtain an image of the recipient's signature (if the signature is available) once the shipment has been delivered.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the shipper_account_number is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the shipper_account_number is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

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

Property List

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

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

FedEx carrier code description used for shipment.

Syntax

def get_carrier_code_description() -> str: ...

carrier_code_description = property(get_carrier_code_description, None)

Default Value

""

Remarks

Specifies the particular carrier used to ship the packages being tracked.

Upon successful request, this is always returned when the track_shipment and request_email_notification methods are called.

This property is read-only.

estimated_pickup_date Property

Estimated package pickup date for shipments that haven't been picked up yet.

Syntax

def get_estimated_pickup_date() -> str: ...

estimated_pickup_date = property(get_estimated_pickup_date, None)

Default Value

""

Remarks

This property is returned in the server response only if applicable.

Format: YYYY-MM-DD.

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.

identifier_type Property

Type of shipment identifier by which the shipment is to be tracked.

Syntax

def get_identifier_type() -> int: ...
def set_identifier_type(value: int) -> None: ...

identifier_type = property(get_identifier_type, set_identifier_type)

Default Value

0

Remarks

This is required if the track request will be made for an identifier other than Tracking Number.

Possible values are as follows:

To limit the number of tracking replies for a specific reference, you can enter a date range (ship_date_start and ship_date_end) for this search.

When the track request has been made for an identifier of type other than Tracking Number, either the shipper_account_number or the recipient_country_code and recipient_zip_code (where applicable) are required to be provided in the request.

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

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

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.

package_count Property

The number of packages returned for a given tracking number or any other shipment identifier.

Syntax

def get_package_count() -> int: ...

package_count = property(get_package_count, None)

Default Value

1

Remarks

This property contains the number of packages returned from the FedEx server after calling the track_shipment.

This property is read-only.

package_delivery_anc_action Property

Delivery ancillary action recommended for customer to resolve the delivery issue for the package at PackageIndex .

Syntax

def get_package_delivery_anc_action() -> str: ...

package_delivery_anc_action = property(get_package_delivery_anc_action, None)

Default Value

""

Remarks

This property may be returned in server response when the track_shipment method is called.

This property is read-only.

package_delivery_anc_action_desc Property

Delivery ancillary action description. Field which holds recommended action description to resolve delivery issue for the package at PackageIndex .

Syntax

def get_package_delivery_anc_action_desc() -> str: ...

package_delivery_anc_action_desc = property(get_package_delivery_anc_action_desc, None)

Default Value

""

Remarks

This property may be returned in server response when the track_shipment method is called.

Example: "Customer not Available or Business Closed"

This property is read-only.

package_delivery_anc_reason_desc Property

Delivery ancillary reason description. Field which holds reason description associated to the status of the package at PackageIndex .

Syntax

def get_package_delivery_anc_reason_desc() -> str: ...

package_delivery_anc_reason_desc = property(get_package_delivery_anc_reason_desc, None)

Default Value

""

Remarks

This property may be returned in server response when the track_shipment method is called.

Example: "Customer not Available or Business Closed"

This property is read-only.

package_delivery_date Property

Actual date when the package at PackageIndex was delivered at destination (if applicable).

Syntax

def get_package_delivery_date() -> str: ...

package_delivery_date = property(get_package_delivery_date, None)

Default Value

""

Remarks

When the track_shipment method is called, package_delivery_date is returned in the response only if the package has been delivered.

Format: YYYY-MM-DD.

This property is read-only.

package_delivery_estimate Property

Projected delivery date for the package at PackageIndex based on the ship date, service and destination address.

Syntax

def get_package_delivery_estimate() -> str: ...

package_delivery_estimate = property(get_package_delivery_estimate, None)

Default Value

""

Remarks

When the track_shipment method is called, the package_delivery_estimate is populated only if delivery has not already occurred.

Format: YYYY-MM-DD.

This property is read-only.

package_delivery_location Property

Relative location at which package at PackageIndex was left (if package delivered).

Syntax

def get_package_delivery_location() -> str: ...

package_delivery_location = property(get_package_delivery_location, None)

Default Value

""

Remarks

When the track_shipment method is called, package_delivery_location is returned in the response only if this package has been delivered.

This might be such as Front Desk, Back Door, etc. It is applicable for Express services only.

This property is read-only.

package_delivery_status Property

Delivery status description of the package at PackageIndex .

Syntax

def get_package_delivery_status() -> str: ...

package_delivery_status = property(get_package_delivery_status, None)

Default Value

""

Remarks

This is applicable for Express services only. Maximum length: 25.

This property is read-only.

package_error_message Property

The error message corresponding to the PackageIndex .

Syntax

def get_package_error_message() -> str: ...

package_error_message = property(get_package_error_message, None)

Default Value

""

Remarks

This property may be returned in server response when the track_shipment method is called.

This property is read-only.

package_index Property

The package index in a shipment being tracked.

Syntax

def get_package_index() -> int: ...
def set_package_index(value: int) -> None: ...

package_index = property(get_package_index, set_package_index)

Default Value

0

Remarks

This property contains the index of a package contained in the shipment.

The package_count will contain the number of packages included in a shipment and the package_index will contain the package index in the list of packages.

To retrieve all attributes corresponding to a package, the package_index should be set from 0 to package_count - 1.

package_packaging_type Property

Description of packaging type of the package at PackageIndex .

Syntax

def get_package_packaging_type() -> str: ...

package_packaging_type = property(get_package_packaging_type, None)

Default Value

""

Remarks

This is returned for Express services only. Possible values are: 'FedEx Envelope', 'FedEx Box', etc.

This property is read-only.

package_received_by Property

The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .

Syntax

def get_package_received_by() -> str: ...

package_received_by = property(get_package_received_by, None)

Default Value

""

Remarks

This corresponds to the package at package_index and is returned only if this package has already been delivered. To retrieve this property, the package_index should be set from 0 to package_count - 1.

This property is read-only.

package_references Property

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Syntax

def get_package_references() -> str: ...

package_references = property(get_package_references, None)

Default Value

""

Remarks

This should be inspected after a call to the track_shipment method. When populated, it is a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).

Reference Type can be any of the following values:

This property is read-only.

package_service_type_description Property

String describing the service type used to ship the package at PackageIndex being tracked.

Syntax

def get_package_service_type_description() -> str: ...

package_service_type_description = property(get_package_service_type_description, None)

Default Value

""

Remarks

This might be one of FedEx available services, such as 'Priority Pack', 'Standard Overnight', etc.

This property is read-only.

package_signed_by Property

Signature of person who signed for package at PackageIndex .

Syntax

def get_package_signed_by() -> str: ...

package_signed_by = property(get_package_signed_by, None)

Default Value

""

Remarks

This corresponds to the package at package_index and is returned only if this package has already been delivered. If the signature confirmation is not selected when the shipping label was generated, the package_signed_by might also be a relative location at which package was left, such as Front Desk or Back Door.

This property is read-only.

package_tracking_number Property

Tracking number for the package at PackageIndex .

Syntax

def get_package_tracking_number() -> str: ...

package_tracking_number = property(get_package_tracking_number, None)

Default Value

""

Remarks

This indicates tracking number assigned by FedEx when the shipping label was generated. Maximum length: 20.

Note: Door Tag will never be returned in the response.

This property is read-only.

package_weight Property

Weight of the package at PackageIndex .

Syntax

def get_package_weight() -> str: ...

package_weight = property(get_package_weight, None)

Default Value

""

Remarks

This corresponds to the package at package_index position in the list of packages contained in the shipment.

This property is read-only.

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.

sender_address1 Property

Street name.

Syntax

def get_sender_address1() -> str: ...

sender_address1 = property(get_sender_address1, None)

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.

This property is read-only.

sender_address2 Property

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

Syntax

def get_sender_address2() -> str: ...

sender_address2 = property(get_sender_address2, None)

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.

This property is read-only.

sender_address_flags Property

Various flags that denote information about the address.

Syntax

def get_sender_address_flags() -> int: ...

sender_address_flags = property(get_sender_address_flags, None)

Default Value

0

Remarks

Various flags that denote information about the address.

This property is read-only.

sender_city Property

Name of city, town, etc.

Syntax

def get_sender_city() -> str: ...

sender_city = property(get_sender_city, None)

Default Value

""

Remarks

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

This property is read-only.

sender_country_code Property

Country code.

Syntax

def get_sender_country_code() -> str: ...

sender_country_code = property(get_sender_country_code, None)

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

This property is read-only.

sender_state Property

State or province code.

Syntax

def get_sender_state() -> str: ...

sender_state = property(get_sender_state, None)

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.

This property is read-only.

sender_zip_code Property

Postal code.

Syntax

def get_sender_zip_code() -> str: ...

sender_zip_code = property(get_sender_zip_code, None)

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.

This property is read-only.

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.

ship_date Property

The date on which the package was 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

Upon successful request, this is always returned when the track_shipment and request_email_notification methods are called.

Format: YYYY-MM-DD.

ship_date_end Property

End of ship date range used to narrow search.

Syntax

def get_ship_date_end() -> str: ...
def set_ship_date_end(value: str) -> None: ...

ship_date_end = property(get_ship_date_end, set_ship_date_end)

Default Value

""

Remarks

This property value is optional to be entered in a track request (when the track_shipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ship_date_start is required.

This is required though to be provided in an email notification request (when the request_email_notification method is called).

Format: YYYY-MM-DD.

ship_date_start Property

Start of ship date range used to narrow search.

Syntax

def get_ship_date_start() -> str: ...
def set_ship_date_start(value: str) -> None: ...

ship_date_start = property(get_ship_date_start, set_ship_date_start)

Default Value

""

Remarks

This property value is optional to be entered in a track request (when the track_shipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ship_date_end is required.

This is required though to be provided in a email notification request (when the request_email_notification method is called).

Format: YYYY-MM-DD.

shipper_account_number Property

Account number associated with shipment.

Syntax

def get_shipper_account_number() -> str: ...
def set_shipper_account_number(value: str) -> None: ...

shipper_account_number = property(get_shipper_account_number, set_shipper_account_number)

Default Value

""

Remarks

This indicates the account number associated with shipment (as opposed to the fed_ex_account_number, which is that of the party sending the request).

This property is optional and applicable in 2 types of track services:

• Tracking request made for an identifier of identifier_type other than Tracking Number; or
• Signature Proof of Delivery (SPOD) request;

In tracking request: When providing the shipper_account_number, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the recipient_country_code and recipient_zip_code (applicable countries) are required. The Reply data may be restricted if shipper_account_number is not provided.

In the SPOD request transaction: To view detailed SPOD information, include the 9-digit shipper_account_number when the get_proof_of_delivery or save_proof_of_delivery methods are called. If this is not provided, or if it does not match the shipper's or payor's FedEx account number, then summary SPOD information will be provided. Otherwise, the detailed SPOD (sender's and recipient's address details) will be included in the SPOD.

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:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

total_weight Property

Total shipment weight.

Syntax

def get_total_weight() -> str: ...

total_weight = property(get_total_weight, None)

Default Value

""

Remarks

This property is returned when the track_shipment method is called.

This property is read-only.

track_event_count Property

The number of records in the TrackEvent arrays.

Syntax

def get_track_event_count() -> int: ...

track_event_count = property(get_track_event_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• track_event_address1
• track_event_address2
• track_event_city
• track_event_country_code
• track_event_date
• track_event_exception
• track_event_state
• track_event_status
• track_event_time
• track_event_zip_code

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

This property is read-only.

track_event_address1 Property

Line 1 in the location address where a tracking event occurred (by package).

Syntax

def get_track_event_address1(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.

This is not available for USPS tracking requests.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_address2 Property

Line 2 in the location address where a tracking event occurred (by package).

Syntax

def get_track_event_address2(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.

This is not available for USPS tracking requests.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_city Property

Name of the city where the tracking event occurred.

Syntax

def get_track_event_city(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_country_code Property

Country code where the tracking event happened.

Syntax

def get_track_event_country_code(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Country code where the tracking event happened.

For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_date Property

Date the tracking event happened.

Syntax

def get_track_event_date(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Date the tracking event happened.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_exception Property

The most recent status exception for the tracking event.

Syntax

def get_track_event_exception(track_event_idx: int) -> str: ...

Default Value

""

Remarks

The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_state Property

State or province code where the tracking event occurred.

Syntax

def get_track_event_state(track_event_idx: int) -> str: ...

Default Value

""

Remarks

State or province code where the tracking event occurred. This is a two-letter standard abbreviation.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_status Property

Literal description of the tracking event.

Syntax

def get_track_event_status(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Literal description of the tracking event.

For UPS, possible values are:

For USPS, if request_type is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, track_event_status will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."

If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the track_event_status property that pertains to the specific TrackingNumber.

When request_type is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.

When using Endicia as your postage provider, status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_time Property

Time the tracking event occurred.

Syntax

def get_track_event_time(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Time the tracking event occurred.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

track_event_zip_code Property

Postal code where the tracking event happened.

Syntax

def get_track_event_zip_code(track_event_idx: int) -> str: ...

Default Value

""

Remarks

Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.

The track_event_idx parameter specifies the index of the item in the array. The size of the array is controlled by the track_event_count property.

This property is read-only.

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

Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .

Syntax

def get_proof_of_delivery(tracking_number: str) -> bytes: ...

Remarks

The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.

The following properties can be set when this method is called:

• fed_ex_authorization_token (required)
• fed_ex_server (optional)
• fed_ex_account_number (required)
• ship_date (required)
• shipper_account_number (optional)

This method will return the image of the SPOD. This is the decoded binary image file of the Signature Proof of Delivery (SPOD), stored in memory.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the shipper_account_number is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the shipper_account_number is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

request_email_notification Method

Request email notification for a specified trackingNumber to a specified Recipients list.

Syntax

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

Remarks

The trackingNumber parameter identifies the shipment the notification will be requested for. Via this method, you send notification of package state to up to four e-mail addresses.

The following properties can be set when this method is called:

• fed_ex_authorization_token (required)
• fed_ex_server (optional)
• fed_ex_account_number (required)
• ship_date_start (required)
• ship_date_end (required)
• sender_contact (by specifying sender_first_name, sender_last_name, and sender_email - required)
• notify (required)
• message (optional)

Notification allows you to request that e-mail exception and delivery notifications be sent to you, your recipient, and up to 2 other e-mail addresses (by specifying the notify). A personal message can also be included via the message property.

FedEx services offering this feature are FedEx Express (FDXE), FedEx Ground (FDXG), FedEx Cargo (FDXC), FedEx Custom Critical (FXCC), and FedEx Freight (FXFR). FedEx SmartPost shipments are not included in this feature.

There are three notification options:

• Shipment notification. In this case, the ntOnShipment flag should be set in the notify_flags property for that recipient;
• Exception notification (such as if an exception occurs during scanning and the package may be delayed, for example, or if an address correction is required. In this case, the ntOnException flag should be set in the notify_flags property for that recipient; or
• Delivery notification. In this case, the ntOnDelivery flag should be set in the notify_flags property for that recipient;

You must choose between these delivery types: wireless (to a cell phone), text only e-mail, and HTML e-mail by setting the notify_flags to any of the desired options.

A personal message, which can be included in the request via the message, up to 120 characters) is allowed for e-mail notifications only. This is not applicable for wireless notifications.

If there is a problem with the trackingNumber, or recipients' information, the response will raise an error that pertains to that element. For more details on errors codes and descriptions, please refer to the Error Codes section.

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

save_proof_of_delivery Method

Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .

Syntax

def save_proof_of_delivery(tracking_number: str, filename: str) -> None: ...

Remarks

The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.

The following properties can be set when this method is called:

• fed_ex_authorization_token (required)
• fed_ex_server (optional)
• fed_ex_account_number (required)
• ship_date (required)
• shipper_account_number (optional)

The filename parameter describes the location on disk to write the returned image of the SPOD to. This filename should have the .pdf extension.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting. The default value of this config is True.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the shipper_account_number is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the shipper_account_number is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

track_shipment Method

Returns tracking data for requested idValue of IdentifierType type.

Syntax

def track_shipment(id_value: str) -> None: ...

Remarks

The idValue parameter identifies the shipment. This identifier can be of identifier_type type. Some identifiers apply to a single package (such as Package Tracking Number), while others apply to multiple packages or shipments of which they are part of. The idValue must be alphanumeric.

FedEx uses shipment identification numbers and types to identify and trace every shipment as it goes through the FedEx system to its destination. You can use this shipment identification number and type to track, locate, and verify arrival of a shipment.

When sending a tracking request to the FedEx server, there is information that the server requires before it will process the request. The following properties can be sent in the request in order to track by tracking number or by any other identifier:

• fed_ex_authorization_token (required)
• fed_ex_server (optional)
• fed_ex_account_number (required)
• ship_date_start (optional)
• ship_date_end (optional)
• shipper_account_number (optional)
• recipient_country_code (optional)
• recipient_zip_code (optional)

A successful query returns all of the packages within a shipment. For example, if a shipment contained four packages, the query response would show all four packages.

If FedEx system doesn't locate any data for the requested identifier, the transaction will be considered successful and the Warning will contain the 'No data...' message. The full server reply will be saved to RawResponse.

The following properties may be populated upon method return:

• carrier_code_description
• ship_date
• package_tracking_number
• package_service_type_description
• package_packaging_type
• package_delivery_status
• package_delivery_estimate
• package_delivery_date
• package_delivery_location
• package_error_message
• package_signed_by
• sender_address
• recipient_address
• total_weight and WeightUnit;
• Tracking details for each tracking event, which can be inspected via track_events collection. This information consists of: track_event_address1, track_event_address2, track_event_city, track_event_state, track_event_country_code, track_event_zip_code, track_event_date, track_event_time, track_event_status and track_event_exception.

If there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific idValue of a identifier_type type.

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

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class FedExTrack:
@property
def on_notification() -> Callable[[FedExTrackNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[FedExTrackNotificationEventParams], 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 FedExTrackSSLServerAuthenticationEventParams(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 FedExTrack:
@property
def on_ssl_server_authentication() -> Callable[[FedExTrackSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FedExTrackSSLServerAuthenticationEventParams], 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 FedExTrackSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

FedExTrack Config Settings

FedExTrack Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

FedExTrack Errors

FedExTrack Errors

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