UPSShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a UPS shipping label for any of UPS international services complete with addresses and barcode, cancel shipments.

Syntax

class dshippingsdk.UPSShipIntl

Remarks

Generating a shipping label can be done by calling the get_shipment_labels method. You will have to specify the package information, UPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery), and any other specific information on international shipments (such as Commercial Invoice, international forms required by Customs, etc.). It also supports many valued added services for shipments, including collect on delivery (COD), declared value, delivery confirmation, and automatic notification of delivery status.

This class also allows you to delete packages included in the daily shipping log that have not already been tendered to UPS. This can be done by calling cancel_shipment or cancel_package, where the MasterTrackingNumber parameter identifies the shipment.

To use this class, you must have a UPS ups_account_number. You should also have already obtained a "Client ID" and "Client Secret" uniquely assigned to your account by UPS after registration for UPS OnLine Tools.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

account_address1 Property

Street name.

Syntax

def get_account_address1() -> str: ...
def set_account_address1(value: str) -> None: ...

account_address1 = property(get_account_address1, set_account_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 account_address1 should not exceed 35 characters.

account_address2 Property

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

Syntax

def get_account_address2() -> str: ...
def set_account_address2(value: str) -> None: ...

account_address2 = property(get_account_address2, set_account_address2)

Default Value

""

Remarks

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

account_city Property

Name of city, town, etc.

Syntax

def get_account_city() -> str: ...
def set_account_city(value: str) -> None: ...

account_city = property(get_account_city, set_account_city)

Default Value

""

Remarks

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

account_country_code Property

Country code.

Syntax

def get_account_country_code() -> str: ...
def set_account_country_code(value: str) -> None: ...

account_country_code = property(get_account_country_code, set_account_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

account_state Property

State or province code.

Syntax

def get_account_state() -> str: ...
def set_account_state(value: str) -> None: ...

account_state = property(get_account_state, set_account_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.

account_zip_code Property

Postal code.

Syntax

def get_account_zip_code() -> str: ...
def set_account_zip_code(value: str) -> None: ...

account_zip_code = property(get_account_zip_code, set_account_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 account_city and account_state are not present.

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

account_company Property

Identifies the contact person's company name.

Syntax

def get_account_company() -> str: ...
def set_account_company(value: str) -> None: ...

account_company = property(get_account_company, set_account_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either account_first_name and account_last_name or account_company are required to be provided.

account_email Property

Identifies the contact person's email address.

Syntax

def get_account_email() -> str: ...
def set_account_email(value: str) -> None: ...

account_email = property(get_account_email, set_account_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

account_fax Property

Recipient's fax number.

Syntax

def get_account_fax() -> str: ...
def set_account_fax(value: str) -> None: ...

account_fax = property(get_account_fax, set_account_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

account_first_name Property

Sender's first name.

Syntax

def get_account_first_name() -> str: ...
def set_account_first_name(value: str) -> None: ...

account_first_name = property(get_account_first_name, set_account_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either account_first_name and account_last_name or account_company must be sent.

account_last_name Property

Person's last name.

Syntax

def get_account_last_name() -> str: ...
def set_account_last_name(value: str) -> None: ...

account_last_name = property(get_account_last_name, set_account_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either account_first_name and account_last_name or account_company must be sent. Maximum length: 45 characters for both names or company name.

account_middle_initial Property

Middle initial.

Syntax

def get_account_middle_initial() -> str: ...
def set_account_middle_initial(value: str) -> None: ...

account_middle_initial = property(get_account_middle_initial, set_account_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

account_phone Property

Identifies the contact person's phone number.

Syntax

def get_account_phone() -> str: ...
def set_account_phone(value: str) -> None: ...

account_phone = property(get_account_phone, set_account_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

cod_report Property

Image of a COD Turn In Page.

Syntax

def get_cod_report() -> bytes: ...

cod_report = property(get_cod_report, None)

Default Value

""

Remarks

This applies only to shipments within the European Union (EU) countries. It is the decoded binary image file of the COD report, stored in memory upon successful ship response. The report is generated in HTML format and it will automatically be saved to disk in the file designated by cod_report_file (if this is set to a valid path and filename).

This property is read-only.

cod_report_file Property

Filename and location to save the CODReport to.

Syntax

def get_cod_report_file() -> str: ...
def set_cod_report_file(value: str) -> None: ...

cod_report_file = property(get_cod_report_file, set_cod_report_file)

Default Value

""

Remarks

This applies only to shipments within the European Union (EU) countries. When applicable and the cod_report_file is set to a valid path and filename, the contents of the cod_report are written to disk upon successful response.

This has to have .html extension.

cod_total_amount Property

The total amount to be collected on shipment level.

Syntax

def get_cod_total_amount() -> str: ...
def set_cod_total_amount(value: str) -> None: ...

cod_total_amount = property(get_cod_total_amount, set_cod_total_amount)

Default Value

""

Remarks

This indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).

For MPS COD shipments (when packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the package_cod_amount.

Format: Two explicit decimals (e.g.5.00).

cod_type Property

The code that indicates the type of funds that will be used for the COD payment.

Syntax

def get_cod_type() -> int: ...
def set_cod_type(value: int) -> None: ...

cod_type = property(get_cod_type, set_cod_type)

Default Value

0

Remarks

This property identifies the type of funds UPS should collect upon shipment delivery. It is required to be provided in the request only if COD is requested (i.e., cod_total_amount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

commercial_invoice_comments Property

Commercial Invoice comments to be uploaded to customs.

Syntax

def get_commercial_invoice_comments() -> str: ...
def set_commercial_invoice_comments(value: str) -> None: ...

commercial_invoice_comments = property(get_commercial_invoice_comments, set_commercial_invoice_comments)

Default Value

""

Remarks

Commercial Invoice comments to be uploaded to customs. This can be any extra information about the current shipment and is optional.

commercial_invoice_date Property

Date when the Invoice is created.

Syntax

def get_commercial_invoice_date() -> str: ...
def set_commercial_invoice_date(value: str) -> None: ...

commercial_invoice_date = property(get_commercial_invoice_date, set_commercial_invoice_date)

Default Value

""

Remarks

Date when the Invoice is created. This is optional for Partial Invoice, but required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice.

If not set, it will default to the ship date. Format is YYYYMMDD.

NOTE: This field is only valid for UPS.

commercial_invoice_freight_charge Property

Cost to transport the shipment.

Syntax

def get_commercial_invoice_freight_charge() -> str: ...
def set_commercial_invoice_freight_charge(value: str) -> None: ...

commercial_invoice_freight_charge = property(get_commercial_invoice_freight_charge, set_commercial_invoice_freight_charge)

Default Value

"0.00"

Remarks

Cost to transport the shipment. This is required if commercial_invoice_terms is set to Cfr, Cpt, Cif, or Cip. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

commercial_invoice_insurance Property

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged.

Syntax

def get_commercial_invoice_insurance() -> str: ...
def set_commercial_invoice_insurance(value: str) -> None: ...

commercial_invoice_insurance = property(get_commercial_invoice_insurance, set_commercial_invoice_insurance)

Default Value

"0.00"

Remarks

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. This is required if commercial_invoice_terms is set to Cif or Cip.. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

commercial_invoice_number Property

Customer's assigned invoice number.

Syntax

def get_commercial_invoice_number() -> str: ...
def set_commercial_invoice_number(value: str) -> None: ...

commercial_invoice_number = property(get_commercial_invoice_number, set_commercial_invoice_number)

Default Value

""

Remarks

Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice.

commercial_invoice_purpose Property

Reason to export the current international shipment Required for dutiable international express or ground shipment.

Syntax

def get_commercial_invoice_purpose() -> int: ...
def set_commercial_invoice_purpose(value: int) -> None: ...

commercial_invoice_purpose = property(get_commercial_invoice_purpose, set_commercial_invoice_purpose)

Default Value

0

Remarks

Reason to export the current international shipment

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:

commercial_invoice_terms Property

Indicates the rights to the seller from the buyer.

Syntax

def get_commercial_invoice_terms() -> int: ...
def set_commercial_invoice_terms(value: int) -> None: ...

commercial_invoice_terms = property(get_commercial_invoice_terms, set_commercial_invoice_terms)

Default Value

0

Remarks

Indicates the rights to the seller from the buyer.

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:

commodity_count Property

The number of records in the Commodity arrays.

Syntax

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

commodity_count = property(get_commodity_count, set_commodity_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• commodity_description
• commodity_export_type
• commodity_harmonized_code
• commodity_manufacturer
• commodity_number_of_pieces
• commodity_quantity
• commodity_quantity_unit
• commodity_schedule_b_code
• commodity_unit_price
• commodity_value
• commodity_weight

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

commodity_description Property

Complete and accurate description of this commodity line item.

Syntax

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

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

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

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

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

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

commodity_export_type Property

Indicates the export type.

Syntax

def get_commodity_export_type(commodity_idx: int) -> int: ...
def set_commodity_export_type(commodity_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Indicates the export type. Applicable and required for SED only.

Valid values are:

NOTE: This field is only applicable to UPS shipments.

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

commodity_harmonized_code Property

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

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

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

commodity_manufacturer Property

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

Syntax

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

Default Value

"US"

Remarks

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

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

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

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

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

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

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

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

commodity_number_of_pieces Property

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

Syntax

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

Default Value

1

Remarks

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

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

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

This property is not applicable to USPS.

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

commodity_quantity Property

Number of units contained in this commodity line item measured in units specified by the QuantityUnit .

Syntax

def get_commodity_quantity(commodity_idx: int) -> int: ...
def set_commodity_quantity(commodity_idx: int, value: int) -> None: ...

Default Value

1

Remarks

Number of units contained in this commodity line item measured in units specified by the commodity_quantity_unit. This is used in conjunction with the commodity_quantity_unit and commodity_unit_price.

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

For UPS, these are all required for Invoice form type and optional for Partial Invoice (not applicable to other international form types).

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

commodity_quantity_unit Property

Unit of measure used to express the Quantity of this commodity line item.

Syntax

def get_commodity_quantity_unit(commodity_idx: int) -> str: ...
def set_commodity_quantity_unit(commodity_idx: int, value: str) -> None: ...

Default Value

"EA"

Remarks

Unit of measure used to express the commodity_quantity of this commodity line item.

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

Here is a list of possible values for FedEx:

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

Here is a list of possible values for commodity_quantity_unit:

This is not available for USPS.

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

commodity_schedule_b_code Property

A unique 10-digit commodity classification code for the item being exported.

Syntax

def get_commodity_schedule_b_code(commodity_idx: int) -> str: ...
def set_commodity_schedule_b_code(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

A unique 10-digit commodity classification code for the item being exported.

Before you can export a product from the United States, you must first determine its correct 10-digit Schedule B Classification Code. These codes are valid for only U.S. exports and are maintained by the U.S. Census Bureau. This is required to be provided in an international ship request only if SED is requested (i.e., one of the form_types is set to ftSED).

This property is only applicable to UPS shipments.

Current format: 10 digits.

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

commodity_unit_price Property

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

Syntax

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

Default Value

"1.00"

Remarks

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

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

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

For USPS, use the commodity_value property instead.

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

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

commodity_value Property

The value of an individual item being shipped.

Syntax

def get_commodity_value(commodity_idx: int) -> str: ...
def set_commodity_value(commodity_idx: int, value: str) -> None: ...

Default Value

""

Remarks

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

This property is only applicable to USPS and UPS freight.

Note: For USPS, the maximum value for this property is "99999.99".

Note: For UPS freight, the maximum value for this property is "99999999999999.99".

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

commodity_weight Property

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

Syntax

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

Default Value

"0.00"

Remarks

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

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

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

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

However, in USPS, if postage_provider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

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

duties_payor_account_number Property

The account number of the party responsible for payment (shipping charges, or duties and taxes).

Syntax

def get_duties_payor_account_number() -> str: ...
def set_duties_payor_account_number(value: str) -> None: ...

duties_payor_account_number = property(get_duties_payor_account_number, set_duties_payor_account_number)

Default Value

""

Remarks

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if duties_payor_payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to duties_payor_account_number.

duties_payor_country_code Property

The country code for the payor of the shipment, or duties and taxes.

Syntax

def get_duties_payor_country_code() -> str: ...
def set_duties_payor_country_code(value: str) -> None: ...

duties_payor_country_code = property(get_duties_payor_country_code, set_duties_payor_country_code)

Default Value

"US"

Remarks

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the duties_payor_country_code is required to be provided in the ship request only if duties_payor_payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the duties_payor_country_code is required only if duties_payor_payor_type is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

duties_payor_type Property

Method of payment for shipment, or duties and taxes.

Syntax

def get_duties_payor_type() -> int: ...
def set_duties_payor_type(value: int) -> None: ...

duties_payor_type = property(get_duties_payor_type, set_duties_payor_type)

Default Value

0

Remarks

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this property is set to a value other than 0 (ptSender), the duties_payor_account_number and duties_payor_country_code are required to be provided in the request as well. Otherwise, those will default to fed_ex_account_number and sender_country_code.

For UPS, when set to ptSender, the duties_payor_account_number is automatically set to ups_account_number. When ptRecipient is specified, duties_payor_account_number and duties_payor_zip_code are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the duties_payor_account_number, duties_payor_zip_code and duties_payor_country_code are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

duties_payor_zip_code Property

Payor's postal code (if applicable).

Syntax

def get_duties_payor_zip_code() -> str: ...
def set_duties_payor_zip_code(value: str) -> None: ...

duties_payor_zip_code = property(get_duties_payor_zip_code, set_duties_payor_zip_code)

Default Value

""

Remarks

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS duties_payor_account_number's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the duties_payor_payor_type is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

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.

form_types Property

Contains the collection of types for international forms that can associate an international shipment.

Syntax

def get_form_types() -> int: ...
def set_form_types(value: int) -> None: ...

form_types = property(get_form_types, set_form_types)

Default Value

0

Remarks

The form_types property is optional. Up to 6 international forms (such as Invoice, Shipper's Export Declaration, Certificate of Origin, NAFTA Certificate of Origin, etc.) can be requested within a ship request. To request any of the forms offered by UPS, you must set the form_types to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

For instance, to request both a Commercial Invoice and a CN22 you could set the property like below:

upsshipintl1.FormTypes = 0x00000011

Note: Invoice and Partial Invoice are mutually exclusive.

international_forms Property

Image of the international forms.

Syntax

def get_international_forms() -> bytes: ...

international_forms = property(get_international_forms, None)

Default Value

""

Remarks

This is the decoded binary image file of the international forms accompanying the shipment already requested via the form_types property (such as Invoice, SED, Certificate of Origin, etc.), stored in memory upon successful international ship response. If the international_forms_file is set to a valid path and filename, the international forms are also saved to disk in PDF format.

This property is read-only.

international_forms_file Property

Filename and location to save the InternationalForms to.

Syntax

def get_international_forms_file() -> str: ...
def set_international_forms_file(value: str) -> None: ...

international_forms_file = property(get_international_forms_file, set_international_forms_file)

Default Value

""

Remarks

When the international_forms_file is set to a valid path and filename, the contents of the international_forms are written to disk upon successful response.

The international_forms_file has to have .pdf extension.

label_image_type Property

Type of image or printer commands the shipping label is to be formatted in.

Syntax

def get_label_image_type() -> int: ...
def set_label_image_type(value: int) -> None: ...

label_image_type = property(get_label_image_type, set_label_image_type)

Default Value

0

Remarks

This element defines the print method code that the labels are to be generated to. It is applicable and required to be provided in a ship request for forward shipments or return shipments. The value selection depends on the printer type used to print the shipping label.

Valid image types and their meanings with the corresponding usage are listed below:

There are two types of shipping labels supported: plain paper (when printing to an HP compatible laser or inkjet type printer only. In this case, the only possible value for the label_image_type is 0 (uitGIF)), and thermal (when printing to thermal printers only. In this case, possible values for the label_image_type are 1, 2, 3, and 4).

While the content of each of these labels is the same, their usages are different. Each provides a bar-coded image for the purpose of scanning the package during handling. The uses of each label depend on the type of working environment to be used.

master_tracking_number Property

Tracking number assigned to the whole MPS shipment.

Syntax

def get_master_tracking_number() -> str: ...

master_tracking_number = property(get_master_tracking_number, None)

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when the get_shipment_labels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the cancel_shipment method is called). It can also be used when tracking a MPS.

This property is read-only.

nafta_blanket_period Property

Contains specific details on NAFTA CO (when this form is requested).

Syntax

def get_nafta_blanket_period() -> str: ...
def set_nafta_blanket_period(value: str) -> None: ...

nafta_blanket_period = property(get_nafta_blanket_period, set_nafta_blanket_period)

Default Value

""

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if NAFTA CO international form is requested (i.e., one of the form_types is set to NAFTA).

This contains the begin date and the end date of the blanket period. The begin date is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). The end date is the date upon which the blanket period expires.

This is applicable and required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the shipment_description that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.

Format is: YYYYMMDD-YYYYMMDD

nafta_preference_criteria Property

Preference Criteria for NAFTA Certificate of Origin documents.

Syntax

def get_nafta_preference_criteria() -> str: ...
def set_nafta_preference_criteria(value: str) -> None: ...

nafta_preference_criteria = property(get_nafta_preference_criteria, set_nafta_preference_criteria)

Default Value

""

Remarks

This property is required when the form_types property includes the NAFTA flag. Valid values and their descriptions are listed from the UPS documentation:

nafta_producer_info Property

Producer information for NAFTA Certificate of Origin documents.

Syntax

def get_nafta_producer_info() -> int: ...
def set_nafta_producer_info(value: int) -> None: ...

nafta_producer_info = property(get_nafta_producer_info, set_nafta_producer_info)

Default Value

0

Remarks

This property is required when the form_types property includes the NAFTA flag.

From UPS documentation, specify: piYes - If shipper is the producer of the good. If not, state No depending on whether this certificate was based upon: piNo1 - Knowledge of whether the good qualifies as an originating good. piNo2 - Reliance on the producer's written representation (other than a Certificate of Origin) that the good qualifies as an originating good. piNo3 - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer.

notify_count Property

The number of records in the Notify arrays.

Syntax

def get_notify_count() -> int: ...
def set_notify_count(value: int) -> None: ...

notify_count = property(get_notify_count, set_notify_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• notify_aggregate
• notify_email
• notify_flags
• notify_message

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

notify_aggregate Property

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

def get_notify_aggregate(notify_idx: int) -> str: ...
def set_notify_aggregate(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the shipment_special_services.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

• a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
• the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
• the recipient's email address (via the EMailAddress element). This is required.
• whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
• the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
• the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

This setting is optional. If notify_aggregate is not set it will be automatically created by the class.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

• a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
• the recipient's email address (via the EMailAddress element). This is required.
• the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
• the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
• an optional from name.
• a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this property does not apply for USPS and CanadaPost.

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

notify_email Property

Email address of the recipient to be notified.

Syntax

def get_notify_email(notify_idx: int) -> str: ...
def set_notify_email(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

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

notify_message Property

User defined text that will be included in the email to be sent to Email .

Syntax

def get_notify_message(notify_idx: int) -> str: ...
def set_notify_message(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

User defined text that will be included in the email to be sent to notify_email. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This property is not used by USPS or Canada Post.

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

notify_flags Property

Identifies the type of notification requested.

Syntax

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

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

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

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

For UPS notifications, the following flags apply:

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

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

This field is not used by USPS.

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

package_count Property

The number of records in the Package arrays.

Syntax

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

package_count = property(get_package_count, set_package_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• package_base_charge
• package_cod_amount
• package_cod_type
• package_description
• package_height
• package_id
• package_insured_value
• package_length
• package_reference
• package_return_receipt
• package_return_receipt_file
• package_shipping_label
• package_shipping_label_file
• package_signature_type
• package_special_services
• package_total_surcharges
• package_tracking_number
• package_type
• package_weight
• package_width

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

package_base_charge Property

Actual Base Charge applicable to this package.

Syntax

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

Default Value

""

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the payor_account_number. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_cod_amount Property

The COD monetary value for the package.

Syntax

def get_package_cod_amount(package_idx: int) -> str: ...
def set_package_cod_amount(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the shipment_special_services is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in package_cod_label).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the package_cod_amount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the package_cod_type. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for package_type Letter/Envelope. COD special service is available for shipper's with pickup_type 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by package_signature_type) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_cod_type Property

The code that indicates the type of funds that will be used for the COD payment for this package.

Syntax

def get_package_cod_type(package_idx: int) -> int: ...
def set_package_cod_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The code that indicates the type of funds that will be used for the COD payment for this package.

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., package_cod_amount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_description Property

For FedEx, this is the description that appears in the email to identify this package.

Syntax

def get_package_description(package_idx: int) -> str: ...
def set_package_description(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_height Property

The height of the package to be shipped.

Syntax

def get_package_height(package_idx: int) -> int: ...
def set_package_height(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the package_height is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_length and package_width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When package_width is provided in the request, then all other dimensions (package_length and package_height) are to be set as well.

For USPS, this only applies to get_rates and is only required if the package is irregular and the package_packaging_type property is set to ptNonRectangular. (In this case package_width and package_height must still be set). For parcels, package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_girth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the package_length, package_width, and package_height are required for Priority Mail packages when the package_size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_id Property

An 8-digit Unique Parcel Identification Number.

Syntax

def get_package_id(package_idx: int) -> str: ...
def set_package_id(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

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

Indicates the package reference type and value, that associates this package (assigned by the customer).

Syntax

def get_package_reference(package_idx: int) -> str: ...
def set_package_reference(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the package_reference should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the package_reference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_return_receipt Property

Image of the receipt for a return shipment.

Syntax

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

Default Value

""

Remarks

Image of the receipt for a return shipment.

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_return_receipt_file Property

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

Syntax

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

Default Value

""

Remarks

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

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

The package_return_receipt_file has to have .html extension.

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_shipping_label Property

Image of the shipping label for this package returned by the Server upon a successful ship response.

Syntax

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

Default Value

""

Remarks

Image of the shipping label for this package returned by the server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via label_image_type. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the package_shipping_label_file is set to a valid path and filename, the label is also saved to disk in a label_image_type format.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_shipping_label_file Property

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

Syntax

def get_package_shipping_label_file(package_idx: int) -> str: ...
def set_package_shipping_label_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Filename and location to save the package_shipping_label of this package to. When the package_shipping_label_file is set to a valid path and filename, the contents of the package_shipping_label are written to disk upon successful response.

This filename should have the same extension defined by label_image_type (for example, if label_image_type is set to GIF, then package_shipping_label_file has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_signature_type Property

Specifies one of the Delivery Signature Options requested for this package.

Syntax

def get_package_signature_type(package_idx: int) -> int: ...
def set_package_signature_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

• Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
• Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
• Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
• Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the package_signature_type should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the service_type. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_special_services Property

Contains the collection of special services offered on the package level.

Syntax

def get_package_special_services(package_idx: int) -> int: ...
def set_package_special_services(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Contains the collection of special services offered on the package level. Valid values are:

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the package_special_services of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

• Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
• Dangerous Goods: Indicates that this package contains dangerous goods. When the package_special_services contains this flag, then the package_dangerous_goods_accessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
• Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
• Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
• Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
• COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the package_cod_amount and package_cod_type must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the package_special_services of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

• Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
• Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the package_cod_amount and package_cod_type, package_signature_type, and package_insured_value.

This property is not applicable to USPS or Canada Post.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_total_surcharges Property

Total Actual Surcharges applicable to this package.

Syntax

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

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the payor_account_number. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_tracking_number Property

Tracking number assigned to this package.

Syntax

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

Default Value

""

Remarks

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_weight Property

Weight of this package.

Syntax

def get_package_weight(package_idx: int) -> str: ...
def set_package_weight(package_idx: int, value: str) -> None: ...

Default Value

"0.0"

Remarks

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if package_packaging_type is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the service_type stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the service_type stUPSExpeditedMailInovations is used with the package_packaging_type ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if postage_provider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_width Property

The width of the package to be shipped.

Syntax

def get_package_width(package_idx: int) -> int: ...
def set_package_width(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the package_width is optional, but recommended, if "Your Packaging" is used as package_packaging_type. This is required if package_length and package_height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When package_width is provided in the request, then all other dimensions (package_length and package_height) are to be set as well.

For USPS, this is only required if the package is irregular and the package_packaging_type property is set to ptNonRectangular. (In this case package_width and package_height must still be set).

Note: For parcels, package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_girth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the package_length, package_width, and package_height are required for Priority Mail packages when the package_size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

payor_account_number Property

The account number of the party responsible for payment (shipping charges, or duties and taxes).

Syntax

def get_payor_account_number() -> str: ...
def set_payor_account_number(value: str) -> None: ...

payor_account_number = property(get_payor_account_number, set_payor_account_number)

Default Value

""

Remarks

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to payor_account_number.

payor_country_code Property

The country code for the payor of the shipment, or duties and taxes.

Syntax

def get_payor_country_code() -> str: ...
def set_payor_country_code(value: str) -> None: ...

payor_country_code = property(get_payor_country_code, set_payor_country_code)

Default Value

"US"

Remarks

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the payor_country_code is required to be provided in the ship request only if payor_type is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the payor_country_code is required only if payor_type is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

payor_type Property

Method of payment for shipment, or duties and taxes.

Syntax

def get_payor_type() -> int: ...
def set_payor_type(value: int) -> None: ...

payor_type = property(get_payor_type, set_payor_type)

Default Value

0

Remarks

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this property is set to a value other than 0 (ptSender), the payor_account_number and payor_country_code are required to be provided in the request as well. Otherwise, those will default to fed_ex_account_number and sender_country_code.

For UPS, when set to ptSender, the payor_account_number is automatically set to ups_account_number. When ptRecipient is specified, payor_account_number and payor_zip_code are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the payor_account_number, payor_zip_code and payor_country_code are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

payor_zip_code Property

Payor's postal code (if applicable).

Syntax

def get_payor_zip_code() -> str: ...
def set_payor_zip_code(value: str) -> None: ...

payor_zip_code = property(get_payor_zip_code, set_payor_zip_code)

Default Value

""

Remarks

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS payor_account_number's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the payor_type is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

pickup_earliest_time Property

The earliest time a shipment is ready to be picked up.

Syntax

def get_pickup_earliest_time() -> str: ...
def set_pickup_earliest_time(value: str) -> None: ...

pickup_earliest_time = property(get_pickup_earliest_time, set_pickup_earliest_time)

Default Value

""

Remarks

This is required when calling schedule_pickup. This contains the earliest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

pickup_latest_time Property

The latest time a shipment can be picked up.

Syntax

def get_pickup_latest_time() -> str: ...
def set_pickup_latest_time(value: str) -> None: ...

pickup_latest_time = property(get_pickup_latest_time, set_pickup_latest_time)

Default Value

""

Remarks

This is required when calling schedule_pickup. This contains the latest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

proxy_auth_scheme Property

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

Syntax

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

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

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

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

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

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

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

proxy_auto_detect Property

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

Syntax

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

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

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

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

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

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

proxy_port Property

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

Syntax

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

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

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

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

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

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

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

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

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

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

recipient_address1 Property

Street name.

Syntax

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

recipient_address1 = property(get_recipient_address1, set_recipient_address1)

Default Value

""

Remarks

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

recipient_address2 Property

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

Syntax

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

recipient_address2 = property(get_recipient_address2, set_recipient_address2)

Default Value

""

Remarks

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

recipient_address_flags Property

Various flags that denote information about the address.

Syntax

def get_recipient_address_flags() -> int: ...
def set_recipient_address_flags(value: int) -> None: ...

recipient_address_flags = property(get_recipient_address_flags, set_recipient_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

recipient_city Property

Name of city, town, etc.

Syntax

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

recipient_city = property(get_recipient_city, set_recipient_city)

Default Value

""

Remarks

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

recipient_country_code Property

Country code.

Syntax

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

recipient_country_code = property(get_recipient_country_code, set_recipient_country_code)

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

recipient_state Property

State or province code.

Syntax

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

recipient_state = property(get_recipient_state, set_recipient_state)

Default Value

""

Remarks

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

recipient_zip_code Property

Postal code.

Syntax

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

recipient_zip_code = property(get_recipient_zip_code, set_recipient_zip_code)

Default Value

""

Remarks

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

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

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

recipient_company Property

Identifies the contact person's company name.

Syntax

def get_recipient_company() -> str: ...
def set_recipient_company(value: str) -> None: ...

recipient_company = property(get_recipient_company, set_recipient_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either recipient_first_name and recipient_last_name or recipient_company are required to be provided.

recipient_email Property

Identifies the contact person's email address.

Syntax

def get_recipient_email() -> str: ...
def set_recipient_email(value: str) -> None: ...

recipient_email = property(get_recipient_email, set_recipient_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

recipient_fax Property

Recipient's fax number.

Syntax

def get_recipient_fax() -> str: ...
def set_recipient_fax(value: str) -> None: ...

recipient_fax = property(get_recipient_fax, set_recipient_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

recipient_first_name Property

Sender's first name.

Syntax

def get_recipient_first_name() -> str: ...
def set_recipient_first_name(value: str) -> None: ...

recipient_first_name = property(get_recipient_first_name, set_recipient_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either recipient_first_name and recipient_last_name or recipient_company must be sent.

recipient_last_name Property

Person's last name.

Syntax

def get_recipient_last_name() -> str: ...
def set_recipient_last_name(value: str) -> None: ...

recipient_last_name = property(get_recipient_last_name, set_recipient_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either recipient_first_name and recipient_last_name or recipient_company must be sent. Maximum length: 45 characters for both names or company name.

recipient_middle_initial Property

Middle initial.

Syntax

def get_recipient_middle_initial() -> str: ...
def set_recipient_middle_initial(value: str) -> None: ...

recipient_middle_initial = property(get_recipient_middle_initial, set_recipient_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

recipient_phone Property

Identifies the contact person's phone number.

Syntax

def get_recipient_phone() -> str: ...
def set_recipient_phone(value: str) -> None: ...

recipient_phone = property(get_recipient_phone, set_recipient_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

sedeccn_number Property

Export Control Classification Number.

Syntax

def get_sedeccn_number() -> str: ...
def set_sedeccn_number(value: str) -> None: ...

sedeccn_number = property(get_sedeccn_number, set_sedeccn_number)

Default Value

""

Remarks

Export Control Classification Number. This number identifies categories, product groups, strategic level of control, and country groups. Some products have an ECCN number.

This is required for SED forms only when the sed_exception_code is set to one of the following values: CIV, CTP, ENC, KMI, LVS.

Required length: 8 characters.

sed_entry_number Property

The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks).

Syntax

def get_sed_entry_number() -> str: ...
def set_sed_entry_number(value: str) -> None: ...

sed_entry_number = property(get_sed_entry_number, set_sed_entry_number)

Default Value

""

Remarks

The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks).

This is required for SED forms only if the sed_in_bond_code is set to a value other than 0 (ibcNotInBond).

Maximum length: 25.

sed_exception_code Property

License exception code.

Syntax

def get_sed_exception_code() -> int: ...
def set_sed_exception_code(value: int) -> None: ...

sed_exception_code = property(get_sed_exception_code, set_sed_exception_code)

Default Value

0

Remarks

License exception code.

If this is set to 0 (ecUnspecified), then the sed_license_number and the sed_license_date are required to be provided in the request. sed_license_number and sed_exception_code are mutually exclusive.

Valid values are:

sed_filed_by_ups Property

Indicates whether or not UPS will file SED on shipper's behalf.

Syntax

def get_sed_filed_by_ups() -> bool: ...
def set_sed_filed_by_ups(value: bool) -> None: ...

sed_filed_by_ups = property(get_sed_filed_by_ups, set_sed_filed_by_ups)

Default Value

FALSE

Remarks

Indicates whether or not UPS will file SED on shipper's behalf. This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the form_types is set).

If False (default value), it indicates that SED will be filed by the shipper, not UPS. If True, it indicates that UPS will file SED on shipper's behalf.

sed_in_bond_code Property

Indicates whether the shipment is being transported under bond.

Syntax

def get_sed_in_bond_code() -> int: ...
def set_sed_in_bond_code(value: int) -> None: ...

sed_in_bond_code = property(get_sed_in_bond_code, set_sed_in_bond_code)

Default Value

0

Remarks

Indicates whether the shipment is being transported under bond.

This is required when SED form is requested (i.e., when the Shipper's Export Declaration flag of the form_types is set).

Valid values are:

When sed_in_bond_code is set to a value other than ibcNotInBond, the sed_entry_number is required to be provided in the request.

sed_license_date Property

License date.

Syntax

def get_sed_license_date() -> str: ...
def set_sed_license_date(value: str) -> None: ...

sed_license_date = property(get_sed_license_date, set_sed_license_date)

Default Value

""

Remarks

License date.

This is required for SED forms only if the sed_license_number is provided in the request.

Format: YYYYMMDD

sed_license_number Property

The license number that authorizes ship product.

Syntax

def get_sed_license_number() -> str: ...
def set_sed_license_number(value: str) -> None: ...

sed_license_number = property(get_sed_license_number, set_sed_license_number)

Default Value

""

Remarks

The license number that authorizes ship product.

This is required for SED forms only if the sed_exception_code is not provided in the request. sed_license_number and sed_exception_code are mutually exclusive. If the product is not licensable, a valid sed_exception_code needs to be entered. If shipping different products that are covered under different licenses or license exceptions, then separate SEDs must be created.

Maximum length: 35.

sed_point_of_origin Property

Indicates the state or zone number from where the exports are leaving.

Syntax

def get_sed_point_of_origin() -> str: ...
def set_sed_point_of_origin(value: str) -> None: ...

sed_point_of_origin = property(get_sed_point_of_origin, set_sed_point_of_origin)

Default Value

""

Remarks

Indicates the state or zone number from where the exports are leaving.

This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the form_types is set). This should contain one of the following:

• The two-digit U.S. Postal Service abbreviation for the state from which the goods were shipped to the port of export.
• The state that is the source for the good with the highest value. The state of consolidation.
• The Foreign Trade Zone number of the zone from where the exports are leaving. If the goods were shipped from Puerto Rico, enter PR.

Maximum length: 5.

sed_shipper_tax_id Property

Shipper's Tax Identification Number.

Syntax

def get_sed_shipper_tax_id() -> str: ...
def set_sed_shipper_tax_id(value: str) -> None: ...

sed_shipper_tax_id = property(get_sed_shipper_tax_id, set_sed_shipper_tax_id)

Default Value

""

Remarks

Shipper's Tax Identification Number.

This is required for SED forms only.

Maximum length: 15 characters.

sed_transport_type Property

Indicates the type of transport by which the goods are exported.

Syntax

def get_sed_transport_type() -> str: ...
def set_sed_transport_type(value: str) -> None: ...

sed_transport_type = property(get_sed_transport_type, set_sed_transport_type)

Default Value

"Air"

Remarks

Indicates the type of transport by which the goods are exported.

This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the form_types is set).

Possible values: Air, AirContainerized, Auto FixedTransportInstallations Mail, PassengerHandcarried Pedestrian, Rail, RailContainerized, RoadOther, SeaBarge, SeaContainerized SeaNoncontainerized, Truck, TruckContainerized.

sender_address1 Property

Street name.

Syntax

def get_sender_address1() -> str: ...
def set_sender_address1(value: str) -> None: ...

sender_address1 = property(get_sender_address1, set_sender_address1)

Default Value

""

Remarks

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

sender_address2 Property

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

Syntax

def get_sender_address2() -> str: ...
def set_sender_address2(value: str) -> None: ...

sender_address2 = property(get_sender_address2, set_sender_address2)

Default Value

""

Remarks

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

sender_city Property

Name of city, town, etc.

Syntax

def get_sender_city() -> str: ...
def set_sender_city(value: str) -> None: ...

sender_city = property(get_sender_city, set_sender_city)

Default Value

""

Remarks

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

sender_country_code Property

Country code.

Syntax

def get_sender_country_code() -> str: ...
def set_sender_country_code(value: str) -> None: ...

sender_country_code = property(get_sender_country_code, set_sender_country_code)

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

sender_state Property

State or province code.

Syntax

def get_sender_state() -> str: ...
def set_sender_state(value: str) -> None: ...

sender_state = property(get_sender_state, set_sender_state)

Default Value

""

Remarks

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

sender_zip_code Property

Postal code.

Syntax

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

sender_zip_code = property(get_sender_zip_code, set_sender_zip_code)

Default Value

""

Remarks

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

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

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

sender_company Property

Identifies the contact person's company name.

Syntax

def get_sender_company() -> str: ...
def set_sender_company(value: str) -> None: ...

sender_company = property(get_sender_company, set_sender_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either sender_first_name and sender_last_name or sender_company are required to be provided.

sender_email Property

Identifies the contact person's email address.

Syntax

def get_sender_email() -> str: ...
def set_sender_email(value: str) -> None: ...

sender_email = property(get_sender_email, set_sender_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

sender_fax Property

Recipient's fax number.

Syntax

def get_sender_fax() -> str: ...
def set_sender_fax(value: str) -> None: ...

sender_fax = property(get_sender_fax, set_sender_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

sender_first_name Property

Sender's first name.

Syntax

def get_sender_first_name() -> str: ...
def set_sender_first_name(value: str) -> None: ...

sender_first_name = property(get_sender_first_name, set_sender_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either sender_first_name and sender_last_name or sender_company must be sent.

sender_last_name Property

Person's last name.

Syntax

def get_sender_last_name() -> str: ...
def set_sender_last_name(value: str) -> None: ...

sender_last_name = property(get_sender_last_name, set_sender_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either sender_first_name and sender_last_name or sender_company must be sent. Maximum length: 45 characters for both names or company name.

sender_middle_initial Property

Middle initial.

Syntax

def get_sender_middle_initial() -> str: ...
def set_sender_middle_initial(value: str) -> None: ...

sender_middle_initial = property(get_sender_middle_initial, set_sender_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

sender_phone Property

Identifies the contact person's phone number.

Syntax

def get_sender_phone() -> str: ...
def set_sender_phone(value: str) -> None: ...

sender_phone = property(get_sender_phone, set_sender_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

service_type Property

Identifies the UPS service type (applicable to international shipments) to use in a ship request.

Syntax

def get_service_type() -> int: ...
def set_service_type(value: int) -> None: ...

service_type = property(get_service_type, set_service_type)

Default Value

0

Remarks

This property is required to be provided in a ship request when the get_shipment_labels method is called.

Note that the availability and the description of UPS services depend on the country of origin. Possible values of service_type and their corresponding availability to each group country origin are listed below:

ship_date Property

The date the user requests UPS to pickup the package from the origin.

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 is required to be provided in a ship request only if UPS On-Call Pickup service is requested (i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in shipment_special_services). This date should not be a past date or a date more than 10 days in the future. If not provided, then it defaults to the current date.

This should be entered in this format: YYYYMMDD.

Note: It is not valid if this pickup date is the same day for shipment(s) going from Germany to Germany using UPS Standard service. Error 129090 will be returned in this case.

shipment_description Property

A textual description of goods for the whole shipment.

Syntax

def get_shipment_description() -> str: ...
def set_shipment_description(value: str) -> None: ...

shipment_description = property(get_shipment_description, set_shipment_description)

Default Value

""

Remarks

This is applicable to international shipments only. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc..

This is required to be provided in a ship request if all of the listed conditions are true:

• the sender_country_code and recipient_country_code are not the same;
• the sender_country_code and/or recipient_country_code are not in the European Union; or the sender_country_code and recipient_country_code are both in the European Union; and service_type is not 'UPS Standard'.
• the packaging type of any packages contained in the shipment is not 'UPS Letter';

Maximum length: 35 characters.

shipment_reference Property

Customer-defined number (that may or may not be unique) used to identify the whole shipment.

Syntax

def get_shipment_reference() -> str: ...
def set_shipment_reference(value: str) -> None: ...

shipment_reference = property(get_shipment_reference, set_shipment_reference)

Default Value

""

Remarks

This is applicable to international shipments only. Valid if the origin/destination pair is not US/US or PR/PR.

This is optional to be provided in a ship request (when the get_shipment_labels method is called). You can enter up to two customer references on shipment level by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this shipment, the shipment_reference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track shipment by reference.

shipment_special_services Property

Contains the collection of special services offered by UPS 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 UPS 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:

The meaning and limitations for each special service option are listed below:

• Hold for Pickup: This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient when the package is ready.

  This is applicable only if service_type is set to stUPSWorldwideExpressFreight.

• Liftgate Dropoff: This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.

  This is applicable only if service_type is set to stUPSWorldwideExpressFreight.

• Liftgate Pickup: This requests that UPs provide their liftgate services load a shipment when loading docks are not available.

  This is applicable only if service_type is set to stUPSWorldwideExpressFreight.

• Return Shipment: This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL). With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.

  If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.

  If you want to arrange for UPS to email a return label to your customer, you can use the ElectronicReturnLabel config setting.

  If you want to arrange for UPS to make one attempt to pick up the package to be returned, you can use the ReturnServiceFirstAttempt config setting.

  If you want to arrange for UPS to make three attempts to pick up the package to be returned, you can use the ReturnServiceThirdAttempt config setting.

  Using the last 4 options: in the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.

  For return shipments, one of the following conditions must be met on account_country_code, sender_country_code and recipient_country_code: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for form_types. The availability of return service depends on the origin and destination country code, and on the selected service_type. The package_description is required to be provided in the request for each package contained in the shipment. The package_type should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.

  Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.

• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
• Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
• Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
• Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
• Carbon Neutral: This is required to make a shipment that is carbon neutral.
• Exchange Forward: This is required in order to make exchange forward shipments.
• Dropoff at UPS Facility: When set this indicates that the package will be dropped off at a UPS Facility.

  This is applicable only if service_type is set to stUPSWorldwideExpressFreight.

• Deliver To Addressee Only: When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point

  This accessorial is only valid when ShipmentIndicationType is set to 1.

• Direct Delivery Only: When set this will ensure that the package is delivered to the ShipTo address on the shipping label.

  This accessorial is not valid when ShipmentIndicationType is set.

shipment_void_status Property

Status description of shipment void request.

Syntax

def get_shipment_void_status() -> str: ...

shipment_void_status = property(get_shipment_void_status, None)

Default Value

""

Remarks

Upon successful response, this is populated when the cancel_shipment or cancel_package method is called.

This property is read-only.

sold_to_address1 Property

Street name.

Syntax

def get_sold_to_address1() -> str: ...
def set_sold_to_address1(value: str) -> None: ...

sold_to_address1 = property(get_sold_to_address1, set_sold_to_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 sold_to_address1 should not exceed 35 characters.

sold_to_address2 Property

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

Syntax

def get_sold_to_address2() -> str: ...
def set_sold_to_address2(value: str) -> None: ...

sold_to_address2 = property(get_sold_to_address2, set_sold_to_address2)

Default Value

""

Remarks

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

sold_to_city Property

Name of city, town, etc.

Syntax

def get_sold_to_city() -> str: ...
def set_sold_to_city(value: str) -> None: ...

sold_to_city = property(get_sold_to_city, set_sold_to_city)

Default Value

""

Remarks

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

sold_to_country_code Property

Country code.

Syntax

def get_sold_to_country_code() -> str: ...
def set_sold_to_country_code(value: str) -> None: ...

sold_to_country_code = property(get_sold_to_country_code, set_sold_to_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

sold_to_state Property

State or province code.

Syntax

def get_sold_to_state() -> str: ...
def set_sold_to_state(value: str) -> None: ...

sold_to_state = property(get_sold_to_state, set_sold_to_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.

sold_to_zip_code Property

Postal code.

Syntax

def get_sold_to_zip_code() -> str: ...
def set_sold_to_zip_code(value: str) -> None: ...

sold_to_zip_code = property(get_sold_to_zip_code, set_sold_to_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 sold_to_city and sold_to_state are not present.

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

sold_to_company Property

Identifies the contact person's company name.

Syntax

def get_sold_to_company() -> str: ...
def set_sold_to_company(value: str) -> None: ...

sold_to_company = property(get_sold_to_company, set_sold_to_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either sold_to_first_name and sold_to_last_name or sold_to_company are required to be provided.

sold_to_email Property

Identifies the contact person's email address.

Syntax

def get_sold_to_email() -> str: ...
def set_sold_to_email(value: str) -> None: ...

sold_to_email = property(get_sold_to_email, set_sold_to_email)

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

sold_to_fax Property

Recipient's fax number.

Syntax

def get_sold_to_fax() -> str: ...
def set_sold_to_fax(value: str) -> None: ...

sold_to_fax = property(get_sold_to_fax, set_sold_to_fax)

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

sold_to_first_name Property

Sender's first name.

Syntax

def get_sold_to_first_name() -> str: ...
def set_sold_to_first_name(value: str) -> None: ...

sold_to_first_name = property(get_sold_to_first_name, set_sold_to_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either sold_to_first_name and sold_to_last_name or sold_to_company must be sent.

sold_to_last_name Property

Person's last name.

Syntax

def get_sold_to_last_name() -> str: ...
def set_sold_to_last_name(value: str) -> None: ...

sold_to_last_name = property(get_sold_to_last_name, set_sold_to_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either sold_to_first_name and sold_to_last_name or sold_to_company must be sent. Maximum length: 45 characters for both names or company name.

sold_to_middle_initial Property

Middle initial.

Syntax

def get_sold_to_middle_initial() -> str: ...
def set_sold_to_middle_initial(value: str) -> None: ...

sold_to_middle_initial = property(get_sold_to_middle_initial, set_sold_to_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

sold_to_phone Property

Identifies the contact person's phone number.

Syntax

def get_sold_to_phone() -> str: ...
def set_sold_to_phone(value: str) -> None: ...

sold_to_phone = property(get_sold_to_phone, set_sold_to_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

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

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

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

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

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

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

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

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are:

Additional Notes

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

total_base_charge Property

The total base charge applied to the whole shipment (specific to the AccountNumber ).

Syntax

def get_total_base_charge() -> str: ...

total_base_charge = property(get_total_base_charge, None)

Default Value

""

Remarks

In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as package_base_charge at index=0.

This property is read-only.

total_customs_value Property

Total customs value for the shipment.

Syntax

def get_total_customs_value() -> str: ...
def set_total_customs_value(value: str) -> None: ...

total_customs_value = property(get_total_customs_value, set_total_customs_value)

Default Value

"1"

Remarks

The total_customs_value is required to be provided in an international shipment request only if the following requirements are met:

• the sender_country_code is US;
• the recipient_country_code is either CA (Canada) or PR (PuertoRico);
• the shipment does not contain any package of UPS Letter type;

If Commercial Invoice is requested (i.e., one of the form_types is set to Invoice), this value should match the invoice line total on the invoice form. If not it will be replaced by the actual calculated invoice line total. It represents the sum of the values of all commodities included in the shipment.

Format: Whole number, no decimal position (e.g. 100) with maximum length of 8 digits. Possible values: 1 to 99999999.

total_net_charge Property

The total net charge (transportation charge + options charges) applied to the whole shipment (specific to the AccountNumber ).

Syntax

def get_total_net_charge() -> str: ...

total_net_charge = property(get_total_net_charge, None)

Default Value

""

Remarks

In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as package_net_charge at index=0.

This property is read-only.

total_surcharges Property

The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).

Syntax

def get_total_surcharges() -> str: ...

total_surcharges = property(get_total_surcharges, None)

Default Value

""

Remarks

In a MPS ship request, this represents the total surcharges applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as package_total_surcharges at index=0.

This property is read-only.

ups_account_number Property

The shipper's UPS account number.

Syntax

def get_ups_account_number() -> str: ...
def set_ups_account_number(value: str) -> None: ...

ups_account_number = property(get_ups_account_number, set_ups_account_number)

Default Value

""

Remarks

The shipper's UPS account number.

This property describes the shipper's 6- or 10- digit UPS account number.

ups_authorization_token Property

Authorization Token used to authenticate the request.

Syntax

def get_ups_authorization_token() -> str: ...
def set_ups_authorization_token(value: str) -> None: ...

ups_authorization_token = property(get_ups_authorization_token, set_ups_authorization_token)

Default Value

""

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

ups_server Property

URL for the UPS server where the requests are sent.

Syntax

def get_ups_server() -> str: ...
def set_ups_server(value: str) -> None: ...

ups_server = property(get_ups_server, set_ups_server)

Default Value

""

Remarks

URL for the UPS server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

The following URLs may be used for testing:

cancel_package Method

Cancels a single package by deleting it from the shipping log.

Syntax

def cancel_package(master_tracking_number: str, package_tracking_number: str) -> None: ...

Remarks

To cancel shipment of a single package, a void shipment request should be sent to UPS ups_server by calling the cancel_package method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the ups_server to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the ups_server should be sent to the URL provided as part of the certification process.

The TrackingNumber parameter identifies the package to be deleted from the shipping log.

This method will return the void status of the specified package.

To check the status of your shipment void request, the shipment_void_status should be inspected.

cancel_pickup Method

Cancel a pickup.

Syntax

def cancel_pickup(confirmation_number: str) -> None: ...

Remarks

When called the pickup referenced by the ConfirmationNumber will be canceled.

To check the status of your cancel pickup request the CancelPickUpStatus config should be inspected.

cancel_shipment Method

Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.

Syntax

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

Remarks

To cancel an entire MPS shipment, a void shipment request should be sent to UPS server by calling the cancel_shipment method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the server to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the server should be sent to the URL provided as part of the certification process.

The MasterTrackingNumber parameter identifies the shipment that contains all packages to be deleted from shipping log.

To check the status of your shipment void request, the shipment_void_status should be inspected.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_shipment_labels Method

Generates a shipping label.

Syntax

def get_shipment_labels() -> None: ...

Remarks

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

• ups_server (required)
• ups_authorization_token (required)
• ups_account_number (required)
• service_type (required)
• account_contact (conditional)
• account_address (conditional)
• sender_contact (required)
• sender_address (required)
• recipient_contact (required)
• recipient_address (required)
• sold_to_contact (conditional)
• sold_to_address (conditional)
• payor (required)
• shipment_special_services (optional)
• shipment_description (conditional)
• shipment_reference (conditional)
• packages (required)
• label_image_type (required)
• notify (optional)
• form_types (optional)
• commercial_invoice (optional)
• commodities (conditional)
• cod_report_file (optional)
• cod_total_amount (optional)
• cod_type (optional)
• WeightUnit (required; defaults to LB)
• Documents (optional)

The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the commodities (required, regardless of the Documents value).

Upon successful response, the following properties might be populated:

• master_tracking_number (if MPS)
• package_tracking_number for each package included in the shipment;
• package_shipping_label for each package included in the shipment;
• package_total_surcharges for each package included in the shipment (only guaranteed to be returned for shipments whose origin country is US or Puerto Rico);
• total_net_charge (applicable to the whole shipment);
• total_base_charge (applicable to the whole shipment);
• total_surcharges (applicable to the whole shipment);

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

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

schedule_pickup Method

Schedules a pickup.

Syntax

def schedule_pickup() -> str: ...

Remarks

When called, this will request an OnCall Pickup from UPS and return the Pickup Confirmation Number.

The valid properties when calling this method are as follows:

• service_type (Required)
• pickup_earliest_time (Required)
• pickup_latest_time (Required)
• sender_first_name (Optional, required if Company is not provided)
• sender_last_name (Optional, required if Company is not provided)
• sender_company (Optional, required if FirstName and/or LastName are not provided)
• sender_phone (Required)
• sender_address1 (Required)
• PickupFloorNumber (Optional)
• PickupRoomNumber (Optional)
• sender_city (Required)
• sender_state (Required, optional if outside US and Canada)
• sender_zip_code (Required)
• sender_country_code (Required)
• ship_date (Required)

Please note that only sender_address1 is valid as the request only allows one address line.

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class UPSShipIntl:
@property
def on_notification() -> Callable[[UPSShipIntlNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[UPSShipIntlNotificationEventParams], 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 UPSShipIntlSSLServerAuthenticationEventParams(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 UPSShipIntl:
@property
def on_ssl_server_authentication() -> Callable[[UPSShipIntlSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[UPSShipIntlSSLServerAuthenticationEventParams], 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 UPSShipIntlSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

UPSShipIntl Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

UPSShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

UPSShipIntl Errors

UPSShipIntl Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.
	560   Missing data.

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