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

USPSShipIntl

Remarks

Generating a shipping label can be done by calling the GetPackageLabel 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

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

• Set PostageProvider to ppNone (default).
• Set USPSUserId to the UserId provided by USPS.
• Set USPSPassword to the password provided by USPS.
• Set USPSServer to either the test or production server.

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

Production

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

• Set PostageProvider to ppEndicia.
• Set USPSAccountNumber to your production account number (provided by Endicia).
• Set USPSPassword to your production password (provided by Endicia).

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

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

ppStamps

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

• Set PostageProvider to ppStamps.
• Set USPSUserId to the sandbox or production user provided by Stamps.com.
• Set USPSAccountNumber to the sandbox or production account number provided by Stamps.com.
• Set USPSPassword to the sandbox or production password provided by Stamps.com.
• Set USPSServer to either the test or production server.

Property List

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

Method List

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

Event List

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

Config Settings

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

BarcodeNumber Property (USPSShipIntl Class)

Barcode number associated with label's barcode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBarcodeNumber();

Unicode (Windows)
LPWSTR GetBarcodeNumber();

char* dshippingsdk_uspsshipintl_getbarcodenumber(void* lpObj);

QString GetBarcodeNumber();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CertificateNumber Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertificateNumber();
int SetCertificateNumber(const char* lpszCertificateNumber);

Unicode (Windows)
LPWSTR GetCertificateNumber();
INT SetCertificateNumber(LPCWSTR lpszCertificateNumber);

char* dshippingsdk_uspsshipintl_getcertificatenumber(void* lpObj);
int dshippingsdk_uspsshipintl_setcertificatenumber(void* lpObj, const char* lpszCertificateNumber);

QString GetCertificateNumber();
int SetCertificateNumber(QString qsCertificateNumber);

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.

Data Type

String

Comments Property (USPSShipIntl Class)

Comments on the package being shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetComments();
int SetComments(const char* lpszComments);

Unicode (Windows)
LPWSTR GetComments();
INT SetComments(LPCWSTR lpszComments);

char* dshippingsdk_uspsshipintl_getcomments(void* lpObj);
int dshippingsdk_uspsshipintl_setcomments(void* lpObj, const char* lpszComments);

QString GetComments();
int SetComments(QString qsComments);

Default Value

""

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

Data Type

String

CommodityCount Property (USPSShipIntl Class)

The number of records in the Commodity arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Unicode (Windows)
INT GetCommodityCount();
INT SetCommodityCount(INT iCommodityCount);

int dshippingsdk_uspsshipintl_getcommoditycount(void* lpObj);
int dshippingsdk_uspsshipintl_setcommoditycount(void* lpObj, int iCommodityCount);

int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityHarmonizedCode
• CommodityManufacturer
• CommodityQuantity
• CommodityValue
• CommodityWeight

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

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (USPSShipIntl Class)

Complete and accurate description of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityDescription(int iCommodityIndex);
int SetCommodityDescription(int iCommodityIndex, const char* lpszCommodityDescription);

Unicode (Windows)
LPWSTR GetCommodityDescription(INT iCommodityIndex);
INT SetCommodityDescription(INT iCommodityIndex, LPCWSTR lpszCommodityDescription);

char* dshippingsdk_uspsshipintl_getcommoditydescription(void* lpObj, int commodityindex);
int dshippingsdk_uspsshipintl_setcommoditydescription(void* lpObj, int commodityindex, const char* lpszCommodityDescription);

QString GetCommodityDescription(int iCommodityIndex);
int SetCommodityDescription(int iCommodityIndex, QString qsCommodityDescription);

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 CommodityDescription has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityHarmonizedCode Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityHarmonizedCode(int iCommodityIndex);
int SetCommodityHarmonizedCode(int iCommodityIndex, const char* lpszCommodityHarmonizedCode);

Unicode (Windows)
LPWSTR GetCommodityHarmonizedCode(INT iCommodityIndex);
INT SetCommodityHarmonizedCode(INT iCommodityIndex, LPCWSTR lpszCommodityHarmonizedCode);

char* dshippingsdk_uspsshipintl_getcommodityharmonizedcode(void* lpObj, int commodityindex);
int dshippingsdk_uspsshipintl_setcommodityharmonizedcode(void* lpObj, int commodityindex, const char* lpszCommodityHarmonizedCode);

