USPSShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode. Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS International Label API lets customers generate eVS labels with integrated customs declaration forms.

Syntax

class dshippingsdk.USPSShipIntl

Remarks

Generating a shipping label can be done by calling the get_package_label method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Return Shipment, etc.), and any other specific information on international shipments.

Postage Provider Notes

ppNone

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

ppEndicia

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

Production

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

Testing

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

In all cases the class will send requests to the correct server without setting usps_server.

ppStamps

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

Property List


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

barcode_numberBarcode number associated with label's barcode.
certificate_numberCertificate number (if known or included in the package).
commentsComments on the package being shipped.
commodity_countThe number of records in the Commodity arrays.
commodity_descriptionComplete and accurate description of this commodity line item.
commodity_harmonized_codeUnique code representing this commodity line item (for imports only).
commodity_manufacturerCountry code where the contents of this commodity line were produced, manufactured or grown in their final form.
commodity_quantityNumber of units contained in this commodity line item measured in units specified by the QuantityUnit .
commodity_valueThe value of an individual item being shipped.
commodity_weightThe shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.
contentsType of the contents in the package.
customer_idUser-assigned number for internal use.
extra_servicesContains the collection of extra services offered by USPS on shipment level.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
image_layoutDetermines how the labels will be formatted for printing.
importers_emailIdentifies the contact person's email address.
importers_faxRecipient's fax number.
importers_phoneIdentifies the contact person's phone number.
indemnity_coverageIndicates the indemnity coverage for the package.
insurance_policyInsurance number, if known.
invoice_numberInvoice number if known or included in the package.
label_image_typeType of label image.
license_numberImport License number if known, or included in package.
machinableIndicates if shipment is machinable or not.
mailing_locationPostal Office Zip Code where the item will be mailed (if different from ZipCode ).
non_delivery_optionIndicates what to do with the package in case it is undeliverable.
notesAdditional information returned by the USPS Server .
observationsAdditional mailing information based on country of destination.
package_countThe number of records in the Package arrays.
package_cod_amountThe COD monetary value for the package.
package_cod_typeThe code that indicates the type of funds that will be used for the COD payment for this package.
package_descriptionFor FedEx, this is the description that appears in the email to identify this package.
package_girthMeasurement around the widest part of the package, perpendicular to the Length .
package_heightThe height of the package to be shipped.
package_idAn 8-digit Unique Parcel Identification Number.
package_insured_valueAmount of insurance requested for this package.
package_lengthThe length of the package to be shipped.
package_net_chargeActual Net Charge applicable to this package.
package_typeThe packaging type of the package being rated and/or shipped.
package_shipping_labelImage of the shipping label for this package returned by the Server upon a successful ship response.
package_shipping_label_fileFilename and location to save the ShippingLabel of this package to.
package_signature_typeSpecifies one of the Delivery Signature Options requested for this package.
package_sizeSize of the package being mailed.
package_tracking_numberTracking number assigned to this package.
package_weightWeight of this package.
package_widthThe width of the package to be shipped.
permit_numberPermit number to print Postage Due labels.
postage_providerThe postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
price_optionIndicates pricing that should be returned (i.e. Commercial Base).
prohibitionsList of items prohibited from mailing to the destination country.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_userThis property contains a username if authentication is to be used for the proxy.
recipient_address1Street name.
recipient_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
recipient_address_flagsVarious flags that denote information about the address.
recipient_cityName of city, town, etc.
recipient_country_codeCountry code.
recipient_stateState or province code.
recipient_zip_codePostal code.
recipient_companyIdentifies the contact person's company name.
recipient_emailIdentifies the contact person's email address.
recipient_faxRecipient's fax number.
recipient_first_nameSender's first name.
recipient_last_namePerson's last name.
recipient_middle_initialMiddle initial.
recipient_phoneIdentifies the contact person's phone number.
recipient_customs_referenceCorresponds to the person's Customs Reference field that appears on the shipping label.
regulationsAdditional regulations for shipping to the destination country.
restrictionsRestrictions on items being shipped based on country of destination.
sdr_valueSpecial Drawing Right calculated on TotalValue .
sender_address1Street name.
sender_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
sender_cityName of city, town, etc.
sender_stateState or province code.
sender_zip_codePostal code.
sender_companyIdentifies the contact person's company name.
sender_emailIdentifies the contact person's email address.
sender_faxRecipient's fax number.
sender_first_nameSender's first name.
sender_last_namePerson's last name.
sender_middle_initialMiddle initial.
sender_phoneIdentifies the contact person's phone number.
sender_customs_referenceCorresponds to the person's Customs Reference field that appears on the shipping label.
service_typeThe mail service type when shipping to the CountryCode .
ship_dateDate package will be mailed.
shipment_special_servicesContains the collection of special services offered by USPS on shipment level.
ssl_accept_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_providerThis specifies the SSL/TLS implementation to use.
ssl_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
timeoutA timeout for the class.
total_valueTotal value of all items being shipped.
transaction_idThe transaction Id.
usps_account_numberThe shipper's Endicia account number.
usps_passwordPassword to use for logging in to the USPS Server .
usps_serverURL for the USPS server where the requests are sent.
usps_user_idUser Id for logging in to the USPS WebTools or Stamps.

Method List


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

cancel_packageCancels a single package by deleting it from the eVS shipping log.
configSets or retrieves a configuration setting.
get_package_labelGenerates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.
resetResets the internal state of the class and all properties to their default values.

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.

on_errorInformation about errors during data delivery.
on_notificationNotification returned by the server upon successful request (if applicable).
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusFired when secure connection progress messages are available.

Config Settings


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

ActionCodeUse to specify the Action Code.
AddOnAggregate[i]Indicates the AddOn raw XML.
AddOnAmount[i]Indicates the AddOn amount.
AddOnCountTotal number of AddOns.
AddOnType[i]Indicates the AddOn type.
AddOnTypeDescription[i]Indicates the AddOn description.
AddOnTypesThe AddOn type to be requested.
AltReturnAddress1Alternate return address 1.
AltReturnAddress2Alternate return address 2.
AltReturnCountryAlternate return country.
APOFPOServiceTypeAPO/FPO Service Type for Military Mail and US territories (Except Puerto Rico and US Virgin Islands which are considered domestic).
CertifyCertify/Test mode for label classes.
CommercialPriceIndicates whether the commercial price should be returned.
CommodityItemCode[i]Item code representing the commodity line item.
CRIDCustomer Registration ID.
CustomerId2User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API.
CustomsFormTypeThe customs form type of the label.
CustomsSignerThe name of the person certifying the customs information is correct.
DeclaredValueThe amount to declare.
DestinationRateIndicatorDestination rate indicator for eVS International labels.
EELPFCExemption and Exclusion Legend or PFC Code.
EndiciaHazMatDescriptionHazMat Description.
EndiciaHazMatPhoneHazMat phone number.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EndiciaPrintConsolidatorLabelUsed to request Consolidator Services.
EndiciaTestModeControls whether requests are test requests or live requests.
EndiciaValidateAddressDefines if the address should be validated or not.
EntryFacilityPostal facility where mail is entered.
EscapeEndiciaXMLWhether to escape XML special characters when using Endicia.
HasXPathDetermines whether a specific element exists in the document.
HoldForManifestHolds manifest record for inclusion in SCAN request.
ImageParametersFor future use.
ImportersReferenceTypeImporter's Reference Type for eVS International labels.
IncludePostageUsed to determine if the postage will be printed on the label.
IntegratorTxIdStamps.com transaction integrator Id.
LabelImageResolutionThe resolution of the label.
LabelImageRotationThe rotation of the label.
LabelSizeThe size of the label.
LogisticsManagerMIDLogistics Manager Mailer ID.
MemoCustomer defined data to be printed on a Stamps shipping label.
MeterPaymentMeter payment indicator.
MIDMailer ID.
OptOutOfSPEOpt out of Shipping Partner Event file creation.
OtherContentsDescription of the contents.
OverwriteDetermines whether label files will be overwritten.
PackageLabelUrlStams.com label Url.
PackageReference[i]Indicates the package reference type and value, that associates this package.
PackageShippingLabelCount[i]Total number of labels and / or custom forms returned in the response for each package.
PackageShippingLabelIndex[i]Image of the shipping label returned by the Server upon a successful ship response for each package.
PackageSize[i]Indicates the package reference type and value, that associates this package.
POZipCodeZIP Code of Post Office.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
RecipientAddress3Recipient's address line 3.
RecipientAddress4Recipient's address line 4.
RecipientAPOFPOZipAPO/FPO ZIP code for Military Mail.
RecipientAPOFPOZip4APO/FPO ZIP4 code for Military Mail.
RecipientTaxIdTax Id for the recipient.
RedirectAddressRedirect Address.
RedirectCityRedirect City.
RedirectEmailRedirect Email.
RedirectNameRedirect Name.
RedirectSMSRedirect SMS.
RedirectStateRedirect State.
RedirectZip4Redirect ZIP4 extension.
RedirectZipCodeRedirect ZIP Code.
RegisteredMailValueThe value of registered mail sent in the request.
RequestIdThe ID used to identify a particular request/response pair when tracking Endicia packages.
RubberStamp1Customer defined data to be printed on label.
RubberStamp2Customer defined data to be printed on label.
RubberStamp3Customer defined data to be printed on label.
SCANFormImageImage of the PS Form 3152 or PS Form 5630.
SCANFormImageFileThe location where the SCAN Form Image will be written.
SCANFormNumberReturns the Form Number from the last succesful call to USPSCreateManifest.
SCANFormTypeIndicates the SCAN Form Type that should be returned when calling USPSCreateManifest.
SCANPackageBarcodesA list of Package Barcodes to include in the SCAN Request (create a manifest for).
SenderUrbanizationThe Urbanization that the package is being shipped from.
ShipTimeTime package will be mailed.
SortTypeSort level for applicable mail classes.
StampsAPIVersionControls the API version used for requests.
StampsCreateManifestSends a request to create a manifest for the specified shipments.
StampsCreateManifestIdReturns the ManifestId from the last succesful call to StampsCreateManifest.
StampsCreateManifestIdentifierA list of identifiers to create a manifest for.
StampsCreateManifestIdentifierTypeUsed to indicate the type of identifier used.
StampsTestModeControls whether requests are test requests or live requests.
StampsTxIdStamps.com transaction identifier.
UseInsuranceSpecifies whether or not to request insurance.
UseStealthUsed to determine if the postage price is printed on the label.
USPSCreateManifestSends a SCAN request to create a manifest for the specified shipments.
VendorCodeVendor Code to identify the developer of the shipping system.
VendorProductVersionNumberVendor Product Version Number.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathUsed to set the XPath within the response from the server.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

