CanadaPostRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides access to pre-ship rate information for a single package per your established Canada Post account rates.

Syntax

class dshippingsdk.CanadaPostRates

Remarks

When providing origin, destination information, weight, and service, this class allows a user to obtain a rate quote for a specific service.

You can send a rate request to Canada Post by calling the get_rates method for a specific Canada Post service for a single package.

If you specify a canada_post_contract_id then your account rates will be provided, otherwise the standard list rates will be returned.

When requesting a rate quote, you should give as much detail as possible to get the most accurate quote. This should include the package_length, package_width, package_height, and package_weight as well as any shipment_special_services you wish to use.

Once you have made a successful call to get_rates, you can retrieve all rates returned in services.

Please note that all rate quotes are estimates and may differ from the actual invoiced amount.

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

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.

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_height
• package_insured_value
• package_length
• package_signature_type
• package_type
• package_weight
• package_width

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

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

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 user name, 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 user name, 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.

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.

requested_service Property

Service type for which the shipping rate is requested.

Syntax

def get_requested_service() -> int: ...
def set_requested_service(value: int) -> None: ...

requested_service = property(get_requested_service, set_requested_service)

Default Value

0

Remarks

This property is required to be entered in the request only if the rate request is made for a specific service type. In this case, the requested_service should be set to a value different from 'stUnspecified'.

Otherwise, the rate request will be considered by the server as it has been made for all available services and respective rates.

Valid values for Canada Post are:

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.

service_count Property

The number of records in the Service arrays.

Syntax

def get_service_count() -> int: ...

