USPSRates Class

Properties   Methods   Events   Config Settings   Errors  

Determines domestic and international postage rates based on weight, size, class of mail, and origin/destination information.

Syntax

class dshippingsdk.USPSRates

Remarks

This class provides automated online access to domestic and international rate information. These domestic rates are for: Express Mail, First-Class Mail, and Priority Mail, as well as single-piece rates for all four Package Services: Parcel Post, Bound Printed Matter, Library Mail, and Media Mail. The international rates are for International Priority Mail, International Express Mail (EMS), and International First Class Mail, along with service standards for each class of service.

To use this class to receive rate information for domestic shipments, simply set the package_weight, sender_zip_code, recipient_zip_code, and package_size. Then simply call get_rates.

You may also optionally supply dimensions of the package with package_length, package_width, and package_height, and filter the results returned by service_type and package_type.

In response to this request, the USPS server will return a list of postage services available for mailing your package. You can access these services through the service_list_net_charge, service_type, and service_type_description properties. The number of postal_zones between the sender_zip_code and recipient_zip_code will also be returned, along with any restrictions for mailing to APO/FPO addresses.

To use this class to receive rate information for international shipments, simply set the package_weight, package_type, and recipient_country_code, and then call get_rates.

For International rates, the following properties may be returned:

• service_type
• service_type_description
• service_commitments
• service_max_dimensions
• service_max_weight
• service_list_net_charge
• service_insurance_cost
• service_insurance_comment
• service_indemnity_coverage

Please note that in most cases international packages may need a Customs Declaration form, and packages may also be subject to mailing restrictions unique to the destination country. To assist you with this important information, the International Rates class will return all the necessary mailing restrictions, prohibitions, and observations, names of required customs_forms, as well as delivery areas_served.

Postage Provider Notes

When using USPS as the postage_provider (i.e. ppNone) you will need to...

• Set postage_provider to ppNone (default).
• Set usps_user_id to the UserId provided by USPS.
• Set usps_password to the password provided by USPS.
• Set usps_server to either the test or production server.

When using Endicia as the postage_provider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set postage_provider to ppEndicia.
• Set usps_account_number to your production account number (provided by Endicia).
• Set usps_password to your production password (provided by Endicia).

The components come with a built in sandbox account for your use. To use that account with the components...

• Set postage_provider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

ppStamps

When using Stamps.com as the postage_provider you will need to...

• Set postage_provider to ppStamps.
• Set usps_user_id to the sandbox or production user provided by Stamps.com.
• Set usps_account_number to the sandbox or production account number provided by Stamps.com.
• Set usps_password to the sandbox or production password provided by Stamps.com.
• Set usps_server to either the test or production server.

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.

areas_served Property

Areas where the PackagingType service is available when shipped to CountryCode .

Syntax

def get_areas_served() -> str: ...

areas_served = property(get_areas_served, None)

Default Value

""

Remarks

Some countries may only deliver mail to major metropolitan areas, while others will deliver mail everywhere.

The value of this property is filled after a call to the get_rates method.

This property is read-only.

customs_forms Property

Customs forms required to mail to CountryCode .

Syntax

def get_customs_forms() -> str: ...

customs_forms = property(get_customs_forms, None)

Default Value

""

Remarks

This property will contain the name and number of any customs forms needed to send mail to the indicated recipient_country_code.

The value of this property is filled after a call to the get_rates method.

This property is read-only.

days Property

Estimated time for delivery.

Syntax

def get_days() -> str: ...

days = property(get_days, None)

Default Value

""

Remarks

Estimate of the number of days to ship a package from sender_zip_code to recipient_zip_code. This property is filled after a call to the get_shipping_time.

This property is read-only.

express_mail_info Property

Express Mail information when shipping to CountryCode .

Syntax

def get_express_mail_info() -> str: ...

express_mail_info = property(get_express_mail_info, None)

Default Value

""

Remarks

The value of this property is filled after a call to the get_rates method.

This property is read-only.

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.

machinable Property

Indicates if the package being shipped is classified as machinable.

