CanadaPostShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate international labels using Canada Post.

Syntax

class dshippingsdk.CanadaPostShipIntl

Remarks

Generating a shipping label can be done by calling the get_package_label method. You will need to specify the packages details, the Canada Post service_type to be used for shipping the package, the origin and destination information, and any other shipment_special_services that should be associated with the shipment (such as COD, Return Shipment, Deliver to Post Office, etc.).

You should also specify the commodities for all packages. Note that Canada Post will use this information to generate a commercial invoice, which will be returned to you in PDF format in the international_form property, unless international_form_file is set, in which case the file will be saved to the path specified.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
2. Call transmit_shipments with the group_id for the shipment.
3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

If you wish to cancel a package before you call transmit_shipments for that shipment, you can call cancel_shipment and the package will be voided.

In order to use this class you will need to have a CanadaPost canada_post_account_number, which is your customer number. You will also need to have signed up for the Developer Program and obtained a canada_post_user_id and canada_post_password.

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.

canada_post_account_number Property

The shipper's account number.

Syntax

def get_canada_post_account_number() -> str: ...
def set_canada_post_account_number(value: str) -> None: ...

canada_post_account_number = property(get_canada_post_account_number, set_canada_post_account_number)

Default Value

""

Remarks

The shipper's account number.

This field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

canada_post_contract_id Property

This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.

Syntax

def get_canada_post_contract_id() -> str: ...
def set_canada_post_contract_id(value: str) -> None: ...

canada_post_contract_id = property(get_canada_post_contract_id, set_canada_post_contract_id)

Default Value

""

Remarks

This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.

When specified the negotiated rates for the contract will be used. If not specified the standard list rates will be used.

canada_post_password Property

Password for logging in to the Server .

Syntax

def get_canada_post_password() -> str: ...
def set_canada_post_password(value: str) -> None: ...

canada_post_password = property(get_canada_post_password, set_canada_post_password)

Default Value

""

Remarks

Password for logging in to the server.

This property must be set to the login password for your Canada Post account.

canada_post_server Property

URL for the server where the requests are sent.

Syntax

def get_canada_post_server() -> str: ...
def set_canada_post_server(value: str) -> None: ...

canada_post_server = property(get_canada_post_server, set_canada_post_server)

Default Value

"https://soa-gw.canadapost.ca/"

Remarks

URL for the server where the requests are sent.

By default this is set to Canada Post's production server: "https://soa-gw.canadapost.ca/"

canada_post_user_id Property

User Id for logging in to the Server .

Syntax

def get_canada_post_user_id() -> str: ...
def set_canada_post_user_id(value: str) -> None: ...

canada_post_user_id = property(get_canada_post_user_id, set_canada_post_user_id)

Default Value

""

Remarks

User Id for logging in to the canada_post_server.

This property must be set to the login username for your Canada Post account

commodity_count Property

The number of records in the Commodity arrays.

Syntax

def get_commodity_count() -> int: ...
def set_commodity_count(value: int) -> None: ...