QString GetCommodityHarmonizedCode(int iCommodityIndex);
int SetCommodityHarmonizedCode(int iCommodityIndex, QString qsCommodityHarmonizedCode);

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 CommodityDescription, 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 CommodityHarmonizedCode 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 TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityManufacturer Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityManufacturer(int iCommodityIndex);
int SetCommodityManufacturer(int iCommodityIndex, const char* lpszCommodityManufacturer);

Unicode (Windows)
LPWSTR GetCommodityManufacturer(INT iCommodityIndex);
INT SetCommodityManufacturer(INT iCommodityIndex, LPCWSTR lpszCommodityManufacturer);

char* dshippingsdk_uspsshipintl_getcommoditymanufacturer(void* lpObj, int commodityindex);
int dshippingsdk_uspsshipintl_setcommoditymanufacturer(void* lpObj, int commodityindex, const char* lpszCommodityManufacturer);

QString GetCommodityManufacturer(int iCommodityIndex);
int SetCommodityManufacturer(int iCommodityIndex, QString qsCommodityManufacturer);

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 CommodityManufacturer 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 CommodityManufacturer and CommodityDescription are required to be provided in the request. If the CommodityManufacturer 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 CommodityManufacturer 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 PostageProvider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.).

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

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

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityQuantity Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityQuantity(int iCommodityIndex);
int SetCommodityQuantity(int iCommodityIndex, int iCommodityQuantity);

Unicode (Windows)
INT GetCommodityQuantity(INT iCommodityIndex);
INT SetCommodityQuantity(INT iCommodityIndex, INT iCommodityQuantity);

int dshippingsdk_uspsshipintl_getcommodityquantity(void* lpObj, int commodityindex);
int dshippingsdk_uspsshipintl_setcommodityquantity(void* lpObj, int commodityindex, int iCommodityQuantity);

int GetCommodityQuantity(int iCommodityIndex);
int SetCommodityQuantity(int iCommodityIndex, int iCommodityQuantity);

Default Value

1

Remarks

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

For FedEx, if the Documents is set to False in ship request, the CommodityQuantity 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 CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityValue Property (USPSShipIntl Class)

The value of an individual item being shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityValue(int iCommodityIndex);
int SetCommodityValue(int iCommodityIndex, const char* lpszCommodityValue);

Unicode (Windows)
LPWSTR GetCommodityValue(INT iCommodityIndex);
INT SetCommodityValue(INT iCommodityIndex, LPCWSTR lpszCommodityValue);

char* dshippingsdk_uspsshipintl_getcommodityvalue(void* lpObj, int commodityindex);
int dshippingsdk_uspsshipintl_setcommodityvalue(void* lpObj, int commodityindex, const char* lpszCommodityValue);

QString GetCommodityValue(int iCommodityIndex);
int SetCommodityValue(int iCommodityIndex, QString qsCommodityValue);

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 CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityWeight Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityWeight(int iCommodityIndex);
int SetCommodityWeight(int iCommodityIndex, const char* lpszCommodityWeight);

Unicode (Windows)
LPWSTR GetCommodityWeight(INT iCommodityIndex);
INT SetCommodityWeight(INT iCommodityIndex, LPCWSTR lpszCommodityWeight);

char* dshippingsdk_uspsshipintl_getcommodityweight(void* lpObj, int commodityindex);
int dshippingsdk_uspsshipintl_setcommodityweight(void* lpObj, int commodityindex, const char* lpszCommodityWeight);

QString GetCommodityWeight(int iCommodityIndex);
int SetCommodityWeight(int iCommodityIndex, QString qsCommodityWeight);

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 CommodityWeight 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 PostageProvider 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 PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

Contents Property (USPSShipIntl Class)

Type of the contents in the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContents();
int SetContents(int iContents);

Unicode (Windows)
INT GetContents();
INT SetContents(INT iContents);

CT_SAMPLE(0), 
CT_GIFT(1), 
CT_DOCUMENTS(2), 
CT_RETURN(3), 
CT_OTHER(4), 
CT_MERCHANDISE(5), 
CT_HUMANITARIAN_DONATION(6), 
CT_DANGEROUS_GOODS(7), 
CT_CREMATED_REMAINS(8), 
CT_NON_NEGOTIABLE_DOCUMENT(9), 
CT_PHARMACEUTICALS(10), 
CT_MEDICAL_SUPPLIES(11), 
CT_HAZMAT(12), 
CT_LIVES(13), 
CT_PERISHABLE(14)