service_count = property(get_service_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• service_account_base_charge
• service_account_net_charge
• service_account_total_discount
• service_account_total_surcharge
• service_aggregate
• service_delivery_date
• service_transit_time
• service_type
• service_type_description

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

This property is read-only.

service_account_base_charge Property

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

def get_service_account_base_charge(service_idx: int) -> str: ...

Default Value

""

Remarks

Transportation charges before surcharges and discounts applied to a service_type. This applies to FedEx only and is specific to the fed_ex_account_number. After calling the get_rates method, the service_account_base_charge will be filled with the value of discounted base charge amount specific to the fed_ex_account_number (i.e. depending on the current rate schedule the fed_ex_account_number is receiving from FedEx).

For Canada Post, this field will contain the base cost of the shipment before taxes (numeric 99999.99).

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_account_net_charge Property

Net charge amount applied to a ServiceType .

Syntax

def get_service_account_net_charge(service_idx: int) -> str: ...

Default Value

""

Remarks

Net charge amount applied to a service_type.

For FedEx, this is specific to the fed_ex_account_number. After calling the get_rates method, the service_account_net_charge will be filled with the value of discounted net charge amount specific to the fed_ex_account_number (i.e. depending on the current rate schedule the fed_ex_account_number is receiving from FedEx).

For UPS, this is the value of grand total charges for account based rating applied to a shipment when using the returned service_type

The UPS server response will contain negotiated rate(s) only for the qualified ups_account_numbers. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

This property is not used by the USPS class.

For Canada Post, this field will contain the total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_account_total_discount Property

Total discount amount applied to the shipment for a ServiceType .

Syntax

def get_service_account_total_discount(service_idx: int) -> str: ...

Default Value

""

Remarks

Total discount amount applied to the shipment for a service_type. This is for FedEx only and is specific to the fed_ex_account_number. After calling the get_rates method, the service_account_total_discount will be filled with the value of total discount applied, which is specific to the fed_ex_account_number (i.e. depending on the current rate schedule the fed_ex_account_number is receiving from FedEx).

For Canada Post, this field will contain the total amount of discounts.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_account_total_surcharge Property

Total surcharge amount for all additional services applied to a ServiceType .

Syntax

def get_service_account_total_surcharge(service_idx: int) -> str: ...

Default Value

""

Remarks

Total surcharge amount for all additional services applied to a service_type. This is only for FedEx, and is specific to the fed_ex_account_number. After calling the get_rates method, the service_account_total_surcharge will be filled with the value of total surcharges applied, which is specific to the fed_ex_account_number (i.e. depending on the current rate schedule the fed_ex_account_number is receiving from FedEx).

For Canada Post, this field will contain the total amount of surcharges.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_aggregate Property

Aggregate of details and rates for the ServiceType in the list of available services.

Syntax

def get_service_aggregate(service_idx: int) -> str: ...

Default Value

""

Remarks

Aggregate of details and rates for the service_type in the list of available services.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_delivery_date Property

This indicates the shipment delivery date for the ServiceType .

Syntax

def get_service_delivery_date(service_idx: int) -> str: ...

Default Value

""

Remarks

This indicates the shipment delivery date for the service_type.

In regards to International services, the delivery date availability is limited to some postal-code supported countries. The delivery date will be returned if available. Format: YYYY-MM-DD.

For UPS, this property is filled after a call to the get_shipping_time.

This is not applicable to USPS.

For Canada Post, this field will be populated after a get_rates call and will contain the estimated date of delivery, starting from the expected mailing-date.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_type Property

Indicates the service type in the list of available services returned.

Syntax

def get_service_type(service_idx: int) -> int: ...

Default Value

0

Remarks

Indicates the service type in the list of available services returned.

This is populated when the get_shipping_time or get_rates methods are called.

Valid values for FedEx are:

Valid values for UPS are:

Valid values for USPS are:

Please note that the requested_service stUSPSBoundPrintedMatter (74) is no longer supported by USPS or Endicia.

Valid values for Canada Post are:

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_type_description Property

Indicates the textual description of a service type in the list of available services returned.

Syntax

def get_service_type_description(service_idx: int) -> str: ...

Default Value

""

Remarks

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

service_transit_time Property

Expected number of days in transit from pickup to delivery for the ServiceType .

Syntax

def get_service_transit_time(service_idx: int) -> str: ...

Default Value

""

Remarks

Expected number of days in transit from pickup to delivery for the service_type. This is an estimate only and depends on the customs clearance times. It is optional to be returned in the server reply.

The service_idx parameter specifies the index of the item in the array. The size of the array is controlled by the service_count property.

This property is read-only.

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

COD

When set, this will request that the amount specified in cod_total_amount to be collected on delivery of the package, either in the form of cash, guaranteed funds, or by check, as specified in cod_type.

This only applies for domestic shipments.

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 are designations of 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. PKCS12 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 displayed below.

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

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

Returns rate information for a specified or all available services.

Syntax

def get_rates() -> None: ...

Remarks

To get the courtesy rate quotes for Canada Post's services, call the get_rates method. If rates are needed for a specific service type, set the requested_service property to the value you need the rates for (other than 0 : stUnspecified). The requested_service property identifies the specific service for which you want to retrieve rate information.

If the rates are wanted for all available services, set requested_service to 0 (stUnspecified). The server response will include a list of services, their associated rate, and guaranteed delivery time (if available).

The following properties are applicable:

• canada_post_account (required)
• requested_service (required)
• sender_address (required)
• recipient_address (required)
• packages (required)

If the recipient_country_code is CA or US, the recipient_postal_code is required.

The Service* properties are populated when this method returns.

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class CanadaPostRates:
@property
def on_notification() -> Callable[[CanadaPostRatesNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[CanadaPostRatesNotificationEventParams], 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 CanadaPostRatesSSLServerAuthenticationEventParams(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 CanadaPostRates:
@property
def on_ssl_server_authentication() -> Callable[[CanadaPostRatesSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[CanadaPostRatesSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

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

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

CanadaPostRates Config Settings

CanadaPostRates Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

CanadaPostRates Errors

CanadaPostRates Errors

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

SOAP Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors

XML Errors