barcode_number Property

Barcode number associated with label's barcode.

Syntax

def get_barcode_number() -> str: ...

barcode_number = property(get_barcode_number, None)

Default Value

""

Remarks

The value of this property is filled after a call to the get_package_label method when using the eVS Label API (in other words postage_provider is set to ppNone).

This property is read-only.

certificate_number Property

Certificate number (if known or included in the package).

Syntax

def get_certificate_number() -> str: ...
def set_certificate_number(value: str) -> None: ...

certificate_number = property(get_certificate_number, set_certificate_number)

Default Value

""

Remarks

Some countries require a Certificate of Origin in order for certain items to be imported. (for example, fruits and vegetables). Restrictions as to what items require a Certificate Of Origin are returned in the restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

comments Property

Comments on the package being shipped.

Syntax

def get_comments() -> str: ...
def set_comments(value: str) -> None: ...

comments = property(get_comments, set_comments)

Default Value

""

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

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:

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_index: int) -> str: ...
def set_commodity_description(commodity_index: 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.

Description
Correspondence/No Commercial Value Leases
Accounting Documents Legal Documents
Analysis Reports Letters and Cards
Applications (Completed) Letter of Credit Packets
Bank Statements Loan Documents
Bid Quotations Marriage Certificates
Birth Certificates Medical Records
Bills of Sale Office Records
Bonds Operating Agreements
Business Correspondence Patent Applications
Checks (Completed) Permits
Claim Files Photocopies
Closing Statements Proposals
Conference Reports Prospectuses
Contracts Purchase Orders
Cost Estimates Quotations
Court Transcripts Reservation Confirmation
Credit Applications Resumes
Data Sheets Sales Agreements
Deeds Sales Reports
Employment Papers Shipping Documents
Escrow Instructions Statements/Reports
Export Papers Statistical Data
Financial Statements Stock Information
Immigration Papers Tax Papers
Income Statements Trade Confirmation
Insurance Documents Transcripts
Interoffice Memos Warranty Deeds
Inventory Reports
Invoices (Completed)

The commodity_index 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_index: int) -> str: ...
def set_commodity_harmonized_code(commodity_index: 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_index 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_index: int) -> str: ...
def set_commodity_manufacturer(commodity_index: 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.

Country Name Country Code Currency CodeMax WeightAddress Validation SupportedPostal Code Req.Euro Country
Albania AL ALL 70 KGS No No No
Algeria DZ DZD 70 KGS No No No
Andorra AD PTS 70 KGS No No No
Angola AO AOK 70 KGS No No No
Anguilla AI XCD 150 LBS No No No
Antigua & Barbuda AG XCD 150 LBS No No No
Argentina AR ARP 70 KGS Yes Yes No
Armenia AM USD 70 KGS No Yes No
Aruba AW AWG 150 LBS No No No
Australia AU AUD 70 KGS Yes Yes No
Austria (EU Member) AT EUR 70 KGS No Yes Yes
Azerbaijan AZ RUR 70 KGS No Yes No
Bahamas BS BSD 150 LBS No No No
Bahrain BH BHD 70 KGS No No No
Bangladesh BD BDT 70 KGS No Yes No
Barbados BB BBD 150 LBS No No No
Belarus BY RUR 70 KGS No Yes No
Belgium (EU Member) BE EUR 70 KGS No Yes Yes
Belize BZ BZD 150 LBS No No No
Benin BJ XOF 70 KGS No No No
Bermuda BM BMD 150 LBS No No No
Bolivia BO BOP 70 KGS No No No
Bosnia-Herzegovina BA BAD 70 KGS No Yes No
Botswana BW BWP 70 KGS No No No
Brazil BR BRC 70 KGS Yes Yes No
British Virgin IslandsVG USD 150 LBS No No No
Brunei BN BND 70 KGS No No No
Bulgaria BG BGL 70 KGS No Yes No
Burkina Faso BF XOF 70 KGS No No No
Burundi BI BIF 70 KGS No No No
Cambodia KH USD 70 KGS No No No
Cameroon CM XAF 70 KGS No No No
Canada CA CAD 150 LBS Yes Yes No
Cape Verde CV USD 70 KGS No No No
Cayman Islands KY KYD 150 LBS No No No
Central African Rep CF XAF 70 KGS No No No
Chad TD XAF 70 KGS No No No
Channel Islands CD GBP 70 KGS No Yes No
Chile CL CLP 70 KGS Yes No No
China CN CNY 70 KGS Yes Yes No
Colombia CO COP 70 KGS Yes No No
Congo CG XAF 70 KGS No No No
Cook Islands CK NZD 70 KGS No No No
Costa Rica CR CRC 70 KGS No No No
Croatia HR YUD 70 KGS No Yes No
Cyprus CY CYP 70 KGS No No No
Czech Republic CZ CZK 70 KGS No Yes No
Dem Rep of Congo (Zaire)ZR ZRZ 70 KGS No No No
Denmark (EU Member) DK DKK 70 KGS Yes Yes Yes
Djibouti DJ DJF 70 KGS No No No
Dominica DM XCD 150 LBS No No No
Dominican Republic DO DOP 150 LBS No No No
Ecuador EC ECS 70 KGS No No No
Egypt EG EGP 70 KGS No No No
El Salvador SV SVC 70 KGS No No No
Equatorial Guinea GQ XAF 70 KGS No No No
Eritrea ER DKK 70 KGS No No No
Estonia EE EEK 70 KGS No Yes No
Ethiopia ET ETB 70 KGS No No No
Faeroe Islands FO DKK 70 KGS No Yes No
Fiji FJ FJD 70 KGS No No No
Finland (EU Member) FI EUR 70 KGS No Yes Yes
France (EU Member) FR EUR 70 KGS Yes Yes Yes
French Guiana GF FRF 70 KGS No No No
French Polynesia PF XPF 70 KGS No No No
Gabon GA XAF 70 KGS No No No
Gambia GM GMD 70 KGS No No No
Georgia GE RUR 70 KGS No Yes No
Germany (EU Member) DE EUR 70 KGS Yes Yes Yes
Ghana GH GHC 70 KGS No No No
Gibraltar GI GIP 70 KGS No No No
Greece (EU Member) GR EUR 70 KGS No Yes Yes
Greenland GL DKK 70 KGS No Yes No
Grenada GD XCD 150 LBS No No No
Guadeloupe GP FRF 150 LBS No No No
Guam GU USD 150 LBS No No No
Guatemala GT GTO 70 KGS No No No
Guinea GN GNS 70 KGS No No No
Guinea-Bissau GW GWP 70 KGS No No No
Guyana GY GYD 70 KGS No No No
Haiti HT HTG 150 LBS No No No
Honduras HN HNL 70 KGS No No No
Hong Kong HK HKD 70 KGS No No No
Hungary HU HUF 70 KGS No Yes Yes
Iceland IS ISK 70 KGS No Yes Yes
India IN INR 70 KGS Yes Yes No
Indonesia ID IDR 70 KGS No Yes No
Iran IR IRR 70 KGS No No No
Iraq IQ IQD 70 KGS No No No
Ireland (EU Member) IE EUR 70 KGS Yes No Yes
Israel IL ILS 70 KGS No Yes Yes
Italy (EU Member) IT EUR 70 KGS Yes Yes Yes
Ivory Coast CI XOF 70 KGS No No No
Jamaica JM KMD 70 KGS No No No
Japan JP JPY 70 KGS Yes Yes No
Jordan JO JOD 70 KGS No No No
Kazakhstan KZ RUR 70 KGS No Yes No
Kenya KE KES 70 KGS No No No
Kiribati KI AUD 70 KGS No No No
Kuwait KW KWD 70 KGS No No No
Kyrgyzstan KG RUR 70 KGS No Yes No
Laos LA USD 70 KGS No No No
Latvia LV RUR 70 KGS No Yes No
Lebanon LB LBP 70 KGS No No No
Lesotho LS ZAR 70 KGS No No No
Liberia LR LRD 70 KGS No No No
Libya LY LYD 70 KGS No No No
Liechtenstein LI CHF 70 KGS No Yes No
Lithuania LT LTL 70 KGS No Yes No
Luxembourg LU LUF 70 KGS No Yes Yes
Macau MO MOP 70 KGS No No No
Macedonia (FYROM) MK USD 70 KGS No Yes Yes
Madagascar MG MGF 70 KGS No No No
Malawi MW MWK 70 KGS No No No
Malaysia MY MYR 70 KGS Yes Yes No
Maldives MV MVR 70 KGS No No No
Mali ML MLF 70 KGS No No No
Malta MT MTP 70 KGS No No No
Marshall Islands MH USD 70 KGS No Yes No
Martinique MQ FRF 150 LBS No Yes No
Mauritania MR MRO 70 KGS No No No
Mauritius MU MUR 70 KGS No No No
Mexico MX MXP 70 KGS Yes Yes No
Micronesia FM USD 70 KGS No Yes No
Moldova MD EUR 70 KGS No Yes Yes
Monaco (EU Member) MC EUR 70 KGS No Yes Yes
Mongolia MN USD 70 KGS No Yes No
Montserrat MS XCD 150 LBS No No No
Morocco MA MAD 70 KGS No No No
Mozambique MZ MZM 70 KGS No No No
Myanmar MM USD 70 KGS No No No
N. Mariana Islands MP USD 150 LBS No No No
Namibia NA ZAR 70 KGS No No No
Nepal NP NPR 70 KGS No Yes No
Netherlands (EU Member) NL EUR 70 KGS Yes Yes Yes
Netherlands Antilles AN ANG 150 LBS No No No
New Caledonia NC XPF 70 KGS No No No
New Zealand NZ NZD 70 KGS Yes Yes No
Nicaragua NI NIC 70 KGS No No No
Niger NE XOF 70 KGS No No No
Nigeria NG NGN 70 KGS No No No
Norfolk Island NF AUD 70 KGS No No No
Norway NO NOK 70 KGS No Yes Yes
Oman OM OMR 70 KGS No No No
Pakistan PK PKR 70 KGS No Yes No
Palau PW USD 70 KGS No Yes No
Panama PA PAB 70 KGS No No No
Papua New Guinea PG PGK 70 KGS No No No
Paraguay PY PYG 70 KGS No No No
Peru PE PES 70 KGS Yes No No
Philippines PH PHP 70 KGS Yes Yes No
Poland PL PLZ 70 KGS No Yes Yes
Portugal(EU Member) PT EUR 70 KGS No Yes Yes
Puerto Rico PR USD 150 LBS Yes Yes No
Qatar QA QAR 70 KGS No No No
Reunion Is. RE FRF 70 KGS No Yes No
Romania RO ROL 70 KGS No Yes Yes
Russia RU RUR 70 KGS No Yes No
Rwanda RW RWF 70 KGS No No No
Samoa (Amer.) AS USD 70 KGS No No No
Samoa (Western) WS NZD 70 KGS No No No
San Marino IT ITL 70 KGS No Yes Yes
Saudi Arabia SA SAR 70 KGS No Yes No
Senegal SN XOF 70 KGS No No No
Serbia & Montenegro CS YUD 70 KGS No Yes Yes
Seychelles SC SCR 70 KGS No No No
Sierra Leone SL SLL 70 KGS No No No
Singapore SG SGD 70 KGS Yes Yes No
Slovak Republic SK SKK 70 KGS No Yes Yes
Slovenia SI SIT 70 KGS No Yes Yes
Solomon Islands SB SBD 70 KGS No No No
South Africa ZA GBP 70 KGS Yes Yes No
South Korea KR KRW 70 KGS No Yes No
Spain (EU Member) ES EUR 70 KGS Yes Yes Yes
Sri Lanka LK LKR 70 KGS No Yes No
St. Christopher KN XCD 150 LBS No No No
St. Lucia LC XCD 150 LBS No No No
St. Vincent/GrenadinesVC XCD 150 LBS No No No
Sudan SD SDP 70 KGS No No No
Suriname SR SRG 70 KGS No No No
Swaziland SZ SZL 70 KGS No No No
Sweden (EU Member) SE SEK 70 KGS No Yes Yes
Switzerland CH CHF 70 KGS Yes Yes Yes
Syria SY SYP 70 KGS No No No
Taiwan TW NTD 70 KGS No Yes No
Tajikistan TJ RUR 70 KGS No Yes No
Tanzania TZ TZS 70 KGS No No No
Thailand TH THB 70 KGS No Yes No
Togo TG XOF 70 KGS No No No
Tonga TO TOP 70 KGS No No No
Trinidad & Tobago TT TTD 150 LBS No No No
Tunisia TN TND 70 KGS No No No
Turkey TR TRL 70 KGS No Yes Yes
Turkmenistan TM RUR 70 KGS No Yes No
Turks & Caicos IslandsTC USD 150 LBS No No No
Tuvalu TV AUD 70 KGS No No No
Uganda UG UGS 70 KGS No No No
Ukraine UA UAK 70 KGS No Yes No
United Arab Emirates AE AED 70 KGS No No No
United Kingdom(EU Member)GBGBP 70 KGS Yes Yes Yes
United States US USD 150 LBS Yes Yes No
Uruguay UY UYP 70 KGS No Yes No
US Virgin Islands VI USD 150 LBS No Yes No
Uzbekistan UZ RUR 70 KGS No Yes No
Vanuatu VU VUV 70 KGS No No No
Venezuela VE VEB 70 KGS Yes No No
Vietnam VN USD 70 KGS No Yes No
Wake Island WK USD 70 KGS No No No
Wallis & Futuna Isle WF XPF 70 KGS No No No
Yemen YE YER 70 KGS No No No
Zambia ZM ZMK 70 KGS No No No
Zimbabwe ZW ZWD 70 KGS No No No

The commodity_index 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_index: int) -> int: ...
def set_commodity_quantity(commodity_index: 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_index 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_index: int) -> str: ...
def set_commodity_value(commodity_index: 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_index 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_index: int) -> str: ...
def set_commodity_weight(commodity_index: 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_index parameter specifies the index of the item in the array. The size of the array is controlled by the commodity_count property.

contents Property

Type of the contents in the package.

Syntax

def get_contents() -> int: ...
def set_contents(value: int) -> None: ...

contents = property(get_contents, set_contents)

Default Value

0

Remarks

You can set this property when generating labels to indicate the content type in the package.

Possible values are as follows:

Value Endicia & Stamps InternationalUSPS (eVS International)USPS (eVS Domestic)
ctSample (0) X X
ctGift (1) X X
ctDocuments (2) X X
ctReturn (3) X X
ctOther (4) X X
ctMerchandise (5) X X
ctHumanitarianDonation (6) X X
ctDangerousGoods (7) X X
ctCrematedRemains (8) X X
ctNonNegotiableDocument (9) X
ctPharmaceuticals (10) X X
ctMedicalSupplies (11) X X
ctHAZMAT (12) X
ctLives (13) X
ctPerishable (14) X

Note that if contents is set to ctOther, you may be required to set the OtherContents configuration setting with a description of the contents. For example:

class.Contents = ctOther class.Config("OtherContents=Livestock")

customer_id Property

User-assigned number for internal use.

Syntax

def get_customer_id() -> str: ...
def set_customer_id(value: str) -> None: ...

customer_id = property(get_customer_id, set_customer_id)

Default Value

""

Remarks

You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.

Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.

For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.

extra_services Property

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

Syntax

def get_extra_services() -> int: ...
def set_extra_services(value: int) -> None: ...

extra_services = property(get_extra_services, set_extra_services)

Default Value

0

Remarks

To request any of the extra services offered by USPS, you must set the extra_services to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

Value Meaning
0x00000001L Certified Mail
0x00000002L Certified Mail Restricted Delivery
0x00000004L Certified Mail Adult Signature Required
0x00000008L Certified Mail Adult Signature Restricted Delivery
0x00000010L Insurance
0x00000020L Insurance PME
0x00000040L Insurance PM
0x00000080L Insurance Restricted Delivery
0x00000100L Insurance Restricted Delivery PME
0x00000200L Insurance Restricted Delivery PM
0x00000400L Return Receipt
0x00000800L Return Receipt Electronic
0x00001000L Return Receipt Express Mail
0x00002000L Adult Signature
0x00004000L Adult Signature Restricted Delivery
0x00008000L Signature Confirmation Electronic
0x00010000L Signature Confirmation Electronic Restricted Delivery
0x00020000L Scan Retention
0x00040000L Scan and Signature Retention
0x00080000L Special Handling Fragile
0x00100000L 10:30 AM Delivery PME
0x00200000L USPS Tracking Electronic
0x00400000L Electronic USPS Delivery Confirmation International

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:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. firewall_port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. firewall_port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. firewall_port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. firewall_port is set to 1080.

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.

image_layout Property

Determines how the labels will be formatted for printing.

Syntax

def get_image_layout() -> int: ...
def set_image_layout(value: int) -> None: ...

image_layout = property(get_image_layout, set_image_layout)

Default Value

0

Remarks

The label_image_type property indicates the file type of the label that USPS returns. image_layout dictates how the label looks in that file. The labels returned by USPS measure 8.5" x 5.5", or exactly one half of a sheet of regular 8.5" x 11" paper. The layouts available are listed below:

ilOnePerFile (0)Each label is returned as a separate file. The label takes up the top half of the paper, and the bottom half is left blank.
ilAllInOneFile (1)All the labels are returned in one file. Each label takes up the top half of a piece of paper, and the bottom half is left blank.
ilTrimOnePerFile (2)Labels are returned two to a file. If there are six pages of labels, then there will be only three files. Each file has a label on both the top and bottom half of the paper.
ilTrimAllInOneFile (3)All the labels are returned in one file. No blank space is left on the pages.

For the ilAllInOneFile and ilTrimAllInOneFile image_layouts, only one file will be written. However, for the ilOnePerFile and ilTrimOnePerFile image_layouts, more than one shipping label may be returned, up to a maximum of 6 total pages. If package_shipping_label_file is specified, these additional pages will be saved with the page number appended to the package_shipping_label_file you supplied.

For instance, if the package_shipping_label_file is "c:\expresslabel.pdf", the following files will be created: "expresslabel.pdf", "expresslabel.page2.pdf", "expresslabel.page3.pdf", etcetera.

Note that for the stUSPSFirstClass service_type, only ilOnePerFile and ilAllInOneFile are supported. Using any of the Trim-values will result in an error from USPS.

importers_email Property

Identifies the contact person's email address.

Syntax

def get_importers_email() -> str: ...
def set_importers_email(value: str) -> None: ...

importers_email = property(get_importers_email, set_importers_email)

Default Value

""

Remarks

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

importers_fax Property

Recipient's fax number.

Syntax

def get_importers_fax() -> str: ...
def set_importers_fax(value: str) -> None: ...

importers_fax = property(get_importers_fax, set_importers_fax)

Default Value

""

Remarks

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

importers_phone Property

Identifies the contact person's phone number.

Syntax

def get_importers_phone() -> str: ...
def set_importers_phone(value: str) -> None: ...

importers_phone = property(get_importers_phone, set_importers_phone)

Default Value

""

Remarks

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

indemnity_coverage Property

Indicates the indemnity coverage for the package.

Syntax

def get_indemnity_coverage() -> str: ...

indemnity_coverage = property(get_indemnity_coverage, None)

Default Value

""

Remarks

This property is returned only for International Priority Mail packages, and only when the insured_value property was set to an amount greater than "0.00".

This property is read-only.

insurance_policy Property

Insurance number, if known.

Syntax

def get_insurance_policy() -> str: ...
def set_insurance_policy(value: str) -> None: ...

insurance_policy = property(get_insurance_policy, set_insurance_policy)

Default Value

""

Remarks

If insurance has been purchased, this property should be set to the policy number.

This property is not applicable for International First Class mail.

invoice_number Property

Invoice number if known or included in the package.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

This property may contain an invoice number if it is known or included in the package. Maximum length is 24 characters. This property is ignored when package_type is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

label_image_type Property

Type of label image.

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

The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:

sitNone (0) Enter sitNone if a label is not desired. (Only the package_tracking_number will be returned).
sitTIF (1) Tagged Image File format (bitmap).
sitJPG (2) Joint Photographic expert Group format.
sitPDF (3) Adobe Acrobat's Portable Document format.
sitGIF (4) CompuServe's Graphics Interchange format.
sitEPL (5) EPL2 format.
sitPNG (6) PNG image.
sitZPL (7) ZPLII format.
sitPDFVector (8) PDFVector format.
sitPDFVectorWithFonts (9) PDFVectorWithFonts format.
sitAZPL (10) AZPL format.

Valid values for USPS (eVSLabels):

  • sitTIF (1)
  • sitPDF (3)

Valid values for Endicia:

  • sitJPG (2)
  • sitPDF (3)
  • sitGIF (4)
  • sitEPL (5)
  • sitPNG (6)
  • sitZPL (7)
  • sitPDFVector (8)
  • sitPDFVectorWithFonts (9)

Valid values for Stamps.com:

  • sitJPG (2)
  • sitPDF (3)
  • sitGIF (4)
  • sitEPL (5)
  • sitPNG (6)
  • sitZPL (7)
  • sitAZPL (10)

license_number Property

Import License number if known, or included in package.

Syntax

def get_license_number() -> str: ...
def set_license_number(value: str) -> None: ...

license_number = property(get_license_number, set_license_number)

Default Value

""

Remarks

Many countries require the sender to obtain a license in order to import certain items (for example, drugs or medical equipment). Restrictions as to what items require a license are returned in the restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

machinable Property

Indicates if shipment is machinable or not.

Syntax

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

machinable = property(get_machinable, set_machinable)

Default Value

0

Remarks

The default value for this property is moTrue (0).

Note: The value moIrregular (2) is valid only when service_type is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).