int dshippingsdk_uspsshipintl_getcontents(void* lpObj);
int dshippingsdk_uspsshipintl_setcontents(void* lpObj, int iContents);

int GetContents();
int SetContents(int iContents);

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:

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

Data Type

Integer

CustomerId Property (USPSShipIntl Class)

User-assigned number for internal use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId);

Unicode (Windows)
LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);

char* dshippingsdk_uspsshipintl_getcustomerid(void* lpObj);
int dshippingsdk_uspsshipintl_setcustomerid(void* lpObj, const char* lpszCustomerId);

QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);

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.

Data Type

String

ExtraServices Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetExtraServices();
int SetExtraServices(int64 lExtraServices);

Unicode (Windows)
LONG64 GetExtraServices();
INT SetExtraServices(LONG64 lExtraServices);

int64 dshippingsdk_uspsshipintl_getextraservices(void* lpObj);
int dshippingsdk_uspsshipintl_setextraservices(void* lpObj, int64 lExtraServices);

qint64 GetExtraServices();
int SetExtraServices(qint64 lExtraServices);

Default Value

0

Remarks

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

Data Type

Long64

FirewallAutoDetect Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int dshippingsdk_uspsshipintl_getfirewallautodetect(void* lpObj);
int dshippingsdk_uspsshipintl_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (USPSShipIntl Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int dshippingsdk_uspsshipintl_getfirewalltype(void* lpObj);
int dshippingsdk_uspsshipintl_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (USPSShipIntl Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* dshippingsdk_uspsshipintl_getfirewallhost(void* lpObj);
int dshippingsdk_uspsshipintl_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost 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.

Data Type

String

FirewallPassword Property (USPSShipIntl Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* dshippingsdk_uspsshipintl_getfirewallpassword(void* lpObj);
int dshippingsdk_uspsshipintl_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (USPSShipIntl Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int dshippingsdk_uspsshipintl_getfirewallport(void* lpObj);
int dshippingsdk_uspsshipintl_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (USPSShipIntl Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* dshippingsdk_uspsshipintl_getfirewalluser(void* lpObj);
int dshippingsdk_uspsshipintl_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

ImageLayout Property (USPSShipIntl Class)

Determines how the labels will be formatted for printing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetImageLayout();
int SetImageLayout(int iImageLayout);

Unicode (Windows)
INT GetImageLayout();
INT SetImageLayout(INT iImageLayout);

IL_ONE_PER_FILE(0), 
IL_ALL_IN_ONE_FILE(1), 
IL_TRIM_ONE_PER_FILE(2), 
IL_TRIM_ALL_IN_ONE_FILE(3)

int dshippingsdk_uspsshipintl_getimagelayout(void* lpObj);
int dshippingsdk_uspsshipintl_setimagelayout(void* lpObj, int iImageLayout);

int GetImageLayout();
int SetImageLayout(int iImageLayout);

Default Value

0

Remarks

The LabelImageType property indicates the file type of the label that USPS returns. ImageLayout 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:

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

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

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

Data Type

Integer

ImportersEmail Property (USPSShipIntl Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImportersEmail();
int SetImportersEmail(const char* lpszImportersEmail);

Unicode (Windows)
LPWSTR GetImportersEmail();
INT SetImportersEmail(LPCWSTR lpszImportersEmail);

char* dshippingsdk_uspsshipintl_getimportersemail(void* lpObj);
int dshippingsdk_uspsshipintl_setimportersemail(void* lpObj, const char* lpszImportersEmail);

QString GetImportersEmail();
int SetImportersEmail(QString qsImportersEmail);

Default Value

""

Remarks

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

Data Type

String

ImportersFax Property (USPSShipIntl Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImportersFax();
int SetImportersFax(const char* lpszImportersFax);

Unicode (Windows)
LPWSTR GetImportersFax();
INT SetImportersFax(LPCWSTR lpszImportersFax);

char* dshippingsdk_uspsshipintl_getimportersfax(void* lpObj);
int dshippingsdk_uspsshipintl_setimportersfax(void* lpObj, const char* lpszImportersFax);

QString GetImportersFax();
int SetImportersFax(QString qsImportersFax);

Default Value

""

Remarks

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

Data Type

String

ImportersPhone Property (USPSShipIntl Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImportersPhone();
int SetImportersPhone(const char* lpszImportersPhone);

Unicode (Windows)
LPWSTR GetImportersPhone();
INT SetImportersPhone(LPCWSTR lpszImportersPhone);

char* dshippingsdk_uspsshipintl_getimportersphone(void* lpObj);
int dshippingsdk_uspsshipintl_setimportersphone(void* lpObj, const char* lpszImportersPhone);

QString GetImportersPhone();
int SetImportersPhone(QString qsImportersPhone);

Default Value

""

Remarks

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

Data Type

String

IndemnityCoverage Property (USPSShipIntl Class)

Indicates the indemnity coverage for the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIndemnityCoverage();

Unicode (Windows)
LPWSTR GetIndemnityCoverage();

char* dshippingsdk_uspsshipintl_getindemnitycoverage(void* lpObj);

QString GetIndemnityCoverage();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

InsurancePolicy Property (USPSShipIntl Class)

Insurance number, if known.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInsurancePolicy();
int SetInsurancePolicy(const char* lpszInsurancePolicy);

Unicode (Windows)
LPWSTR GetInsurancePolicy();
INT SetInsurancePolicy(LPCWSTR lpszInsurancePolicy);

char* dshippingsdk_uspsshipintl_getinsurancepolicy(void* lpObj);
int dshippingsdk_uspsshipintl_setinsurancepolicy(void* lpObj, const char* lpszInsurancePolicy);

QString GetInsurancePolicy();
int SetInsurancePolicy(QString qsInsurancePolicy);

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.

Data Type

String

InvoiceNumber Property (USPSShipIntl Class)

Invoice number if known or included in the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber);

Unicode (Windows)
LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);

char* dshippingsdk_uspsshipintl_getinvoicenumber(void* lpObj);
int dshippingsdk_uspsshipintl_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);

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 PackageType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

Data Type

String

LabelImageType Property (USPSShipIntl Class)

Type of label image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Unicode (Windows)
INT GetLabelImageType();
INT SetLabelImageType(INT iLabelImageType);

SIT_NONE(0), 
SIT_TIF(1), 
SIT_JPG(2), 
SIT_PDF(3), 
SIT_GIF(4), 
SIT_EPL(5), 
SIT_PNG(6), 
SIT_ZPL(7), 
SIT_PDFVECTOR(8), 
SIT_PDFVECTOR_WITH_FONTS(9), 
SIT_AZPL(10)

int dshippingsdk_uspsshipintl_getlabelimagetype(void* lpObj);
int dshippingsdk_uspsshipintl_setlabelimagetype(void* lpObj, int iLabelImageType);

int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Default Value

0

Remarks

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

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)

Data Type

Integer

LicenseNumber Property (USPSShipIntl Class)

Import License number if known, or included in package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLicenseNumber();
int SetLicenseNumber(const char* lpszLicenseNumber);

Unicode (Windows)
LPWSTR GetLicenseNumber();
INT SetLicenseNumber(LPCWSTR lpszLicenseNumber);

char* dshippingsdk_uspsshipintl_getlicensenumber(void* lpObj);
int dshippingsdk_uspsshipintl_setlicensenumber(void* lpObj, const char* lpszLicenseNumber);

QString GetLicenseNumber();
int SetLicenseNumber(QString qsLicenseNumber);

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.

Data Type

String

Machinable Property (USPSShipIntl Class)

Indicates if shipment is machinable or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMachinable();
int SetMachinable(int iMachinable);

Unicode (Windows)
INT GetMachinable();
INT SetMachinable(INT iMachinable);

MO_TRUE(0), 
MO_FALSE(1), 
MO_IRREGULAR(2)

int dshippingsdk_uspsshipintl_getmachinable(void* lpObj);
int dshippingsdk_uspsshipintl_setmachinable(void* lpObj, int iMachinable);

int GetMachinable();
int SetMachinable(int iMachinable);

Default Value

0

Remarks

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

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

Possible values are as follows:

Data Type

Integer

MailingLocation Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailingLocation();
int SetMailingLocation(const char* lpszMailingLocation);

Unicode (Windows)
LPWSTR GetMailingLocation();
INT SetMailingLocation(LPCWSTR lpszMailingLocation);

char* dshippingsdk_uspsshipintl_getmailinglocation(void* lpObj);
int dshippingsdk_uspsshipintl_setmailinglocation(void* lpObj, const char* lpszMailingLocation);

QString GetMailingLocation();
int SetMailingLocation(QString qsMailingLocation);

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 (SenderZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

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

This property is not applicable for International First Class mail.

Data Type

String

NonDeliveryOption Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNonDeliveryOption();
int SetNonDeliveryOption(int iNonDeliveryOption);

Unicode (Windows)
INT GetNonDeliveryOption();
INT SetNonDeliveryOption(INT iNonDeliveryOption);

NDO_RETURN(0), 
NDO_REDIRECT(1), 
NDO_ABANDON(2)

int dshippingsdk_uspsshipintl_getnondeliveryoption(void* lpObj);
int dshippingsdk_uspsshipintl_setnondeliveryoption(void* lpObj, int iNonDeliveryOption);

int GetNonDeliveryOption();
int SetNonDeliveryOption(int iNonDeliveryOption);

Default Value

0

Remarks

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

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

Data Type

Integer

Notes Property (USPSShipIntl Class)

Additional information returned by the USPS Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotes();

Unicode (Windows)
LPWSTR GetNotes();

char* dshippingsdk_uspsshipintl_getnotes(void* lpObj);

QString GetNotes();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

Observations Property (USPSShipIntl Class)

Additional mailing information based on country of destination.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObservations();

Unicode (Windows)
LPWSTR GetObservations();

char* dshippingsdk_uspsshipintl_getobservations(void* lpObj);

QString GetObservations();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

PackageCount Property (USPSShipIntl Class)

The number of records in the Package arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCount();
int SetPackageCount(int iPackageCount);

Unicode (Windows)
INT GetPackageCount();
INT SetPackageCount(INT iPackageCount);

int dshippingsdk_uspsshipintl_getpackagecount(void* lpObj);
int dshippingsdk_uspsshipintl_setpackagecount(void* lpObj, int iPackageCount);

int GetPackageCount();
int SetPackageCount(int iPackageCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageCODAmount
• PackageCODType
• PackageDescription
• PackageGirth
• PackageHeight
• PackageId
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSize
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageCODAmount Property (USPSShipIntl Class)

The COD monetary value for the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, const char* lpszPackageCODAmount);

Unicode (Windows)
LPWSTR GetPackageCODAmount(INT iPackageIdx);
INT SetPackageCODAmount(INT iPackageIdx, LPCWSTR lpszPackageCODAmount);

char* dshippingsdk_uspsshipintl_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagecodamount(void* lpObj, int packageidx, const char* lpszPackageCODAmount);

QString GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, QString qsPackageCODAmount);

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

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

For UPS, if the PackageCODAmount 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 PackageCODType. 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 PackageType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by PackageSignatureType) 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageCODType Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

Unicode (Windows)
INT GetPackageCODType(INT iPackageIdx);
INT SetPackageCODType(INT iPackageIdx, INT iPackageCODType);

CODTP_ANY(0), 
CODTP_CASH(1), 
CODTP_GUARANTEED_FUNDS(2), 
CODTP_COMPANY_CHECK(3), 
CODTP_PERSONAL_CHECK(4)

int dshippingsdk_uspsshipintl_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagecodtype(void* lpObj, int packageidx, int iPackageCODType);

int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

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., PackageCODAmount is set to a value other than "0.00").

Valid values are:

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

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

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageDescription Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, const char* lpszPackageDescription);

Unicode (Windows)
LPWSTR GetPackageDescription(INT iPackageIdx);
INT SetPackageDescription(INT iPackageIdx, LPCWSTR lpszPackageDescription);

char* dshippingsdk_uspsshipintl_getpackagedescription(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagedescription(void* lpObj, int packageidx, const char* lpszPackageDescription);

QString GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, QString qsPackageDescription);

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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageGirth Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageGirth(int iPackageIdx);
int SetPackageGirth(int iPackageIdx, int iPackageGirth);

Unicode (Windows)
INT GetPackageGirth(INT iPackageIdx);
INT SetPackageGirth(INT iPackageIdx, INT iPackageGirth);

int dshippingsdk_uspsshipintl_getpackagegirth(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagegirth(void* lpObj, int packageidx, int iPackageGirth);

int GetPackageGirth(int iPackageIdx);
int SetPackageGirth(int iPackageIdx, int iPackageGirth);

Default Value

0

Remarks

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

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

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth 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 PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight 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 PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageHeight Property (USPSShipIntl Class)

The height of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

Unicode (Windows)
INT GetPackageHeight(INT iPackageIdx);
INT SetPackageHeight(INT iPackageIdx, INT iPackageHeight);

int dshippingsdk_uspsshipintl_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackageheight(void* lpObj, int packageidx, int iPackageHeight);

int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the PackageHeight is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageWidth 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 PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set). For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth 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 PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageId Property (USPSShipIntl Class)

An 8-digit Unique Parcel Identification Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, const char* lpszPackageId);