Syntax

def get_machinable() -> bool: ...
def set_machinable(value: bool) -> None: ...

machinable = property(get_machinable, set_machinable)

Default Value

TRUE

Remarks

The value of this property is optional to be provided when get_rates is called.

This property applies only to Parcel Post and First Class Mail. (Machinable criteria do not apply to Priority Mail, Express Mail, Bound Printed Matter, Library Mail, or Media Mail). The size, content, and weight of a Parcel Post package determine whether it is machinable or non-machinable. Characteristics of machinable mail are listed below:

A parcel is machinable when it:

• Not less than 6" long, 3" high, 0.25" thick, and 6 ounces in weight.
• Not more than 34" long, 17" high, 17" thick, or 35 lbs in weight. For books or other printed matter, the maximum weight is 25 lbs.

A letter-sized piece is not machinable if it has one or more of the following characteristics:

• Has an aspect ratio (length divided by height) of less than 1.3 or more than 2.5.
• Is polybagged, polywrapped, or enclosed in any plastic material.
• Has clasps, strings, buttons, or similar closure devices.
• Contains items such as pens, pencils, or loose keys or coins that cause the thickness of the mailpiece to be uneven.
• Is too rigid (does not bend easily when subjected to a transport belt tension of 40 lbs around an 11" diameter turn).
• For pieces more than 4.25" high or 6" long, the thickness is less than 0.009".
• Has a delivery address parallel to the shorter dimension of the mailpiece.
• Is a self-mailer with a folded edge perpendicular to the address.
• Booklet-type pieces with the bound edge (spine) along the shorter dimension of the piece or at the top.

A flat (large envelope) is always machinable so long as it meets the criteria for being a flat. (See the package_type property for more information).

This property can also be specified on service type "ALL", but it will only apply to the Parcel Post rate. Even if machinable is True, if the weight or dimension requirements exceed the limitations above, USPS will automatically return rates that include the non-machinable surcharge.

observations Property

Additional mailing information based on country of destination.

Syntax

def get_observations() -> str: ...

observations = property(get_observations, None)

Default Value

""

Remarks

Additional information that may be important to the sender. Returned by the USPS server The value of this property is filled after a call to the get_rates method.

This property is read-only.

package_count Property

The number of records in the Package arrays.

Syntax

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

package_count = property(get_package_count, set_package_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• package_girth
• package_height
• package_insured_value
• package_length
• package_signature_type
• package_size
• package_type
• package_weight
• package_width

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

package_girth Property

Measurement around the widest part of the package, perpendicular to the Length .

Syntax

def get_package_girth(package_idx: int) -> int: ...
def set_package_girth(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Measurement around the widest part of the package, perpendicular to the package_length.

This property is only applicable when requesting rates for USPS packages.

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

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.

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

postage_provider Property

The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.

Syntax

def get_postage_provider() -> int: ...
def set_postage_provider(value: int) -> None: ...

postage_provider = property(get_postage_provider, set_postage_provider)

Default Value

0

Remarks

When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.

• Set usps_user_id
• Set usps_password
• Set usps_server

When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.

For Production

• Set usps_account_number
• Set usps_password

For Testing

• Set EndiciaTestMode

When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.

• Set usps_user_id
• Set usps_account_number
• Set usps_password
• Set usps_server

postal_zone Property

Indicates the number of postal rate zones between the origin and destination zip codes.

Syntax

def get_postal_zone() -> str: ...

postal_zone = property(get_postal_zone, None)

Default Value

""

Remarks

The Postal Zone (which might be "Local" or "0 through 8") identifies the appropriate distance code assigned to each origination and destination Zip Code pairing for every Zip Code in the nation. These zones are used for Priority Mail packages over 5 lbs.

The value of this property is filled by the response from the USPS server.

This property is read-only.

prohibitions Property

List of items prohibited from mailing to the destination country.

Syntax

def get_prohibitions() -> str: ...

prohibitions = property(get_prohibitions, None)

Default Value

""

Remarks

Articles that are prohibited by the destination country are non-mailable. These prohibitions are based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific prohibitions as a country may return or seize mail containing articles prohibited within that country, whether or not notice of such prohibitions has been provided to or published by the Postal Service. The value of this property is set and returned in the get_rates method call.

This property is read-only.

proxy_auth_scheme Property

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

Syntax

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

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

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

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

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

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

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

proxy_auto_detect Property

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

Syntax

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

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

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

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

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

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

proxy_port Property

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

Syntax

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

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

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

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

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

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

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

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

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

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

recipient_address1 Property

Street name.

Syntax

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

recipient_address1 = property(get_recipient_address1, set_recipient_address1)

Default Value

""

Remarks

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

recipient_address2 Property

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

Syntax

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

recipient_address2 = property(get_recipient_address2, set_recipient_address2)

Default Value

""

Remarks

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

recipient_city Property

Name of city, town, etc.

Syntax

def get_recipient_city() -> str: ...
def set_recipient_city(value: str) -> None: ...

recipient_city = property(get_recipient_city, set_recipient_city)

Default Value

""

Remarks

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

recipient_country_code Property

Country code.

Syntax

def get_recipient_country_code() -> str: ...
def set_recipient_country_code(value: str) -> None: ...

recipient_country_code = property(get_recipient_country_code, set_recipient_country_code)

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

recipient_state Property

State or province code.

Syntax

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

recipient_state = property(get_recipient_state, set_recipient_state)

Default Value

""

Remarks

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

recipient_zip_code Property

Postal code.

Syntax

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

recipient_zip_code = property(get_recipient_zip_code, set_recipient_zip_code)

Default Value

""

Remarks

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

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

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

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

If you send a request with the requested_service set to svcPriority, after a call to get_rates, the price to send a Priority Mail package will be returned in service_list_net_charge. However, if you set the requested_service to stUnspecified, the rates for all service types will be returned.

The requested_service is used to filter the postage rates that are returned by service type. If you are only interested in Priority Mail rates, there is no need to receive Parcel Post or Library mail, for instance. Rates will be returned in the service_list_net_charge array property, with the service it corresponds located in the service_type and service_type_description properties.

This property is only valid for domestic shipments.

The stUnspecified value is not valid when postage_provider is set to ppEndicia.

The available service types for USPS include:

Valid values for USPS are:

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

Please note that some shipment_special_services flags such as Hold For Pickup, Premium Service (Sunday/Holiday), and Commercial will affect the rate.

Also, please note that all service_list_net_charges are also dependant on the sender_zip_code, sender_zip_code (or sender_country_code for international shipments), package_weight, package_size and package_type. Priority Mail packages larger than 1 cubic foot in size also require package_length, package_width, and package_height to accurately calculate the postage.

Note that when using any of the commercial service types, you must use the CommercialRate configuration setting to retrieve the commercial rate for the postage service at index i.

restrictions Property

Restrictions on items being shipped.

Syntax

def get_restrictions() -> str: ...

restrictions = property(get_restrictions, None)

Default Value

""

Remarks

For domestic shipments, this describes the restrictions for APO/FPI destination Zip Codes. This data is returned in the get_rates method call if the recipient_zip_code is an APO/FPO Zip Code.

For international shipments, this property will contain information indicating mail articles which are restricted by the destination country, Any packages sent are subject to the import requirements of that country. The contents of this property is based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific restrictions as a country may return or seize mail containing articles prohibited or restricted within that country, whether or not notice of such restriction has been provided to or published by the Postal Service.

The value of this property is filled after a call to the get_rates method.

NOTE: For rates requests using APO/FPO/DPO ZIP codes (origin or destination), any restrictions will be found in the Restrictions[i] Configuration setting, not in this property.

This property is read-only.

sender_zip_code Property

Postal code.

Syntax

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

sender_zip_code = property(get_sender_zip_code, set_sender_zip_code)

Default Value

""

Remarks

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

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

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

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_commitments
• service_indemnity_coverage
• service_insurance_comment
• service_insurance_cost
• service_list_net_charge
• service_max_dimensions
• service_max_weight
• service_packaging_type
• service_type
• service_type_description

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

This property is read-only.

service_commitments Property

Service commitments for the PackagingType when shipping to CountryCode .

Syntax

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

Default Value

""

Remarks

Service commitments for the service_packaging_type when shipping to recipient_country_code.

This is valid only for USPS, and indicates how long it will take for the package to be delivered when shipped via service_packaging_type.

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

Indicates the indemnity coverage available for this service.

Syntax

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

Default Value

""

Remarks

Indicates the indemnity coverage available for this service. This property is valid only for USPS, and is only returned when total_value was sent in the request. It contains the lesser of maximum parcel indemnity coverage per given weight and total_value, if applicable. Otherwise it will be blank.

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

Explains why no InsuranceCost was returned in the response.

Syntax

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

Default Value

""

Remarks

Explains why no insurance_cost was returned in the response.

This property is only applicable to USPS.

If the total_value was sent in the request (indicating you wish to receive the service_insurance_cost in the response), but no service_insurance_cost was returned, then service_insurance_comment will contain text explaining why no value was returned for service_insurance_cost. It may be one of three reasons:

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

Insurance fee.

Syntax

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

Default Value

""

Remarks

Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package.

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

Net charge amount applied to a ServiceType .

Syntax

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

Default Value

""

Remarks

Net charge amount applied to a service_type.

After calling the get_rates method, the service_list_net_charge will be filled with the value of list net charge amount.

For FedEx, this is returned in the server response only if the rate_type is set to 0 (rtList) in the request.

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

Maximum dimensions of a package allowed when sending to the CountryCode .

Syntax

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

Default Value

""

Remarks

Maximum dimensions of a package allowed when sending to the recipient_country_code. This is only applicable to USPS. After a call to get_rates, this property will contain the maximum allowable dimensions of a package sent to the recipient_country_code via the indicated service_type.

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

Maximum weight of package allowed when sending to the CountryCode .

Syntax

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

Default Value

""

Remarks

Maximum weight of package allowed when sending to the recipient_country_code.

This is only applicable to USPS.

After a call to get_rates, this property will contain the maximum allowable weight (in pounds) of a package sent to the recipient_country_code via the indicated service_type.

Note: This property may contain a fractional quantity (eg: "0.2188", which indicates a max weight of 3.5 ounces).

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

The mail service type when shipping to CountryCode .

Syntax

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

Default Value

""

Remarks

The mail service type when shipping to recipient_country_code.

This is only valid for USPS international rate requests.

service_packaging_type indicates what type of shipping service is being used for each InternationalService. service_packaging_type may contain the following information:

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 stUSPSBPM (74) is no longer supported by 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.

shipment_special_services Property

Contains the collection of special services offered by USPS on shipment level.

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 USPS, you must set the shipment_special_services to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

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

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

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

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

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

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

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

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

total_value Property

Total value of the items inside the package.

Syntax

def get_total_value() -> str: ...
def set_total_value(value: str) -> None: ...

total_value = property(get_total_value, set_total_value)

Default Value

""

Remarks

This property is used by USPS to compute the insurance_cost and indemnity_coverage. (if they are available for the current requested_service and recipient_country_code).

usps_account_number Property

The shipper's Endicia account number.

Syntax

def get_usps_account_number() -> str: ...
def set_usps_account_number(value: str) -> None: ...

usps_account_number = property(get_usps_account_number, set_usps_account_number)

Default Value

""

Remarks

The shipper's Endicia account number.

This property is only used when shipping with Endicia and will take a production account number. During testing please set EndiciaTestMode which will automatically use a sandbox account. During testing this property does not need to be set.

usps_password Property

Password to use for logging in to the USPS Server .

Syntax

def get_usps_password() -> str: ...
def set_usps_password(value: str) -> None: ...

usps_password = property(get_usps_password, set_usps_password)

Default Value

""

Remarks

Password to use for logging in to the USPS server.

This password is provided to you by USPS when you register for service. The password is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Note, the Password property has been depreciated by USPS, and remains only for backwards compatibility.

When postage_provider has been set to ppEndicia, this must be the pass phrase associated with your postage account that was supplied to you by Endicia upon registration.

usps_server Property

URL for the USPS server where the requests are sent.

Syntax

def get_usps_server() -> str: ...
def set_usps_server(value: str) -> None: ...

usps_server = property(get_usps_server, set_usps_server)

Default Value

"https://secure.shippingapis.com/ShippingAPI.dll"

Remarks

URL for the USPS server where the requests are sent.

When postage_provider has been set to ppEndicia, the live production URL will be set automatically. For testing please set EndiciaTestMode.

When postage_provider has been set to ppStamps, the live production URL will be set automatically. For testing please set StampsTestMode.

There are two different live and test URLs that have been provided by the US Postal service for use with the Webtools APIs (and these classs). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the classs that use them.

Live Servers:

Test Servers:

These test servers return CANNED RESPONSES. They will only accept a specific set of data, and will only return one pre-formed response. Any transaction that does not contain the exact data they expect will cause an error to be generated. Because of these limitations we strongly recommend you test using a live account.

Note that the label components must use the live server for testing, but with the Certify configuration setting set to True. There is no need to set Certify with Endicia or Stamps.com. Set EndiciaTestMode or StampsTestMode instead.

usps_user_id Property

User Id for logging in to the USPS WebTools or Stamps.

Syntax

def get_usps_user_id() -> str: ...
def set_usps_user_id(value: str) -> None: ...

usps_user_id = property(get_usps_user_id, set_usps_user_id)

Default Value

""

Remarks

User Id for logging in to the USPS WebTools or Stamps.com server.

This User Id is provided to you by USPS or Stamps.com when you register for service. The user_id is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. During testing set StampsTestMode to use the built-in sandbox account. This field is not used by Endicia.

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

Calculates postage rates to ship a package via the RequestedService .

Syntax

def get_rates() -> None: ...

Remarks

For domestic rate requests, this method allows you to calculate how much domestic shipping will cost to mail a package with a certain size and weight, from sender_zip_code to recipient_zip_code by Express Mail, Priority Mail, First-Class Mail, Parcel Post, Media Mail, Library Mail, or as Bound Printed Matter.

Domestic rate requests use values for the following properties:

• requested_service (required)
• sender_zip_code (required)
• recipient_zip_code (required)
• package_weight (required)
• package_size (required)
• package_length (required for large packages)
• package_width (required for large packages)
• package_height (required for large packages)
• package_girth (required for irregular packages)
• package_type (optional)
• machinable (optional)

• restrictions
• postal_zone
• service_list_net_charge
• service_type
• service_type_description

• service_list_net_charge
• service_commitments
• service_type
• service_type_description
• service_packaging_type
• service_max_dimensions
• service_max_weight

• restrictions
• prohibitions
• observations
• customs_forms
• areas_served
• express_mail_info

• package_type
• sender_country_code
• package_weight

get_shipping_time Method

Returns the estimated time to ship a package from ZipCode to ZipCode .

Syntax

def get_shipping_time() -> None: ...

Remarks

This method call contacts the USPS usps_server and determines the average estimated time to ship a package from sender_zip_code to recipient_zip_code. This method call fills the following properties: sender_zip_code, recipient_zip_code and days.

Origination and destination ZIP Codes must be valid. Only the first 3 digits of each ZIP code is required. If a 4- or 5-digit ZIP Code is entered, the last 1 or 2 digits will be ignored.

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 USPSRatesErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

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

# In class USPSRates:
@property
def on_notification() -> Callable[[USPSRatesNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[USPSRatesNotificationEventParams], 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 USPSRatesSSLServerAuthenticationEventParams(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 USPSRates:
@property
def on_ssl_server_authentication() -> Callable[[USPSRatesSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[USPSRatesSSLServerAuthenticationEventParams], 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 USPSRatesSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

USPSRates Config Settings

USPSRates 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

USPSRates Errors

USPSRates 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