Possible values are as follows:

ValueDescription
moTrue (0) True (default)
moFalse (1) False
moIrregular (2) Irregular

mailing_location Property

Postal Office Zip Code where the item will be mailed (if different from ZipCode ).

Syntax

def get_mailing_location() -> str: ...
def set_mailing_location(value: str) -> None: ...

mailing_location = property(get_mailing_location, set_mailing_location)

Default Value

""

Remarks

The value of this property is optional.

If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (sender_zip_code), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the mailing_location property.

This way, you convey this difference to the USPS server.

This property is not applicable for International First Class mail.

non_delivery_option Property

Indicates what to do with the package in case it is undeliverable.

Syntax

def get_non_delivery_option() -> int: ...
def set_non_delivery_option(value: int) -> None: ...

non_delivery_option = property(get_non_delivery_option, set_non_delivery_option)

Default Value

0

Remarks

In case the package is undeliverable, the package may be Returned, Redirected, or Abandoned.

Value Meaning
ndoReturn (0) Return - the package will be returned to the sender's address (default).
ndoRedirect (1) Redirect - the package will be redirected to the address specified in the following configuration settings:

USPS(eVS Label ): RedirectName, RedirectEmail, RedirectSMS, RedirectAddress, RedirectCity, RedirectState, RedirectZipCode, RedirectZip4