Unicode (Windows)
LPWSTR GetPackageId(INT iPackageIdx);
INT SetPackageId(INT iPackageIdx, LPCWSTR lpszPackageId);

char* dshippingsdk_uspsshipintl_getpackageid(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackageid(void* lpObj, int packageidx, const char* lpszPackageId);

QString GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, QString qsPackageId);

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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageInsuredValue Property (USPSShipIntl Class)

Amount of insurance requested for this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, const char* lpszPackageInsuredValue);

Unicode (Windows)
LPWSTR GetPackageInsuredValue(INT iPackageIdx);
INT SetPackageInsuredValue(INT iPackageIdx, LPCWSTR lpszPackageInsuredValue);

char* dshippingsdk_uspsshipintl_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackageinsuredvalue(void* lpObj, int packageidx, const char* lpszPackageInsuredValue);

QString GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, QString qsPackageInsuredValue);

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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageLength Property (USPSShipIntl Class)

The length of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

Unicode (Windows)
INT GetPackageLength(INT iPackageIdx);
INT SetPackageLength(INT iPackageIdx, INT iPackageLength);

int dshippingsdk_uspsshipintl_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagelength(void* lpObj, int packageidx, int iPackageLength);

int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the PackageLength is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageWidth and PackageHeight 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 PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) 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 PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, the PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth 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 PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageNetCharge Property (USPSShipIntl Class)