commodity_count = property(get_commodity_count, set_commodity_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• commodity_description
• commodity_harmonized_code
• commodity_manufacturer
• commodity_number_of_pieces
• commodity_unit_price
• commodity_weight

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

commodity_description Property

Complete and accurate description of this commodity line item.

Syntax

def get_commodity_description(commodity_idx: int) -> str: ...
def set_commodity_description(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

It is applicable to all international forms. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

For FedEx, if the shipment contains documents only (i.e., Documents is set to True), then the commodity_description has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_harmonized_code Property

Unique code representing this commodity line item (for imports only).

Syntax

def get_commodity_harmonized_code(commodity_idx: int) -> str: ...
def set_commodity_harmonized_code(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in commodity_description, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_harmonized_code is required for each commodity line item for shipments to EU countries.

At least one occurrence is required for U.S. Export shipments if the total_customs_value is greater than 2,500 USD or if a valid U.S. Export license is required.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_manufacturer Property

Country code where the contents of this commodity line were produced, manufactured or grown in their final form.

Syntax

def get_commodity_manufacturer(commodity_idx: int) -> str: ...
def set_commodity_manufacturer(commodity_idx: int, value: str) -> None: ...

Default Value

"US"

Remarks

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the commodity_manufacturer is required to be entered.

In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the commodity_manufacturer and commodity_description are required to be provided in the request. If the commodity_manufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The commodity_manufacturer has to be provided for each commodity item included in that international shipment.

In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.

In USPS, the value of this property is optional, and is only used by commercial shippers. If postage_provider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.).

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_number_of_pieces Property

The total number of packages, cartons, or containers for the commodity line item.

Syntax

def get_commodity_number_of_pieces(commodity_idx: int) -> int: ...
def set_commodity_number_of_pieces(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

The total number of packages, cartons, or containers for the commodity line item.

In UPS, it is required and applicable to CO only.

In FedEx, if the Documents is set to False in ship request, the commodity_number_of_pieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

This property is not applicable to USPS.

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_unit_price Property

Value of each QuantityUnit in Quantity of this commodity line item.

Syntax

def get_commodity_unit_price(commodity_idx: int) -> str: ...
def set_commodity_unit_price(commodity_idx: int, value: str) -> None: ...

Default Value

"1.00"

Remarks

Value of each commodity_quantity_unit in commodity_quantity of this commodity line item. This is used in conjunction with the commodity_quantity_unit and commodity_quantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

For FedEx, when the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_unit_price is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, it is required and applicable to Invoice and Partial Invoice forms only.

For USPS, use the commodity_value property instead.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

commodity_weight Property

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.

Syntax

def get_commodity_weight(commodity_idx: int) -> str: ...
def set_commodity_weight(commodity_idx: int, value: str) -> None: ...

Default Value

"0.00"

Remarks

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the commodity_weight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, this is required and applicable to CO and SED forms only .

When using USPS and postage_provider is set to ppNone, the format of this property must be "XX lbs YY oz", where XX is the number of pounds and YY is the number of ounces.

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

The commodity_idx parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

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.

group_id Property

The Group Id that will be associated with the shipment.

Syntax

def get_group_id() -> str: ...
def set_group_id(value: str) -> None: ...

group_id = property(get_group_id, set_group_id)

Default Value

""

Remarks

This property is used to specify the Group Id that will be associated with the shipment.

This is a user specified value and may be a number or string up to 32 characters in length. It is used by Canada Post to group shipments together for reporting purposes. If the specified group does not exist, it will be created automatically by the Canada Post service.

This value is required when canada_post_contract_id is specified.

international_form Property

Image of the international form.

Syntax

def get_international_form() -> str: ...

international_form = property(get_international_form, None)

Default Value

""

Remarks

This is the decoded binary image file of the international form and will be populated on a get_package_label call if manifest_file is not set.

This property is read-only.

international_form_file Property

The location where the international form files will be written.

Syntax

def get_international_form_file() -> str: ...
def set_international_form_file(value: str) -> None: ...

international_form_file = property(get_international_form_file, set_international_form_file)

Default Value

""

Remarks

This should contain the full path to where the international form file will be written.

manifest Property

Image of the manifest.

Syntax

def get_manifest() -> str: ...

manifest = property(get_manifest, None)

Default Value

""

Remarks

This is the decoded binary image file of the Manifest and will be populated on a get_manifest call if manifest_file is not set.

This property is read-only.

manifest_count Property

The number of records in the Manifest arrays.

Syntax

def get_manifest_count() -> int: ...

manifest_count = property(get_manifest_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• manifest_account_number
• manifest_base_charge
• manifest_cc_auth_code
• manifest_cc_auth_timestamp
• manifest_cc_merchant_name
• manifest_cc_merchant_url
• manifest_cc_name_on_card
• manifest_contract_id
• manifest_customer_reference
• manifest_date
• manifest_destination_postal_code
• manifest_gst
• manifest_hst
• manifest_media_type
• manifest_net_charge
• manifest_origin_id
• manifest_origin_name
• manifest_payor_account_number
• manifest_po_number
• manifest_pst
• manifest_shipper_account_number
• manifest_time
• manifest_total_discount
• manifest_total_surcharge
• manifest_url

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

This property is read-only.

manifest_account_number Property

This is the 10-digit customer number of who mailed the package(s).

Syntax

def get_manifest_account_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the 10-digit customer number of who mailed the package(s).

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_base_charge Property

This is the total base cost for all shipments on the manifest.

Syntax

def get_manifest_base_charge(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total base cost for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_auth_code Property

The authorization code received from the credit card issuer.

Syntax

def get_manifest_cc_auth_code(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The authorization code received from the credit card issuer.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_auth_timestamp Property

The date and time that the credit card company authorized the transaction.

Syntax

def get_manifest_cc_auth_timestamp(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The date and time that the credit card company authorized the transaction.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_merchant_name Property

The merchant name used when charging the credit card.

Syntax

def get_manifest_cc_merchant_name(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The merchant name used when charging the credit card.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_merchant_url Property

The URL for the merchant who charged the credit card.

Syntax

def get_manifest_cc_merchant_url(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The URL for the merchant who charged the credit card.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_name_on_card Property

The name on the card that was charged.

Syntax

def get_manifest_cc_name_on_card(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The name on the card that was charged.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_contract_id Property

This is the contract number that was used for pricing this manifest.

Syntax

def get_manifest_contract_id(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the contract number that was used for pricing this manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_customer_reference Property

This is the reference property provided by the client in the transmit shipments request.

Syntax

def get_manifest_customer_reference(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the reference field provided by the client in the transmit shipments request.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_date Property

This is the date the manifest was generated.

Syntax

def get_manifest_date(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the date the manifest was generated.

The date format is as follows YYYY-MM-DD.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_destination_postal_code Property

The Postal code of the post office where the shipment is to be dropped off.

Syntax

def get_manifest_destination_postal_code(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Postal code of the post office where the shipment is to be dropped off.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_gst Property

The Good and Services Tax (GST) for all shipments on the manifest.

Syntax

def get_manifest_gst(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Good and Services Tax (GST) for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_hst Property

The Harmonized Sales Tax (HST) for all shipments on the manifest.

Syntax

def get_manifest_hst(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Harmonized Sales Tax (HST) for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_media_type Property

This contains the media-type attribute for the URL .

Syntax

def get_manifest_media_type(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This contains the media-type attribute for the manifest_url.

This will be populated after a call to transmit_shipments or search_manifests.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_net_charge Property

This is the total amount due to Canada Post for all shipments on the manifest.

Syntax

def get_manifest_net_charge(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total amount due to Canada Post for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_origin_id Property

This is the Canada Post identification number of the shipment's origin.

Syntax

def get_manifest_origin_id(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the Canada Post identification number of the shipment's origin.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_origin_name Property

This is the descriptive name of the shipment's origin as printed on the manifest.

Syntax

def get_manifest_origin_name(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the descriptive name of the shipment's origin as printed on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_payor_account_number Property

This is the 10-digit customer number of the customer who is paying for the shipment.

Syntax

def get_manifest_payor_account_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the 10-digit customer number of the customer who is paying for the shipment. This is often the same as the manifest_shipper_account_number.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_po_number Property

This is the PO number used for billing and will be displayed on the manifest.

Syntax

def get_manifest_po_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the PO number used for billing and will be displayed on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_pst Property

The Provincial Sales Tax (PST) for all shipments on the manifest.

Syntax

def get_manifest_pst(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Provincial Sales Tax (PST) for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_shipper_account_number Property

This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.

Syntax

def get_manifest_shipper_account_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_time Property

This is the time when the manifest was generated.

Syntax

def get_manifest_time(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the time when the manifest was generated.

The format for the time is HH:MM TZ.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_total_discount Property

This is the total discount for all shipments on the manifest.

Syntax

def get_manifest_total_discount(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total discount for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_total_surcharge Property

This is the total surcharge for all shipments on the manifest.

Syntax

def get_manifest_total_surcharge(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total surcharge for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_url Property

This property will contain the URL for the manifest.

Syntax

def get_manifest_url(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This property will contain the URL for the manifest.

This will be populated after a call to transmit_shipments or search_manifests.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_file Property

The location where the manifest files will be written.

Syntax

def get_manifest_file() -> str: ...
def set_manifest_file(value: str) -> None: ...

manifest_file = property(get_manifest_file, set_manifest_file)

Default Value

""

Remarks

This should contain the full path to where the manifest file will be written.

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_email
• notify_flags

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

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

Identifies the type of notification requested.

Syntax

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

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

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

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

For UPS notifications, the following flags apply:

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

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

This field is not used by USPS.

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

origin_postal_code Property

The Postal Code of the client sending location when using the Canada Post provider.

Syntax

def get_origin_postal_code() -> str: ...
def set_origin_postal_code(value: str) -> None: ...

origin_postal_code = property(get_origin_postal_code, set_origin_postal_code)

Default Value

""

Remarks

This property is used to specify the postal code of the client sending location to determine the nearest Post Office (this information is used for pricing). To force selection of a particular Post Office, the postal code of the desired Post Office should be used.

If packages are picked up by Canada Post enter the postal code of your location.

This must be set to a valid six character postal code such as A9A9A9

Note: This value is only used when a canada_post_contract_id is specified.

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_height
• package_insured_value
• package_length
• package_net_charge
• package_rating_aggregate
• package_reference
• package_return_receipt
• package_return_receipt_file
• package_shipping_label
• package_shipping_label_file
• package_signature_type
• package_size
• 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_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_rating_aggregate Property

Rating aggregate applicable to this package.

Syntax

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

Default Value

""

Remarks

Rating aggregate applicable to this package.

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

Size of the package being mailed.

Syntax

def get_package_size(package_idx: int) -> int: ...
def set_package_size(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Size of the package being mailed.

This property is only used by USPS and is required for the get_rates method call.

See below for valid entries:

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (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: Use the package_length, package_height, package_width and optionally package_girth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international 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_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.

payment_method Property

The intended payment method when using Canada Post.

Syntax

def get_payment_method() -> int: ...
def set_payment_method(value: int) -> None: ...

payment_method = property(get_payment_method, set_payment_method)

Default Value

0

Remarks

This field is used to specify the intended method of payment when shipping via Canada Post.

The available values are:

Note: This value is only used when a canada_post_contract_id is specified.

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.

reason_for_export Property

The reason for the export.

Syntax

def get_reason_for_export() -> int: ...
def set_reason_for_export(value: int) -> None: ...

reason_for_export = property(get_reason_for_export, set_reason_for_export)

Default Value

0

Remarks

This provides the reason for the export, which is necessary to generate the customs forms.

The valid values are as follows:

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.

Maximum Length: 44 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.

Maximum Length: 44 characters

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

"CA"

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.

recipient_postal_code Property

This is identifies of a region (usually small) for mail/package delivery.

Syntax

def get_recipient_postal_code() -> str: ...
def set_recipient_postal_code(value: str) -> None: ...

recipient_postal_code = property(get_recipient_postal_code, set_recipient_postal_code)

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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_province are not present.

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

recipient_province Property

Province or state code.

Syntax

def get_recipient_province() -> str: ...
def set_recipient_province(value: str) -> None: ...

recipient_province = property(get_recipient_province, set_recipient_province)

Default Value

""

Remarks

Province or state code. This is the identifying abbreviation for Canada province, US state, 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 is required when recipient_country_code is either CA or US.

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

Maximum Length: 44 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.

Maximum Length: 44 characters

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

"CA"

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.

sender_postal_code Property

This is identifies of a region (usually small) for mail/package delivery.

Syntax

def get_sender_postal_code() -> str: ...
def set_sender_postal_code(value: str) -> None: ...

sender_postal_code = property(get_sender_postal_code, set_sender_postal_code)

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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_province are not present.

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

sender_province Property

Province or state code.

Syntax

def get_sender_province() -> str: ...
def set_sender_province(value: str) -> None: ...

sender_province = property(get_sender_province, set_sender_province)

Default Value

""

Remarks

Province or state code. This is the identifying abbreviation for Canada province, US state, 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 is required when sender_country_code is either CA or US.

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_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 Canada Post are:

ship_date Property

The date on which the package will be tendered.

Syntax

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

ship_date = property(get_ship_date, set_ship_date)

Default Value

""

Remarks

This property contains the expected ship date for the package(s).

shipment_id Property

The unique identifier for this shipment.

Syntax

def get_shipment_id() -> str: ...

shipment_id = property(get_shipment_id, None)

Default Value

""

Remarks

A unique identifier for the shipment. This can be used in any future calls to transmit_shipments, using the ExcludedShipments config to indicate that this shipment is to be excluded from the manifest.

This property is read-only.

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 Canada Post in a 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:

Return Shipment

This indicates that a return shipment is requested. If you wish to have the return shipment go to a different address, you can set the return_address and return_contact properties.

Card for Pickup

When this is set, the package will be held at the post office and the recipient will be notified that their package is ready to be picked up. The recipient must show ID before they can pickup the package.

Do Not Safe Drop

Indicates that if no one is available to accept the package when delivery is attempted, a Delivery Notice Card is left and the recipient must pick up the package at the post office.

Return at Sender's Expense

This indicates that if unable to delivery the package, the package should be returned to the sender at the sender's expense.

Return to Sender

This indicates that if unable to delivery the package, the package should be returned to the sender.

Abandon

This indicates that if unable to delivery the package, the package should be abandoned.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

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

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

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

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

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

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

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

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are:

Additional Notes

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

cancel_shipment Method

Cancels a shipment.

Syntax

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

Remarks

This method cancels a shipment. The ShipmentId parameter is the value returned by the shipment_id property when get_package_label was called.

Note: This is only valid for shipments created using a contract (e.g. when canada_post_contract_id is specified) and must be called before transmit_shipments has been called for the specified shipment;

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

Gets the manifest info and file for the specified manifest.

Syntax

def get_manifest(manifest_idx: int) -> None: ...

Remarks

When called, this will populate the manifest details in manifest_details at the specified index, specified by ManifestIdx. It will also write the manifest file to the path specified in manifest_file.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
2. Call transmit_shipments with the group_id for the shipment.
3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

get_package_label Method

Generates a shipping label for the specified package.

Syntax

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

Remarks

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

• canada_post_account (required)
• commodities (required)
• group_id (required if canada_post_contract_id is set)
• packages (required)
• payment_method (required if canada_post_contract_id is set)
• reason_for_export (required)
• recipient_contact (required)
• recipient_address (required)
• sender_contact (required)
• sender_address (required)
• service_type (required)
• 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.

search_manifests Method

Search for manifests within a given date range.

Syntax

def search_manifests(start_date: str, end_date: str) -> None: ...

Remarks

This will retrieve any manifests printed between the StartDate and EndDate and populates the manifest_url. The date must be specified in the format "YYYYMMDD".

transmit_shipments Method

Submits the shipment information and retrieve the manifest for the specified GroupId.

Syntax

def transmit_shipments() -> None: ...

Remarks

This will transmit the shipment information for the specified group_id and print the manifest for that shipment.

If you wish to get the manifest for more than one group, you can specify more than one group ID in a comma separated list in the group_id property.

The following properties must be set before making a call to transmit_shipments:

• ExcludedShipments (Optional)
• group_id (Required)
• manifest_file (Required)
• sender_address (Required)

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
2. Call transmit_shipments with the group_id for the shipment.
3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class CanadaPostShipIntl:
@property
def on_notification() -> Callable[[CanadaPostShipIntlNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[CanadaPostShipIntlNotificationEventParams], 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 CanadaPostShipIntlSSLServerAuthenticationEventParams(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 CanadaPostShipIntl:
@property
def on_ssl_server_authentication() -> Callable[[CanadaPostShipIntlSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[CanadaPostShipIntlSSLServerAuthenticationEventParams], 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 CanadaPostShipIntlSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

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

CanadaPostShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

CanadaPostShipIntl Errors

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