EzShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a shipping label for any domestic services complete with addresses and barcode.

Syntax

class dshippingsdk.EzShip

Remarks

The EzShip class provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the class that is specific to the carrier.

Note that this component is only valid for domestic shipments. If you would like to perform international shipments, you will need to use the international class that is specific to the carrier.

Generating a shipping label can be done by calling the get_shipment_labels method. You will have to specify the package information, service_type to be used for shipping this package, origin and destination information, and any other special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery, etc.).

To use this class, you must set the appropriate account settings for the specified provider.

Canada Post Setup and Required Properties

When retrieving shipping labels via Canada Post, the following fields are required:

You can optionally set the following fields when requesting rates:

Note: A shipping label will only be retrieved for the first package within packages, as multiple package shipments are not supported.

After a successful get_shipment_labels call, the following fields will be populated:

The Canada Post URLS are:

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.

account_number Property

The shipper's account number.

Syntax

def get_account_number() -> str: ...
def set_account_number(value: str) -> None: ...

account_number = property(get_account_number, set_account_number)

Default Value

""

Remarks

The shipper's account number.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

authorization_token Property

Authorization Token used to authenticate the request.

Syntax

def get_authorization_token() -> str: ...
def set_authorization_token(value: str) -> None: ...

authorization_token = property(get_authorization_token, set_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.

password Property

Password for logging in to the Server .

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

Password for logging in to the server.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the login password for your Canada Post account.

server Property

URL for the server where the requests are sent.

Syntax

def get_server() -> str: ...
def set_server(value: str) -> None: ...

server = property(get_server, set_server)

Default Value

""

Remarks

URL for the server where the requests are sent.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

user_id Property

User Id for logging in to the Server .

Syntax

def get_user_id() -> str: ...
def set_user_id(value: str) -> None: ...

user_id = property(get_user_id, set_user_id)

Default Value

""

Remarks

User Id for logging in to the server.

This property is not used by FedEx.

For Canada Post, this field should be set to the login username for your Canada Post account

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 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 host is specified, the user and 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 host. See the description of the host property for details.

Note: This property is set automatically when firewalltype is set to a valid value. See the description of the firewalltype 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 host is specified, this property and password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

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 shipping label formatting and has to be set when the get_shipment_labels method is called. The value selection depends on the printer type used to print the shipping label.

Valid image types are listed below:

Note that all USPS shipping types support sitTIF and sitPDF label_image_types except stUSPSExpress service_type, which supports sitGIF and sitPDF.

The valid values when using Endicia are sitEPL, sitGIF, sitJPG, sitPNG, and sitZPL, when the service_type is stUSPSFirstClass, stUSPSPriority, stUSPSLibrary, stUSPSMedia, or stUSPSParcelPost otherwise, only sitGIF, sitJPG, and sitPNG are supported.

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.

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.

MPS shipments are not currently supported in USPS, and thus this property does not return anything for USPS shipments.

For Canada Post, this property will be set to the unique identifier for the shipment.

This property is read-only.

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_description
• package_height
• package_insured_value
• package_length
• package_net_charge
• package_reference
• package_return_receipt
• package_return_receipt_file
• 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_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_return_receipt Property

Image of the receipt for a return shipment.

Syntax

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

Default Value

""

Remarks

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the package_return_receipt_file is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

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

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

Syntax

def get_package_return_receipt_file(package_idx: int) -> str: ...
def set_package_return_receipt_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Filename and location to save the package_return_receipt of this package to. This is applicable only if using UPS.

When the package_return_receipt_file is set to a valid path and filename, the contents of the package_return_receipt are written to disk upon successful response (if a return shipment).

The package_return_receipt_file has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

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

provider Property

Which provider to use.

Syntax

def get_provider() -> int: ...
def set_provider(value: int) -> None: ...

provider = property(get_provider, set_provider)

Default Value

0

Remarks

The "Ez" classs support FedEx, UPS, USPS, and Canada Post servers. This property tells the class which protocol to use.

NOTE: When this property is set, all properties of the class will be reset to their default values.

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 user and password properties are set.

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

By default, authscheme is authBasic (0), and if the user and password properties are set, the component will attempt basic authentication.

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

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

For security reasons, setting this property will clear the values of user and 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 authscheme is set to Basic Authentication, the user and password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If authscheme is set to Digest Authentication, the user and password properties are used to respond to the Digest Authentication challenge from the server.

If authscheme is set to NTLM Authentication, the user and 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 server (default 80). See the description of the 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 server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the 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 authscheme is set to Basic Authentication, the user and password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If authscheme is set to Digest Authentication, the user and password properties are used to respond to the Digest Authentication challenge from the server.

If authscheme is set to NTLM Authentication, the user and 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.

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

Valid values for FedEx are:

Valid values for UPS are:

Valid values for USPS are:

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

ship_date Property

Date package will be mailed.

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

For FedEx, this is the date on which the package was tendered to FedEx. This is required to be provided in a ship request. This date should not be a past date or a date more than 10 days in the future. If not provided, defaults to the current date. Format: YYYY-MM-DD (e.g. 2024-09-30).

This property is not applicable to UPS.

For USPS, you can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. Ship date may be today plus 0 to 3 days in advance. Enter the date in either format: dd-mmm-yyyy, such as 14-Feb-2024, or mm/dd/yyyy, such as 02/14/2024.

shipment_special_services Property

Contains the collection of special services offered.

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 (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

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 store and subject properties also may be used to specify a certificate.

When encoded is set, a search is initiated in the current store for the private key of the certificate. If the key is found, subject is updated to reflect the full subject of the selected certificate; otherwise, 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 store and subject properties also may be used to specify a certificate.

When encoded is set, a search is initiated in the current store for the private key of the certificate. If the key is found, subject is updated to reflect the full subject of the selected certificate; otherwise, 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 storetype property denotes the type of the certificate store specified by store. If the store is password protected, specify the password in storepassword.

store is used in conjunction with the subject property to specify client certificates. If store has a value, and subject or encoded is set, a search for a certificate is initiated. Please see the 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 store and subject properties also may be used to specify a certificate.

When encoded is set, a search is initiated in the current store for the private key of the certificate. If the key is found, subject is updated to reflect the full subject of the selected certificate; otherwise, 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 not valid for USPS or CanadaPost shipments.

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_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:

• account (required)
• sender_contact (required)
• sender_address (required)
• recipient_contact (required)
• recipient_address (required)
• service_type (required)
• packages (required)
• payor (required for FedEx and UPS)
• label_image_type (required)
• ship_date (required for FedEx)
• shipment_special_services (optional)

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

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class EzShip:
@property
def on_notification() -> Callable[[EzShipNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[EzShipNotificationEventParams], 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 EzShipSSLServerAuthenticationEventParams(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 EzShip:
@property
def on_ssl_server_authentication() -> Callable[[EzShipSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[EzShipSSLServerAuthenticationEventParams], 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 EzShipSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

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

EzShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

EzShip Errors

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