Actual Net Charge applicable to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, const char* lpszPackageNetCharge);

Unicode (Windows)
LPWSTR GetPackageNetCharge(INT iPackageIdx);
INT SetPackageNetCharge(INT iPackageIdx, LPCWSTR lpszPackageNetCharge);

char* dshippingsdk_uspsshipintl_getpackagenetcharge(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagenetcharge(void* lpObj, int packageidx, const char* lpszPackageNetCharge);

QString GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, QString qsPackageNetCharge);

Default Value

""

Remarks

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. 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: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, 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 GetRates, 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageType Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Unicode (Windows)
INT GetPackageType(INT iPackageIdx);
INT SetPackageType(INT iPackageIdx, INT iPackageType);

PT_NONE(0), 
PT_POSTCARDS(1), 
PT_LETTER(2), 
PT_LARGE_ENVELOPE(3), 
PT_FLAT_RATE_ENVELOPE(4), 
PT_FLAT_RATE_LEGAL_ENVELOPE(5), 
PT_FLAT_RATE_PADDED_ENVELOPE(6), 
PT_FLAT_RATE_GIFT_CARD_ENVELOPE(7), 
PT_FLAT_RATE_WINDOW_ENVELOPE(8), 
PT_FLAT_RATE_CARDBOARD_ENVELOPE(9), 
PT_SMALL_FLAT_RATE_ENVELOPE(10), 
PT_PAK(11), 
PT_BOX(12), 
PT_10KG_BOX(13), 
PT_25KG_BOX(14), 
PT_SMALL_EXPRESS_BOX(15), 
PT_MEDIUM_EXPRESS_BOX(16), 
PT_LARGE_EXPRESS_BOX(17), 
PT_FLAT_RATE_BOX(18), 
PT_SMALL_FLAT_RATE_BOX(19), 
PT_MEDIUM_FLAT_RATE_BOX(20), 
PT_LARGE_FLAT_RATE_BOX(21), 
PT_DVDFLAT_RATE_BOX(22), 
PT_LARGE_VIDEO_FLAT_RATE_BOX(23), 
PT_REGIONAL_RATE_BOX_A(24), 
PT_REGIONAL_RATE_BOX_B(25), 
PT_RECTANGULAR(26), 
PT_NON_RECTANGULAR(27), 
PT_TUBE(28), 
PT_MATTER_FOR_THE_BLIND(29), 
PT_PALLET(30), 
PT_YOUR_PACKAGING(31), 
PT_DOCUMENT(32), 
PT_FLATS(33), 
PT_PARCELS(34), 
PT_BPM(35), 
PT_FIRST_CLASS(36), 
PT_PRIORITY(37), 
PT_MACHINABLES(38), 
PT_IRREGULARS(39), 
PT_PARCEL_POST(40), 
PT_BPMPARCEL(41), 
PT_MEDIA_MAIL(42), 
PT_BPMFLAT(43), 
PT_STANDARD_FLAT(44), 
PT_REGIONAL_RATE_BOX_C(45), 
PT_THICK_ENVELOPE(46), 
PT_SMALL_BOX(47), 
PT_MEDIUM_BOX(48), 
PT_LARGE_BOX(49), 
PT_EXTRA_LARGE_BOX(50), 
PT_PACKAGE_SERVICE(51), 
PT_CUBIC_PARCELS(52), 
PT_CUBIC_SOFT_PACK(53)