USPS(Stamps.com): AltReturnAddress1, AltReturnAddress2, AltReturnCountry

ndoAbandon (2) Abandon - the undeliverable package will be disposed.

This property is not applicable for International First Class mail (stUSPSFirstClassMailInternational (83) ).

notes Property

Additional information returned by the USPS Server .

Syntax

def get_notes() -> str: ...

notes = property(get_notes, None)

Default Value

""

Remarks

This property may contain additional notes pertaining to the shipment of goods to the destination country (recipient_country_code).

This property is read-only.

observations Property

Additional mailing information based on country of destination.

Syntax

def get_observations() -> str: ...

observations = property(get_observations, None)

Default Value

""

Remarks

Additional information that may be important to the sender. Returned by the USPS server

This property is read-only.

package_count Property

The number of records in the Package arrays.

Syntax

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

package_count = property(get_package_count, set_package_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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:

Value Description
codtpAny (0) Company check, personal check, cashier's check or money order - UPS no cash allowed. Not applicable for Canada Post
codtpCash (1) Cash - FedEx only, only valid for Ground shipments
codtpGuaranteedFunds (2) Cashier's check or money order
codtpCompanyCheck (3) Company check - FedEx and Canada Post only
codtpPersonalCheck (4) Personal check - FedEx and Canada Post only

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

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

Syntax

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

Default Value

0

Remarks

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

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

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

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

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

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

package_height Property

The height of the package to be shipped.

Syntax

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

Default Value

0

Remarks

The height of the package to be shipped.

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

package_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_net_charge Property

Actual Net Charge applicable to this package.

Syntax

def get_package_net_charge(package_idx: int) -> str: ...
def set_package_net_charge(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Actual Net Charge applicable to this package.

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

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

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

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

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

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

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

package_type Property

The packaging type of the package being rated and/or shipped.

Syntax

def get_package_type(package_idx: int) -> int: ...
def set_package_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The packaging type of the package being rated and/or shipped.

Possible values are:

Value FedEx UPS USPS USPS (Endicia) USPS (Stamps.com) Canada Post
ptNone (0) X X X
ptPostcards (1) X X X
ptLetter (2) X X X X
ptLargeEnvelope (3) X X X
ptFlatRateEnvelope (4) X X X
ptFlatRateLegalEnvelope (5) X X X
ptFlatRatePaddedEnvelope (6) X X X
ptFlatRateGiftCardEnvelope (7) X X
ptFlatRateWindowEnvelope (8) X X
ptFlatRateCardboardEnvelope (9) X
ptSmallFlatRateEnvelope (10) X X
ptPak (11) X X
ptBox (12) X X
pt10kgBox (13) X X
pt25kgBox (14) X X
ptSmallExpressBox (15) X
ptMediumExpressBox (16) X
ptLargeExpressBox (17) X
ptFlatRateBox (18) X X
ptSmallFlatRateBox (19) X X X
ptMediumFlatRateBox (20) X X X
ptLargeFlatRateBox (21) X X X
ptDVDFlatRateBox (22) X
ptLargeVideoFlatRateBox (23) X
ptRegionalRateBoxA (24) X X X
ptRegionalRateBoxB (25) X X X
ptRectangular (26) X
ptNonRectangular (27) X
ptTube (28) X X X
ptMatterForTheBlind (29) X
ptPallet (30) X
ptYourPackaging (31) X X X X X X
ptDocument (32) X
ptFlats (33) X
ptParcels (34) X
ptBPM (35) X
ptFirstClass (36) X
ptPriority (37) X
ptMachinables (38) X
ptIrregulars (39) X
ptParcelPost (40) X
ptBPMParcel (41) X
ptMediaMail (42) X
ptBPMFlat (43) X
ptStandardFlat (44) X
ptRegionalRateBoxC (45) X X X
ptThickEnvelope (46) X X X
ptSmallBox (47) X
ptMediumBox (48) X
ptLargeBox (49) X
ptExtraLargeBox (50) X
ptPackageService (51) X
ptCubicParcels (52) X
ptCubicSoftPack (53) X

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:

service_type package_packaging_type package_weight
stFirstClass (35) ptFirstClass (36) 1 to 13 OZS
stPriorityMail (36) ptPriority (37) 1 to 70 LBS
stExpeditedMailInnovations (37) ptMachinables (38) 6 to <16 OZS
stExpeditedMailInnovations (37) ptIrregulars (39) 1 to <16 OZS
stExpeditedMailInnovations (37) ptParcelPost (40) 1 to 70 LBS
stExpeditedMailInnovations (37) ptBPMParcel (41) 1 to 15 LBS
stExpeditedMailInnovations (37) ptMediaMail (42) 1 to 70 LBS
stExpeditedMailInnovations (37) ptBPMFlat (43) 1 to 15 LBS
stExpeditedMailInnovations (37) ptStandardFlat (44) 1 to <16 OZS
stPriorityMailInnovations (38) ptFlats (33) 1 to 70 LBS
stPriorityMailInnovations (38) ptParcels (34) 1 to 70 LBS
stPriorityMailInnovations (38) ptBPM (35) 1 to 70 LBS
stEconomyMailInnovations (39) ptFlats (33) 1 to 70 LBS
stEconomyMailInnovations (39) ptParcels (34) 1 to 70 LBS
stEconomyMailInnovations (39) ptBPM (35) 1 to 70 LBS

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

stServiceDefault (0) The default value for the requested service.
stAdult (1) Available for both residential and nonresidential deliveries.
stDirect (2) Available for both residential and nonresidential deliveries.
stIndirect (3) Available for residential deliveries only.
stNoSignatureRequired (4)Not available for Ground services.
stUSPSDeliveryConfirmation (5)Available for UPS Mail Innovations only.
stAdult19 (6)Available for Canada Post only.

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

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

package_size Property

Size of the package being mailed.

Syntax

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

Default Value

0

Remarks

Size of the package being mailed.

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

See below for valid entries:

Package SizeDescriptionservice_type
psRegularFor Priority Mail: Package is less than one cubic foot in size. For all other service_types: Package length plus girth is 84 inches or less. Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
psLargeFor Priority Mail: Package is greater than one cubic foot in size. For all other service_types: Package length plus girth measure more than 84 inches but not more than 108 inches. This tag does not affect the rate for Express Mail, Bound Printed Mater, Media Mail or Library Mail.Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
dsOversizePackage length plus girth is more than 108 but not more than 130 inches. Parcel Post packages that measure more than 108 inches but not more than 130 inches in combined length and girth are charged the oversized Parcel Post rate regardless of the weight of the package.Parcel Post only.

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the package_length, package_height, package_width and optionally package_girth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

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

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

permit_number Property

Permit number to print Postage Due labels.

Syntax

def get_permit_number() -> str: ...
def set_permit_number(value: str) -> None: ...

permit_number = property(get_permit_number, set_permit_number)

Default Value

""

Remarks

Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.

postage_provider Property

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

Syntax

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

postage_provider = property(get_postage_provider, set_postage_provider)

Default Value

0

Remarks

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

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

For Production

For Testing

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

price_option Property

Indicates pricing that should be returned (i.e. Commercial Base).

Syntax

def get_price_option() -> int: ...
def set_price_option(value: int) -> None: ...

price_option = property(get_price_option, set_price_option)

Default Value

2

Remarks

The default value for this property is poCommercialBase (2).

Note: When service_type is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).

Note: The value poRetail (0) is valid only when service_type is stUSPSPriorityMailInternational (84).

Possible values are as follows:

ValueDescription
poRetail (0) Retail
poCommercialPlus (1) Commercial Plus
poCommercialBase (2) Commercial Base (default)

prohibitions Property

List of items prohibited from mailing to the destination country.

Syntax

def get_prohibitions() -> str: ...

prohibitions = property(get_prohibitions, None)

Default Value

""

Remarks

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

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

This property is read-only.

proxy_auth_scheme Property

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

Syntax

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

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

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

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

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

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

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

proxy_auto_detect Property

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

Syntax

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

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

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

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

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

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

proxy_port Property

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

Syntax

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

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

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

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

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

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

psAutomatic (0)Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

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.

ValueMeaning
0x00000001 POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses.
0x00000002 Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial.

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.

Country NameCountry Code
Afghanistan AF
Albania AL
American Samoa AS
Andorra AD
Angola AO
Anguilla AI
Antigua AG*
Argentina AR
Armenia AM
Aruba AW
Australia AU
Austria AT
Azerbaijan AZ
Bahamas BS
Bahrain BH
Bangladesh BD
Barbados BB
Barbuda AG*
Belarus BY
Belgium BE
Belize BZ
Benin BJ
Bermuda BM
Bhutan BT
Bolivia BO
Bonaire AN**
Bosnia-Herzegovina BA
Botswana BW
Brazil BR
British Virgin IslandsVG*
Brunei BN
Bulgaria BG
Burkina Faso BF
Burundi BI
Cambodia KH
Cameroon CM
Canada CA
Canary Islands ES**
Cape Verde CV
Cayman Islands KY**
Chad TD
Channel Islands GB**
Chile CL
China CN
Colombia CO
Congo CG
Congo Dem. Rep. Of CD
Cook Islands CK
Costa Rica CR
Croatia HR
Curacao AN**
Cyprus CY
Czech Republic CZ
Denmark DK
Djibouti DJ
Dominica DM
Dominican Republic DO
East Timor TL
Ecuador EC
Egypt EG
El Salvador SV
England GB**
Equatorial Guinea GQ
Eritrea ER
Estonia EE
Ethiopia ET
Faeroe Islands FO*
Fiji FJ
Finland FI
France FR
French Guiana GF
French Polynesia PF**
Gabon GA
Gambia GM
Georgia GE
Germany DE
Ghana GH
Gibraltar GI
Grand Cayman KY**
Great Britain GB**
Great Thatch Island VG*
Great Tobago IslandsVG*
Greece GR
Greenland GL
Grenada GD
Guadeloupe GP**
Guam GU
Guatemala GT
Guinea GN
Guyana GY
Haiti HT
Holland NL**
Honduras HN
Hong Kong HK
Hungary HU
Iceland IS
India IN
Indonesia ID
Iraq IQ
Ireland IE
Israel IL
Italy IT**
Ivory Coast CI
Jamaica JM
Japan JP
Jordan JO
Jost Van Dyke IslandsVG*
Kazakhstan KZ
Kenya KE
Kuwait KW
Kyrgyzstan KG
Laos LA
Latvia LV
Lebanon LB
Lesotho LS
Liberia LR
Liechtenstein LI
Lithuania LT
Luxembourg LU
Macau MO
Macedonia MK
Madagascar MG
Malawi MW
Malaysia MY
Maldives MV
Mali ML
Malta MT
Marshall Islands MH
Martinique MQ
Mauritania MR
Mauritius MU
Mexico MX
Micronesia FM
Moldova MD
Monaco MC
Mongolia MN
Montserrat MS
Morocco MA
Mozambique MZ
Namibia NA
Nepal NP
Netherlands NL**
Netherlands AntillesAN**
New Caledonia NC
New Zealand NZ
Nicaragua NI
Niger NE
Nigeria NG
Norman Island VG*
Northern Ireland GB**
Northern Mariana IslandsMP**
Norway NO
Oman OM
Pakistan PK
Palau PW
Palestine PS*
Panama PA
Papua New Guinea PG
Paraguay PY
Peru PE
Philippines PH
Poland PL
Portugal PT
Puerto Rico PR
Qatar QA
Reunion RE
Romania RO
Rota MP**
Russia RU
Rwanda RW
Saba AN**
Saipan MP**
Samoa WS
San Marino IT**
Saudi Arabia SA
Scotland GB**
Senegal SN
Serbia & Montenegro CS
Seychelles SC
Singapore SG
Slovak Republic SK
Slovenia SI
South Africa ZA
South Korea KR
Spain ES**
Sri Lanka LK
St. Barthelemy GP**
St. Christopher KN**
St. Croix Island VI**
St. Eustatius AN**
St. John VI**
St. Kitts and Nevis KN**
St. Lucia LC
St. Maarten AN**
St. Thomas VI**
St. Vincent VC**
Suriname SR
Swaziland SZ
Sweden SE
Switzerland CH
Tahiti PF**
Taiwan TW
Tanzania TZ
Thailand TH
Tinian MP**
Togo TG
Tonga TO
Tortola Island VG*
Trinidad & Tobago TT
Tunisia TN
Turkey TR
Turkmenistan TM
Turks & Caicos IslandsTC
U.S. Virgin Islands VI**
Uganda UG
Ukraine UA
Union Island VC**
United Arab EmiratesAE
United Kingdom GB**
United States US
Uruguay UY
Uzbekistan UZ
Vanuatu VU
Vatican City IT**
Venezuela VE
Vietnam VN
Wales GB**
Wallis & Futuna IslandsWF
Yemen YE
Zambia ZM
Zimbabwe ZW

* Not supported by USPS

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

Country Name Country Code
Cayman Islands KY
French Polynesia PF
Guadeloupe GP
Italy IT
Netherlands NL
Netherlands Antilles AN
Northern Mariana Islands MP
Spain ES
St. Kitts and Nevis KN
St. Vincent VC
United Kingdom GB
U.S. Virgin Islands VI

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.

recipient_customs_reference Property

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

def get_recipient_customs_reference() -> str: ...
def set_recipient_customs_reference(value: str) -> None: ...

recipient_customs_reference = property(get_recipient_customs_reference, set_recipient_customs_reference)

Default Value

""

Remarks

This property may contain any reference number that the person wishes to use.

regulations Property

Additional regulations for shipping to the destination country.

Syntax

def get_regulations() -> str: ...

regulations = property(get_regulations, None)

Default Value

""

Remarks

Any additional regulations not covered under restrictions, observations, or prohibitions will be listed here after a successful transaction. The returned data might include information such as: country code, required Customs Forms, special notes when shipping certain items, areas served, etc.

This property is read-only.

restrictions Property

Restrictions on items being shipped based on country of destination.

Syntax

def get_restrictions() -> str: ...

restrictions = property(get_restrictions, None)

Default Value

""

Remarks

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

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

This property is read-only.

sdr_value Property

Special Drawing Right calculated on TotalValue .

Syntax

def get_sdr_value() -> str: ...

sdr_value = property(get_sdr_value, None)

Default Value

""

Remarks

The Special Drawing Right (SDR) is an artificial currency unit based on a collection of major world currencies. The sdr_value is the calculated total_value in this artificial currency.

This property is read-only.

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

sender_customs_reference Property

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

def get_sender_customs_reference() -> str: ...
def set_sender_customs_reference(value: str) -> None: ...

sender_customs_reference = property(get_sender_customs_reference, set_sender_customs_reference)

Default Value

""

Remarks

This property may contain any reference number that the person wishes to use.

service_type Property

The mail service type when shipping to the CountryCode .

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_package_label method is called.

Possible values are:

stUSPSExpressMailInternational (82)
stUSPSFirstClassMailInternational (83)
stUSPSPriorityMailInternational (84)
stUSPSFirstClassPackageInternationalService (87) (Endicia only)
stUSPSPriorityMailExpressInternational (88) (Endicia only)

ship_date Property

Date package will be mailed.

Syntax

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

ship_date = property(get_ship_date, set_ship_date)

Default Value

""

Remarks

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

This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.

Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.

This property is also returned after the following carrier pickup methods are called:

  • pickup_availability
  • schedule_pickup
  • change_pickup
  • pickup_inquiry
This indicates the date on which the packages will be picked up from the specified location.

shipment_special_services Property

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

Syntax

def get_shipment_special_services() -> int: ...
def set_shipment_special_services(value: int) -> None: ...

shipment_special_services = property(get_shipment_special_services, set_shipment_special_services)

Default Value

0

Remarks

To request any of the special services offered by USPS, you must set the shipment_special_services to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

Value Meaning
0x0000000000000004L COD
0x0000000000008000L Hold For Pickup
0x0000000008000000L Return Shipment
0x0000000080000000L Restricted Delivery
0x0000000100000000L Return Receipt
0x0000000200000000L Certificate Of Mailing
0x0000000400000000L Sunday and Holiday Delivery
0x0000000800000000L No Weekend
0x0000001000000000L Registered Mail
0x0000002000000000L Premium Service (Sunday/Holiday)
0x0000004000000000L Commercial
0x0000008000000000L Delivery Confirmation
0x0010000000000000L Electronic Return Receipt

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
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_value Property

Total value of all items being shipped.

Syntax

def get_total_value() -> str: ...

total_value = property(get_total_value, None)

Default Value

""

Remarks

This is the total value of all items in the package. It should match the sum of all individual commodity_unit_prices.

This property is read-only.

transaction_id Property

The transaction Id.

Syntax

def get_transaction_id() -> str: ...
def set_transaction_id(value: str) -> None: ...

transaction_id = property(get_transaction_id, set_transaction_id)

Default Value

""

Remarks

This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.

usps_account_number Property

The shipper's Endicia account number.

Syntax

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

usps_account_number = property(get_usps_account_number, set_usps_account_number)

Default Value

""

Remarks

The shipper's Endicia account number.

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

usps_password Property

Password to use for logging in to the USPS Server .

Syntax

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

usps_password = property(get_usps_password, set_usps_password)

Default Value

""

Remarks

Password to use for logging in to the USPS server.

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

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

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

usps_server Property

URL for the USPS server where the requests are sent.

Syntax

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

usps_server = property(get_usps_server, set_usps_server)

Default Value

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

Remarks

URL for the USPS server where the requests are sent.

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

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

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

Live Servers:

ServerUsed by
https://secure.shippingapis.com/ShippingAPI.dllUSPSAddress, USPSRates, USPSTrack USPSShip and USPSShipIntl

Test Servers:

ServerUsed by
https://secure.shippingapis.com/ShippingAPITest.dllUSPSAddress, USPSRates, USPSTrack USPSShip and USPSShipIntl

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

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

usps_user_id Property

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

Syntax

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

usps_user_id = property(get_usps_user_id, set_usps_user_id)

Default Value

""

Remarks

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

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

cancel_package Method

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

Syntax

def cancel_package(barcode_number: str) -> str: ...

Remarks

The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.

The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the package_tracking_number assigned to the package by USPS server when the get_package_label method was called.

If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.

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

Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.

Syntax

def get_package_label() -> None: ...

Remarks

When this method is called, the following properties are used to construct the request:

Please be aware of the maximum character amounts allowed for certain properties. If you enter more than those amounts, an error will not be generated; the API will simply pass in the characters up to the maximum amount allowed, and disregard the rest. This is important since the resulting value could prevent delivery.

This method fills the following properties:

If package_shipping_label_file was specified with a path and filename, all of the returned label images will also be saved to disk.

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class USPSShipIntl:
@property
def on_notification() -> Callable[[USPSShipIntlNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[USPSShipIntlNotificationEventParams], 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 USPSShipIntlSSLServerAuthenticationEventParams(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 USPSShipIntl:
@property
def on_ssl_server_authentication() -> Callable[[USPSShipIntlSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[USPSShipIntlSSLServerAuthenticationEventParams], 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 USPSShipIntlSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

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

USPSShipIntl Config Settings

ActionCode:   Use to specify the Action Code.

Use this config setting to specify the Action Code. The Value is included in the Shipping Partner Event file for customers who have chosen to have a Shipping Partner Event file submitted to USPS on their behalf.

Valid values are:

ValueMeaning
M0 Mailer Owner
S0 Service Provider

AddOnAggregate[i]:   Indicates the AddOn raw XML.

This configuration setting returns the raw xml of an AddOn in the list of available AddOns returned.

Valid index values are from 0 to AddOnCount - 1.

Note: This configuration setting is read-only and valid only for Stamps.com.

AddOnAmount[i]:   Indicates the AddOn amount.

This configuration setting indicates the amount of an AddOn in the list of available AddOns returned.

Valid index values are from 0 to AddOnCount - 1.

Note: This configuration setting is read-only and valid only for Stamps.com.

AddOnCount:   Total number of AddOns.

This configuration setting returns the total AddOn elements for each service.

Note: This configuration setting is read-only and valid only for Stamps.com.

AddOnType[i]:   Indicates the AddOn type.

This configuration setting indicates the AddOn type in the list of available AddOns returned.

Valid index values are from 0 to AddOnCount - 1.

Note: This configuration setting is valid only for Stamps.com.

AddOnTypeDescription[i]:   Indicates the AddOn description.

This configuration setting indicates the textual description of an AddOn in the list of available AddOns returned.

Valid index values are from 0 to AddOnCount - 1.

Note: This configuration setting is read-only and valid only for Stamps.com.

AddOnTypes:   The AddOn type to be requested.

This configuration setting is used to request specific AddOns.

This setting accepts multiple, comma separated, AddOns. For example: ship.Config("AddOnTypes=US-A-DC,US-A-SH");

Note: This configuration setting is read-only and valid only for Stamps.com.

Valid values are:

ValueMeaning
SC-A-HP Stamps.com Hidden Postage.
SC-A-INS Stamps.com Insurance.
SC-A-INSRM Stamps.com Insurance for Registered Mail
US-A-CM USPS Certified Mail
US-A-COD USPS Collect on Delivery
US-A-DC USPS Delivery Confirmation
US-A-ESH USPS Express - Sunday / Holiday Guaranteed
US-A-INS USPS Insurance
US-A-NDW USPS Express - No Delivery on Saturdays
US-A-RD USPS Restricted Delivery
US-A-REG USPS Registered Mail
US-A-RR USPS Return Receipt Requested
US-A-RRM USPS Return Receipt for Merchandise
US-A-SC USPS Signature Confirmation
US-A-SH USPS Special Handling
US-A-WDS USPS Express - Waive Delivery Signature
US-A-SR USPS Express - Signature Required
US-A-ESH USPS Sunday/Holiday Delivery Guaranteed
US-A-NND USPS Notice of non-delivery.
US-A-RRE USPS Electronic Return Receipt
US-A-LANS USPS Live Animal No Surcharge
US-A-LAWS USPS Live Animal with Surcharge
US-A-HM USPS Hazardous Materials
US-A-CR USPS Cremated Remains
US-A-1030 USPS Deliver Priority Mail Express by 10:30 am
US-A-ASR USPS Adult Signature Required
US-A-ASRD USPS Adult Signature Restricted Delivery

AltReturnAddress1:   Alternate return address 1.

Alternate Return Address Line 1. Valid only with the REDIRECT option (non_delivery_option set to "REDIRECT"). Six address lines are provided, but only 1 is required. Use as many as needed for a complete address. Maximum length: 30.

AltReturnAddress2:   Alternate return address 2.

Alternate Return Address Line 2. Valid only with the REDIRECT option (non_delivery_option set to "REDIRECT"). Six address lines are provided, but only 1 is required. Use as many as needed for complete address. Maximum length: 30.

AltReturnCountry:   Alternate return country.

Alternate Return Country. Valid only with the REDIRECT option (non_delivery_option set to "REDIRECT"). Maximum length: 30.

APOFPOServiceType:   APO/FPO Service Type for Military Mail and US territories (Except Puerto Rico and US Virgin Islands which are considered domestic).

Use this configuration setting to set a custom Service Type when shipping to Military Mail and US territories. If RecipientAPOFPOZip is set and the package weight is less than 13 ounces the default Service Type is stUSPSFirstClass. If package weight is more than 13 ounces the Service Type will switch to stUSPSPriority.

Valid values for USPS are:

stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSParcelSelect (79)
stUSPSCriticalMail (80)
stUSPSStandardMail (81)

Default Value: -1

Certify:   Certify/Test mode for label components.

If True a Certify request is sent instead of a regular production request. In this manner test labels may be created on a live server. The default value for this setting is False.

CommercialPrice:   Indicates whether the commercial price should be returned.

When set to true, the commercial price will be returned.

This is required to be true when using the package_type ptRegionalRateBoxA or ptRegionalRateBoxB

CommodityItemCode[i]:   Item code representing the commodity line item.

Item code representing the commodity line item. This configuration setting is required for DHL Global Mail.

Valid index values are from 0 to CommoditiesCount - 1.

CRID:   Customer Registration ID.

The Customer Registration ID (CRID) is provided to you by USPS. It is a unique number that identifies a specific location involved in a mailing. Customers must have a CRID in order to submit electronic documenation.

CustomerId2:   User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API.

You can set a value to CustomerId2 config setting as well as customer_id property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.

Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId2 value on the shipping label image if you set the PrintCustomerRefNo2 to True.

CustomsFormType:   The customs form type of the label.

This configuration is only valid when postage_provider has been set to ppEndicia. The default value for this setting is "1"

ValueMeaning
1 Form2976(Same as CN22)
2 Form2976A(Same as CP72)
CustomsSigner:   The name of the person certifying the customs information is correct.

This config should contain the name of the person who is certifying that the information conatined in the customs form is accurate.

Note this config only applies when using Endicia.

DeclaredValue:   The amount to declare.

This configuration setting is used to declare the amount of the shipment. This setting is required by Stamps.com for all international shipments.

Note: This configuration setting is valid only for Stamps.com.

DestinationRateIndicator:   Destination rate indicator for eVS International labels.

Use this config setting to specify the Destination Rate Indicator which is required for destination entry packages. Default value is "N" (None).

Valid values are:

ValueMeaning
I International Service Center (ISC)
N None

EELPFC:   Exemption and Exclusion Legend or PFC Code.

Use this configuration setting to indicate the Exemption and Exclusion Legend (EEL) or Proof of Filing Citation (PFC). For example:

class.Config("EELPFC=30.37a")

EndiciaHazMatDescription:   HazMat Description.

This specifies the dangerous goods categories.

The valid values are as follows:

ValueMeaning
01 Lithium metal batteries contained in equipment.
02 Lithium metal batteries packed with equipment.
03 Lithium metal batteries stand-alone.
04 Lithium-ion batteries contained in equipment.
05 Lithium-ion batteries packed with equipment.
06 Lithium-ion batteries stand-alone.
07 Lithium, for customers unable to split lithium identifiers (Primary and Secondary)
08 ORM-D
09 Small Quantity Provision

This is only valid when using Endicia's DHL consolidator services.

EndiciaHazMatPhone:   HazMat phone number.

This specifies the HazMat phone number.

This is only valid when using Endicia's DHL consolidator services.

EndiciaInsuranceType:   The Insurance type when using Endicia.

This will determine which type of insurance will be used when requesting a label through Endicia.

ValueMeaning
0 None (Default)
1 USPS Insurance
2 Endicia Insurance
3 USPS Online Insurance

Note that if this is set to None, and an insurance amount is provided, Endicia Insurance will be used.

EndiciaPrintConsolidatorLabel:   Used to request Consolidator Services.

When set to True, Endicia Label Server will generate USPS workshare labels for consolidators that partner with Endicia. The default value is false.

Note that your Endicia account must be first activated for Consolidator Services.

EndiciaTestMode:   Controls whether requests are test requests or live requests.

When set to a non-zero value the class will use a built-in sandbox account and set the TEST flag to "Yes" in the request itself. For all values this will automatically set usps_server as defined below.

0Live Requests to Production server (default)
1Test Requests to Sandbox server
2Test Requests to Production server
This setting only applies when postage_provider is set to ppEndicia.
EndiciaValidateAddress:   Defines if the address should be validated or not.

If True (default value) the sender_address and the recipient_address are validated. Set it to False if you wish to bypass the address validation.

This is only valid when using Endicia.

EntryFacility:   Postal facility where mail is entered.

This specifies the postal facility where the mail is to be entered. If this is not set to Other and the postal facility's zip code is different than your return address zip code (sender_zip_code), then you must specify a zip code in mailing_location

The valid values are as follows:

ValueMeaning
0 None (Default)
1 Destination BMC (DBMC)
2 Destination Delivery Unit (DDU)
3 Destination Sectional Center Facility (DSCF)
4 Origin BMC (OBMC)
5 Other

This is required when the service_type is set to either stParcelSelect or stStandardMail. Also, this is only valid when using Endicia.

EscapeEndiciaXML:   Whether to escape XML special characters when using Endicia.

When set to true, XML special characters will automatically be escaped when using Endicia. Default is false.

This is only valid when using Endicia.

HasXPath:   Determines whether a specific element exists in the document.

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath. This method returns True if the XPath exists, False if not.

HoldForManifest:   Holds manifest record for inclusion in SCAN request.

This feature is restricted to authorized users only. When True, it indicates that the manifest record should be held for possible inclusion in the SCAN request. Default is False.

ImageParameters:   For future use.

Setting a value to this configuration setting will fill the <ImageParameters> tag in a label request. The USPS does not support this functionality at this time.

ImportersReferenceType:   Importer's Reference Type for eVS International labels.

Use this config setting to specify the Importer's Reference Type. The Importer's Reference might be a tax code, VAT number, or importer code used for sales tax.

Possible values are:

ValueMeaning
0 Unassigned (Default)
1 TAXCODE
2 VAT
3 IMPORTERCODE

IncludePostage:   Used to determine if the postage will be printed on the label.

When set to true (default), the postage will be included on the label. Otherwise no postage will be printed on the label.

Note that when true, Stealth is also set to true so that the postage price will not be printed on the label.

This is only valid when using Endicia.

IntegratorTxId:   Stamps.com transaction integrator Id.

Every time get_package_label method is called a unique IntegratorTxId is generated. In case get_package_label method fails for some reason, this configuration setting can be used to repeat the call. Stamps.com checks if the IntegratorTxId has been used before. If it has been used, the service will treat the call as a replay and simply return the response of the initial call.

Note: This setting is valid only for Stamps.com.

LabelImageResolution:   The resolution of the label.

This configuration is only valid when postage_provider has been set to ppEndicia. The resolution for the image defaults to 300 DPI for domestic and international labels. For labels with the label_image_type set to sitEPL or sitZPL, the image resolution must be set to 203. The following values are valid:

ValueMeaning
0 Default
1 150 DPI
2 203 DPI
3 300 DPI
LabelImageRotation:   The rotation of the label.

This configuration is only valid when postage_provider has been set to ppEndicia. When label_image_type has been set to sitEPL or sitZPL, setting this configuration to 2 will print from the top of the image buffer. Selecting 0 will print from the bottom of the image buffer. Rotating 90 and 270 degrees are not valid for sitEPL or sitZPL image types. The following values are valid:

ValueMeaning
0 No rotation (Default).
1 Rotate label image 90 degrees.
2 Rotate label image 180 degrees.
3 Rotate label image 270 degrees.
LabelSize:   The size of the label.

This configuration is only valid when postage_provider has been set to ppEndicia or ppStamps. Set this to one of the following values to change the size of the label that is returned by the server.

Valid Values for Endicia:

ValueMeaning
0 4" W x 6" H (Default)
1 4" W x 5" H
2 4" W x 4.5" H
3 4" W x 6.75" H, Eltron Doc-Tab label
4 6" W x 4" H (not available for Express Mail, EPL2 and ZPLII labels)
5 7" W x 3" H
6 Dymo #30384 2-part internet label
7 #10 Envelope
8 7" W x 5" H
9 7" W x 4" H
10 8" W x 3" H
11 9" W x 6" H envelope
12 6" W x 4" H (4x6c, for International)
13 4" W x 8" H

Valid values for Stamps.com

ValueMeaning
0 Normal - A 4" x 6" label will be generated (Default)
1 NormalLeft - A 4" x 6" label will be generated on the left side of the page.
2 NormalRight - A 4" x 6" label be generated on the right side of the page.
3 Normal4X6 - A 4" x 6" label be generated on a 4" x 6" page.
4 Normal6X4 - A 6" x 4" label be generated on a 6" x 4" page.
5 Normal75X2 - A 7.5" x 2" label on a 7.5" x 2" page.
6 Normal4X675 - A label for 4" x 6 and 3/4" doc-tab will be generated.
7 NormalReceipt - A 4" x 6" label and receipt be generated.
8 Return - A 4" x 6" return label will be generated. Return labels do not have shipping date on them.
9 Return4X675 - A return label for 4" x 6 and 3/4" doc-tab will be generated.
10 NormalCN22 - A 4" x 6" label on 8.5" x 11" sheet with Customs Form CN 22 will be generated
11 NormalCP72 - A 4" x 6" label on 8.5" x 11" page with Customs Form CP 72 will be generated
12 Normal4X6CN22 - A 4" x 6" label on a 4" x 6" page with Customs Form CN 22 will be generated
13 Normal6X4CN22 - A 6" x 4" label on a 4" x 6" page with Customs Form CN 22 will be generated. This layout is not available for EPL and ZPL.
14 Normal4X6CP72 - A 4" x 6" label on a 4" x 6" page with Customs Form CP 72 will be generated.
15 Normal6X4CP72 - A 6" x 4" label on a 4" x 6" page with Customs Form CP 72 will be generated. This layout is not available for EPL and ZPL.
16 Normal4X675CN22 - A label with Customs Form CN 22 for 4" x 6 and 3/4" doc-tab will be generated.
17 Normal4X675CP72 - A label with Customs Form CP 72 for 4" x 6 and 3/4" doc-tab will be generated.
18 ReturnCN22 - A 4" x 6" return label with Customs Form CN 22 will be generated
19 ReturnCP72 - A 4" x 6" return label with Customs Form CP 72 will be generated.
20 Return4X675CN22 - A return label with Customs Form CN 22 for 4" x 6 and 3/4" doc-tab will be generated.
21 Return4X675CP72 - A return label with Customs Form CP 72 for 4" x 6 and 3/4" doc-tab will be generated.
22 Normal4X825 - A label for 4" x 8 and 1/4" doc-tab will be generated.
23 Return4X825 - A return label for 4" x 8 and 1/4" doc-tab will be generated.

LogisticsManagerMID:   Logistics Manager Mailer ID.

The Logistics Manager Mailer ID is the MID of the company that manages the mailing and it's assigned by USPS.

Note that if LogisticsManagerMID is populated, either CRID or MID must also be populated.

Memo:   Customer defined data to be printed on a Stamps shipping label.

This config is used to add a user-defined text (memo) to print at the bottom of the Stamps shipping label. The maximum number of characters is 150. For a single line memo, it will print in a single box. For a multi-line memo, the first two lines will be put into the two separate boxes of the label.

MeterPayment:   Meter payment indicator.

When set to true indicates Meter Payment. The default value is false.

Note that this only applies when service_type is stUSPSExpressMailInternational (82).

MID:   Mailer ID.

The Mailer Identifier (MID) is provided to you by USPS. MID is a field within the Intelligent Mail barcode that is used to identify mailers.

OptOutOfSPE:   Opt out of Shipping Partner Event file creation.

When True (default) allows a customer to opt out of SPE (Shipping Partner Event) file creation. Setting it to False will create a SPE file.

OtherContents:   Description of the contents.

If contents is set to ctOther, you may be required to set this configuration setting with a description of the contents. For example:

class.Contents = ctOther class.Config("OtherContents=Livestock")

Overwrite:   Determines whether label files will be overwritten.

If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist.

PackageLabelUrl:   Stams.com label Url.

This configuration setting is populated by Stamps.com after calling get_package_label when label_image_type is set to sitNone

Note: This configuration setting is read-only and valid only for Stamps.com.

PackageReference[i]:   Indicates the package reference type and value, that associates this package.

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

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

You can enter up to four customer references on package level by providing: the type(s) and value(s) in the request. 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 Reference should be set to: 'Ref1:123456; Ref2:123'.

PackageShippingLabelCount[i]:   Total number of labels and / or custom forms returned in the response for each package.

This configuration setting returns the Total number of labels and / or custom forms returned in the response for each package.

Note: This configuration setting is read-only.

Valid index values are from 0 to PackageCount - 1.

PackageShippingLabelIndex[i]:   Image of the shipping label returned by the Server upon a successful ship response for each package.

This configuration setting returns the Total number of labels and / or custom forms returned in the response.

Valid index values are from 0 to PackageShippingLabelCount[i]; - 1.

PackageSize[i]:   Indicates the package reference type and value, that associates this package.

This specifies the size of the package. The valid values are as follows:

Value Meaning Description
0 Regular All package dimensions are under 12 inches
1 Large All package dimensions are over 12 inches
POZipCode:   ZIP Code of Post Office.

This configuration setting is Required when EntryFacility is not set to Other. The value of this element must contain the ZIP Code of the postal facility specified in EntryFacility.

This is only valid when using Endicia.

RawRequest:   Contains the complete request sent to the Server.

This returns the complete request as sent to the server. Used for debugging purposes.

RawResponse:   Contains the complete response returned by the Server.

This returns the complete response as received from the server. Used for debugging purposes.

RecipientAddress3:   Recipient's address line 3.

Four address lines are provided: recipient_address1 recipient_address2 RecipientAddress3 and RecipientAddress4, but only recipient_address1 is required. Unlike the address fields for other classs, there are no restrictions as to what information can appear on each line. Use as many as needed for complete address.

Maximum length: 48.

RecipientAddress4:   Recipient's address line 4.

Four address lines are provided with shipping address, but only 1 is required. Use as many as needed for complete address.

Maximum Length: 48.

This is only used by customs forms.

RecipientAPOFPOZip:   APO/FPO ZIP code for Military Mail.

Use this configuration if the recipient address is an APO or FPO address entering the recipient APO/FPO ZIP code. Either a country name or an APO/FPO ZIP code value must be provided. Both values may not be provided.

Military addresses must show the grade, full name with middle name or initial, and PSC number, unit number, or ship name. In this case, replace the city name with "APO " or "FPO," and the state with "AA," "AE," or "AP,".

Use the recipient_address1, recipient_address2, RecipientAddress3, RecipientAddress4, properties and configurations for the recipient address.

If using Endicia you should use the recipient_city and recipient_state properties first. Do not enter a value for the recipient_country_code property as it will not be output onto the label.

Maximum Length: 5

RecipientAPOFPOZip4:   APO/FPO ZIP4 code for Military Mail.

Use this configuration in addition to RecipientAPOFPOZip when shipping to Military Mail. Items mailed to APO/FPO addresses may be returned unless the correct ZIP4 is submitted.

Maximum Length: 4

RecipientTaxId:   Tax Id for the recipient.

Tax Id for the recipient. This configuration setting is required for Parcel Direct products when recipient_country_code property is set to "BR" (Brazil).

RedirectAddress:   Redirect Address.

Enter the redirect address. This is a free form field. Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

Maximum Length: 48

RedirectCity:   Redirect City.

Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

Maximum Length: 21

RedirectEmail:   Redirect Email.

When using this config make sure to enter a complete valid e-mail address. Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

RedirectName:   Redirect Name.

Use this config to enter a value for the recipient's name. Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

RedirectSMS:   Redirect SMS.

This value must be a syntactically valid SMS number. Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

RedirectState:   Redirect State.

Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

Maximum Length: 2

RedirectZip4:   Redirect ZIP4 extension.

Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

Maximum Length: 4

RedirectZipCode:   Redirect ZIP Code.

Valid only with the REDIRECT option (non_delivery_option set to ndoRedirect).

Maximum Length: 5

RegisteredMailValue:   The value of registered mail sent in the request.

This configuration setting sets the value of registered mail sent in the request.

RequestId:   The ID used to identify a particular request/response pair when tracking Endicia packages.

This value is required for Endicia tracking requests, and is also returned in the tracking response.

This setting is only applicable when using Endicia as your postage provider.

RubberStamp1:   Customer defined data to be printed on label.

This contains the first set of user defined data that should be printed on the label. The maximum number of characters is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6 default label in EPL2 format can accommodate 26 or fewer characters.

This is only valid when using Endicia.

Note that Priority Mail Express and International labels will not print Rubber Stamp elements.

RubberStamp2:   Customer defined data to be printed on label.

This contains the second set of user defined data that should be printed on the label. The maximum number of characters is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6 default label in EPL2 format can accommodate 26 or fewer characters.

This is only valid when using Endicia.

Note that Priority Mail Express and International labels will not print Rubber Stamp elements.

RubberStamp3:   Customer defined data to be printed on label.

This contains the third set of user defined data that should be printed on the label. The maximum number of characters is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6 default label in EPL2 format can accommodate 26 or fewer characters.

This is only valid when using Endicia.

Note that Priority Mail Express and International labels will not print Rubber Stamp elements.

SCANFormImage:   Image of the PS Form 3152 or PS Form 5630.

Image of the SCAN Form retrieved upon a successful USPSCreateManifest request.

The SCAN Form image format can be specified via label_image_type. The only possible values are sitTIF (1) or sitPDF (3).

If the SCANFormImageFile is set to a valid path and filename, the form is also saved to disk in a label_image_type format.

SCANFormImageFile:   The location where the SCAN Form Image will be written.

This should contain the full path to where the SCAN Form Image will be written.

SCANFormNumber:   Returns the Form Number from the last succesful call to USPSCreateManifest.

SCANFormType:   Indicates the SCAN Form Type that should be returned when calling USPSCreateManifest.

The default value for this config is 0. Possible values are:

ValueDescription
0 None (default)
1 PS Form 3152 (Priority Mail Express Manifesting Certification)
2 PS Form 5630 (Shipment Confirmation Acceptance Notice)
SCANPackageBarcodes:   A list of Package Barcodes to include in the SCAN Request (create a manifest for).

Use this config before calling USPSCreateManifest. The value can be one or more Package Barcodes delimited with a semi-colon like this example: class.Config("SCANPackageBarcodes=9270190317997999997976;9270202901089817001111");

SenderUrbanization:   The Urbanization that the package is being shipped from.

The value of this property is optional. Use this property only when the sender's shipping address is in Puerto Rico. Zip Code prefixes 006 to 009, if area is so designated.

ShipTime:   Time package will be mailed.

This indicates the approximate time on which the packages will be tendered to Postal Service. It should be entered in HHmmss (24 hour) format, such as 143000.

Note: This is required when calling USPSCreateManifest.

SortType:   Sort level for applicable mail classes.

This specifies the sort level to be used.

The valid values are as follows:

ValueMeaning
0 None (Default)
1 BMC
2 Five Digit
3 Mixed BMC
4 Non-Presorted
5 Presorted
6 SCF
7 Single Piece
8 Three Digit

This is required when the service_type is set to either stParcelSelect or stStandardMail. Also, this is only valid when using Endicia.

StampsAPIVersion:   Controls the API version used for requests.

This configuration setting sets instructs the component to work with a specific Stamps.com API version. Available versions are detailed below.

0v45
1v75

There is no need to additionally set usps_server when using Stamps.com. The correct server will be used automatically.

StampsCreateManifest:   Sends a request to create a manifest for the specified shipments.

When called, the component will make a request to create a manifest for the shipments specified in StampsCreateManifestIdentifier. If StampsCreateManifestIdentifier is not set, the manifest will be created for shipments using the value in ship_date. The manifest will be returned as a string containing a URL. Here is a short C# example. // Using v71 of Stamps.com's API is required. A different URL needs to be used. uspsship.USPSAccount.Server = "https://swsim.testing.stamps.com/swsim/swsimv71.asmx"; uspsship.Config("StampsCreateManifestIdentifierType=1"); // For StampsTxIds uspsship.Config("StampsCreateManifestIdentifier=267046ae-ca90-4fef-a826-23955fab17e1;a5ed206d-d840-4a40-b314-93021391d9d0;ee1dbee9-809d-422a-9502-ee9756163619"); string manifestURL = uspsship.Config("StampsCreateManifest"); This operation requires a newer version of the API. Please use the appropriate server URL from below when calling StampsCreateManifest.

Staging: https://swsim.testing.stamps.com/swsim/swsimv71.asmx
Production: https://swsim.stamps.com/swsim/swsimv71.asmx
StampsCreateManifestId:   Returns the ManifestId from the last succesful call to StampsCreateManifest.

StampsCreateManifestIdentifier:   A list of identifiers to create a manifest for.

Set this config to one of the following:

  • A single Ship Date
  • One or more StampsTxIds
  • One or more TrackingNumbers
StampsTxIds and TrackingNumbers must be delimited with a semi-colon like this example: uspsship.Config("StampsCreateManifestIdentifier=267046ae-ca90-4fef-a826-23955fab17e1;a5ed206d-d840-4a40-b314-93021391d9d0;ee1dbee9-809d-422a-9502-ee9756163619"); A Ship Date should follow this format: YYYY-MM-DD.
StampsCreateManifestIdentifierType:   Used to indicate the type of identifier used.

Set this to the type of identifier used in StampsCreateManifestIdentifier. Possible values include:

0Ship Date (default)
1StampsTxIds
2TrackingNumbers
StampsTestMode:   Controls whether requests are test requests or live requests.

When set to 0 the class will send requests to Stamps.com's production server using the account specified in usps_account. When set to 1 the class will send requests to Stamps.com's sandbox server using a built-in sandbox account. There is no need to set usps_server in either case.

This setting only applies when postage_provider is set to ppStamps.

The default value is 0.

StampsTxId:   Stamps.com transaction identifier.

This configuration setting is returned by Stamps.com after calling get_package_label This setting can be used later by USPSMgr class to refund a transaction.

Note: This configuration setting is read-only and valid only for Stamps.com.

UseInsurance:   Specifies whether or not to request insurance.

When set to true (default), the component will request that the package be insured when the package_insured_value is set and the service_type is stUSPSPriorityMailInternational (84) . If false, then insurance will not be requested, however the value in package_insured_value will still be printed on the label.

Note that this only applies when service_type is stUSPSPriorityMailInternational (84) .

UseStealth:   Used to determine if the postage price is printed on the label.

When this is set to true (default), the postage price will not be printed on the label.

Note: Stealth cannot be used with COD, USPS Insurance, Registered Mail, Automation rate, LabelSize of EnvelopeSize10 and Card shape mailpieces.

This is only valid when using Endicia.

USPSCreateManifest:   Sends a SCAN request to create a manifest for the specified shipments.

When called, the component will make a request to create a manifest. This is only applicable when using USPS as your postage provider (in other words postage_provider is set to ppNone).

To create a manifest for one or more packages set the SCANPackageBarcodes config to a list of package barcodes and ship_date property as well before calling USPSCreateManifest. For example: class.Config("SCANFormType=1"); // 1-PS Form 3152, 2-PS Form 5630 class.Config("SCANPackageBarcodes=9270190317997999997976;9270202901089817001111"); class.ShipDate = "06/24/2022"; class.Config("USPSCreateManifest"); To create a manifest for shipments created in a certain date use the ship_date property only before calling USPSCreateManifest. For example: class.Config("SCANFormType=1"); // 1-PS Form 3152, 2-PS Form 5630 class.ShipDate = "06/24/2022"; class.Config("USPSCreateManifest"); If neither SCANPackageBarcodes nor ship_date is set, the manifest will be created for ALL shipments. class.Config("SCANFormType=1"); // 1-PS Form 3152, 2-PS Form 5630 class.Config("USPSCreateManifest");

Note: In order for the Shipping Labels to be eligible for inclusion in a SCAN Form you have to set HoldForManifest to true when creating labels using get_package_label method.

VendorCode:   Vendor Code to identify the developer of the shipping system.

Use this config setting to set the Software Vendor Code to identify the developer of the shipping/manifesting system when using the eVS label API.

VendorProductVersionNumber:   Vendor Product Version Number.

Use this config setting to set the shipping Software's Product Version Number when using the eVS label API.

XAttrCount:   The number of records in the XAttr arrays.

This property controls the size of the following arrays:

XAttrName[i]:   The name of the indexed attribute.

The size of the array is controlled by XAttrCount.

XAttrValue[i]:   The value of the indexed attribute.

The size of the array is controlled by XAttrCount.

XChildCount:   The number of records in the XChild arrays.

This property controls the size of the following arrays:

XChildElement[i]:   The name of the indexed child element.

The size of the array is controlled by XChildCount.

XChildText[i]:   The text of the indexed child element.

The size of the array is controlled by XChildCount.

XElement:   The name of the current element.

The current element is specified via the XPath.

XParent:   The parent of the current element.

The current element is specified via the XPath.

XPath:   Used to set the XPath within the response from the server.

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the RawResponse. XPath is 1-indexed. The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. The following are possible values for an element accessor:

'name' A particular element name
name[i] The i-th subelement of the current element with the given name
[i] The i-th subelement of the current element
[last()] The last subelement of the current element
[last()-i] The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"] The subelement containing a particular value for a given attribute (supports single AND double quotes)
.. The parent of the current element
When XPath is set to a valid path...
XText:   The text of the current element.

The current element is specified via the XPath.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and proxy_auto_detect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when ssl_provider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

USPSShipIntl Errors

USPSShipIntl Errors

301   Operation interrupted (or timeout).
432   Invalid index.
527   Server Error Response.
528   Property set with invalid data.
529   Bad Label Format. (Possibly corrupt encoding)

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

SOAP Errors

169   Invalid param index (out of range).
170   Invalid namespace index (out of range).
171   method not found. Please specify a valid method.
172   No method URI. Please specify a valid method_uri.
173   SOAP Fault. See fault_code and/or fault_string for details.

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

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in url
153   Specified url_scheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open attached_file.

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

TCPClient Errors

100   You cannot change the remote_port at this time. A connection is in progress.
101   You cannot change the remote_host (Server) at this time. A connection is in progress.
102   The remote_host address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the local_port at this time. A connection is in progress.
107   You cannot change the local_host at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   remote_port cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

XML Errors

101   Invalid attribute index.
102   No attributes available.
103   Invalid namespace index.
104   No namespaces available.
105   Invalid element index.
106   No elements available.
107   Attribute does not exist.
201   Unbalanced element tag.
202   Unknown element prefix (can't find namespace).
203   Unknown attribute prefix (can't find namespace).
204   Invalid XML markup.
205   Invalid end state for parser.
206   Document contains unbalanced elements.
207   Invalid xpath.
208   No such child.
209   Top element does not match start of path.
210   DOM tree unavailable (set build_dom to true and reparse).
302   Can't open file.
401   Invalid XML would be generated.
402   An invalid XML name has been specified.