int dshippingsdk_uspsshipintl_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagetype(void* lpObj, int packageidx, int iPackageType);

int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Default Value

0

Remarks

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

Possible values are:

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagePackagingType for the first package is used in label requests.

If the PackagePackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackageLength, PackageWidth, and PackageHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagePackagingType 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 PackagePackagingType make sure this is valid for all the following: SenderCountryCode, RecipientCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageShippingLabel Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageShippingLabel(int iPackageIdx, char* &lpPackageShippingLabel, int &lenPackageShippingLabel);

Unicode (Windows)
INT GetPackageShippingLabel(INT iPackageIdx, LPSTR &lpPackageShippingLabel, INT &lenPackageShippingLabel);

int dshippingsdk_uspsshipintl_getpackageshippinglabel(void* lpObj, int packageidx, char** lpPackageShippingLabel, int* lenPackageShippingLabel);

QByteArray GetPackageShippingLabel(int iPackageIdx);

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 LabelImageType. 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 PackageShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is read-only and not available at design time.

Data Type

Binary String

PackageShippingLabelFile Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, const char* lpszPackageShippingLabelFile);

Unicode (Windows)
LPWSTR GetPackageShippingLabelFile(INT iPackageIdx);
INT SetPackageShippingLabelFile(INT iPackageIdx, LPCWSTR lpszPackageShippingLabelFile);

char* dshippingsdk_uspsshipintl_getpackageshippinglabelfile(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackageshippinglabelfile(void* lpObj, int packageidx, const char* lpszPackageShippingLabelFile);

QString GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, QString qsPackageShippingLabelFile);

Default Value

""

Remarks

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

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then PackageShippingLabelFile 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageSignatureType Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Unicode (Windows)
INT GetPackageSignatureType(INT iPackageIdx);
INT SetPackageSignatureType(INT iPackageIdx, INT iPackageSignatureType);

ST_SERVICE_DEFAULT(0), 
ST_ADULT(1), 
ST_DIRECT(2), 
ST_INDIRECT(3), 
ST_NO_SIGNATURE_REQUIRED(4), 
ST_USPSDELIVERY_CONFIRMATION(5), 
ST_ADULT_19(6)

int dshippingsdk_uspsshipintl_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagesignaturetype(void* lpObj, int packageidx, int iPackageSignatureType);

int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Default Value

0

Remarks

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

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

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

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

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

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

For UPS, when delivery confirmation is requested for a package, the PackageSignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageSize Property (USPSShipIntl Class)

Size of the package being mailed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSize(int iPackageIdx);
int SetPackageSize(int iPackageIdx, int iPackageSize);

Unicode (Windows)
INT GetPackageSize(INT iPackageIdx);
INT SetPackageSize(INT iPackageIdx, INT iPackageSize);

PS_REGULAR(0), 
PS_LARGE(1), 
PS_OVERSIZE(2), 
PS_IRREGULAR(3)

int dshippingsdk_uspsshipintl_getpackagesize(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagesize(void* lpObj, int packageidx, int iPackageSize);

int GetPackageSize(int iPackageIdx);
int SetPackageSize(int iPackageIdx, int iPackageSize);

Default Value

0

Remarks

Size of the package being mailed.

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

See below for valid entries:

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

Note: Use the PackageLength, PackageHeight, PackageWidth and optionally PackageGirth (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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageTrackingNumber Property (USPSShipIntl Class)

Tracking number assigned to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageTrackingNumber(int iPackageIdx);

Unicode (Windows)
LPWSTR GetPackageTrackingNumber(INT iPackageIdx);

char* dshippingsdk_uspsshipintl_getpackagetrackingnumber(void* lpObj, int packageidx);

QString GetPackageTrackingNumber(int iPackageIdx);

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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is read-only and not available at design time.

Data Type

String

PackageWeight Property (USPSShipIntl Class)

Weight of this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, const char* lpszPackageWeight);

Unicode (Windows)
LPWSTR GetPackageWeight(INT iPackageIdx);
INT SetPackageWeight(INT iPackageIdx, LPCWSTR lpszPackageWeight);

char* dshippingsdk_uspsshipintl_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackageweight(void* lpObj, int packageidx, const char* lpszPackageWeight);

QString GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, QString qsPackageWeight);

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 PackagePackagingType 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 ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagePackagingType 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 PostageProvider 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageWidth Property (USPSShipIntl Class)

The width of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Unicode (Windows)
INT GetPackageWidth(INT iPackageIdx);
INT SetPackageWidth(INT iPackageIdx, INT iPackageWidth);

int dshippingsdk_uspsshipintl_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_uspsshipintl_setpackagewidth(void* lpObj, int packageidx, int iPackageWidth);

int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the PackageWidth is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageHeight 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 PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

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

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth 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 PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize 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 PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PermitNumber Property (USPSShipIntl Class)

Permit number to print Postage Due labels.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermitNumber();
int SetPermitNumber(const char* lpszPermitNumber);

Unicode (Windows)
LPWSTR GetPermitNumber();
INT SetPermitNumber(LPCWSTR lpszPermitNumber);

char* dshippingsdk_uspsshipintl_getpermitnumber(void* lpObj);
int dshippingsdk_uspsshipintl_setpermitnumber(void* lpObj, const char* lpszPermitNumber);

QString GetPermitNumber();
int SetPermitNumber(QString qsPermitNumber);

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.

Data Type

String

PostageProvider Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPostageProvider();
int SetPostageProvider(int iPostageProvider);

Unicode (Windows)
INT GetPostageProvider();
INT SetPostageProvider(INT iPostageProvider);

PP_NONE(0), 
PP_ENDICIA(1), 
PP_STAMPS(2)

int dshippingsdk_uspsshipintl_getpostageprovider(void* lpObj);
int dshippingsdk_uspsshipintl_setpostageprovider(void* lpObj, int iPostageProvider);

int GetPostageProvider();
int SetPostageProvider(int iPostageProvider);

Default Value

0

Remarks

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

• Set USPSUserId
• Set USPSPassword
• Set USPSServer

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

For Production

• Set USPSAccountNumber
• Set USPSPassword

For Testing

• Set EndiciaTestMode

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

• Set USPSUserId
• Set USPSAccountNumber
• Set USPSPassword
• Set USPSServer

Data Type

Integer

PriceOption Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPriceOption();
int SetPriceOption(int iPriceOption);

Unicode (Windows)
INT GetPriceOption();
INT SetPriceOption(INT iPriceOption);

PO_RETAIL(0), 
PO_COMMERCIAL_PLUS(1), 
PO_COMMERCIAL_BASE(2)

int dshippingsdk_uspsshipintl_getpriceoption(void* lpObj);
int dshippingsdk_uspsshipintl_setpriceoption(void* lpObj, int iPriceOption);

int GetPriceOption();
int SetPriceOption(int iPriceOption);

Default Value

2

Remarks

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

Note: When ServiceType 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 ServiceType is stUSPSPriorityMailInternational (84).

Possible values are as follows:

Data Type

Integer

Prohibitions Property (USPSShipIntl Class)

List of items prohibited from mailing to the destination country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProhibitions();

Unicode (Windows)
LPWSTR GetProhibitions();

char* dshippingsdk_uspsshipintl_getprohibitions(void* lpObj);

QString GetProhibitions();

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.

Data Type

String

ProxyAuthScheme Property (USPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dshippingsdk_uspsshipintl_getproxyauthscheme(void* lpObj);
int dshippingsdk_uspsshipintl_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

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 ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.