UPSRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides domestic or international rates based on weight, service, and origin/destination information.

Syntax

UPSRates

Remarks

Rates class provides automated online access to domestic and international rate information and is capable also of rating shipments containing multiple packages. Based on the shipment's input characteristics (origin, destination, shipment weight, special services, etc.), the class provides a list of all applicable UPS services and their respective published rates.

For all shipments inside or between the U.S. and Puerto Rico:

The request that is sent to UPS Server must provide details at the package level. For shipments consisting of only one package, the class identifies all the available UPS domestic and international services and returns shipping rates based on the package's specifications. If the shipment consists of two or more packages, the class will return a separate rate for each package and the rate for the total shipment. The total shipment rate will be a sum of the rates for all packages.

For all shipments outside the U.S. and Puerto Rico:

The request must provide details at the shipment level. For shipments consisting of one or more packages, the class will return one rate for all packages at the shipment level (not at the package level).

To retrieve a list of rates for all services applicable to your shipment, the RequestedService must be set to 0 (stUnspecified) when calling GetRates method. To get a rate for a specified service, the RequestedService must be set to the corresponding value of the UPS service to be rated (other than 0: stUnspecified).

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

Please note that shipping rates retrieved by this class are estimates based on the information supplied. Other shipping charges may apply and the final shipping charge may differ depending upon your UPS Account Number and how the package is tendered to UPS.

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.

AccountAddress1 Property (UPSRates Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountAddress1();
int SetAccountAddress1(const char* lpszAccountAddress1);

Unicode (Windows)
LPWSTR GetAccountAddress1();
INT SetAccountAddress1(LPCWSTR lpszAccountAddress1);

char* dshippingsdk_upsrates_getaccountaddress1(void* lpObj);
int dshippingsdk_upsrates_setaccountaddress1(void* lpObj, const char* lpszAccountAddress1);

QString GetAccountAddress1();
int SetAccountAddress1(QString qsAccountAddress1);

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 AccountAddress1 should not exceed 35 characters.

Data Type

String

AccountAddress2 Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountAddress2();
int SetAccountAddress2(const char* lpszAccountAddress2);

Unicode (Windows)
LPWSTR GetAccountAddress2();
INT SetAccountAddress2(LPCWSTR lpszAccountAddress2);

char* dshippingsdk_upsrates_getaccountaddress2(void* lpObj);
int dshippingsdk_upsrates_setaccountaddress2(void* lpObj, const char* lpszAccountAddress2);

QString GetAccountAddress2();
int SetAccountAddress2(QString qsAccountAddress2);

Default Value

""

Remarks

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

Data Type

String

AccountCity Property (UPSRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountCity();
int SetAccountCity(const char* lpszAccountCity);

Unicode (Windows)
LPWSTR GetAccountCity();
INT SetAccountCity(LPCWSTR lpszAccountCity);

char* dshippingsdk_upsrates_getaccountcity(void* lpObj);
int dshippingsdk_upsrates_setaccountcity(void* lpObj, const char* lpszAccountCity);

QString GetAccountCity();
int SetAccountCity(QString qsAccountCity);

Default Value

""

Remarks

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

Data Type

String

AccountCountryCode Property (UPSRates Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountCountryCode();
int SetAccountCountryCode(const char* lpszAccountCountryCode);

Unicode (Windows)
LPWSTR GetAccountCountryCode();
INT SetAccountCountryCode(LPCWSTR lpszAccountCountryCode);

char* dshippingsdk_upsrates_getaccountcountrycode(void* lpObj);
int dshippingsdk_upsrates_setaccountcountrycode(void* lpObj, const char* lpszAccountCountryCode);

QString GetAccountCountryCode();
int SetAccountCountryCode(QString qsAccountCountryCode);

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

Data Type

String

AccountState Property (UPSRates Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountState();
int SetAccountState(const char* lpszAccountState);

Unicode (Windows)
LPWSTR GetAccountState();
INT SetAccountState(LPCWSTR lpszAccountState);

char* dshippingsdk_upsrates_getaccountstate(void* lpObj);
int dshippingsdk_upsrates_setaccountstate(void* lpObj, const char* lpszAccountState);

QString GetAccountState();
int SetAccountState(QString qsAccountState);

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.

Data Type

String

AccountZipCode Property (UPSRates Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountZipCode();
int SetAccountZipCode(const char* lpszAccountZipCode);

Unicode (Windows)
LPWSTR GetAccountZipCode();
INT SetAccountZipCode(LPCWSTR lpszAccountZipCode);

char* dshippingsdk_upsrates_getaccountzipcode(void* lpObj);
int dshippingsdk_upsrates_setaccountzipcode(void* lpObj, const char* lpszAccountZipCode);

QString GetAccountZipCode();
int SetAccountZipCode(QString qsAccountZipCode);

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 AccountCity and AccountState are not present.

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

Data Type

String

CODTotalAmount Property (UPSRates Class)

The total amount to be collected on shipment level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODTotalAmount();
int SetCODTotalAmount(const char* lpszCODTotalAmount);

Unicode (Windows)
LPWSTR GetCODTotalAmount();
INT SetCODTotalAmount(LPCWSTR lpszCODTotalAmount);

char* dshippingsdk_upsrates_getcodtotalamount(void* lpObj);
int dshippingsdk_upsrates_setcodtotalamount(void* lpObj, const char* lpszCODTotalAmount);

QString GetCODTotalAmount();
int SetCODTotalAmount(QString qsCODTotalAmount);

Default Value

""

Remarks

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

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

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

Data Type

String

CODType Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCODType();
int SetCODType(int iCODType);

Unicode (Windows)
INT GetCODType();
INT SetCODType(INT iCODType);

CODTS_CASH(0), 
CODTS_CHECK(1)

int dshippingsdk_upsrates_getcodtype(void* lpObj);
int dshippingsdk_upsrates_setcodtype(void* lpObj, int iCODType);

int GetCODType();
int SetCODType(int iCODType);

Default Value

0

Remarks

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

Valid values are:

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

Data Type

Integer

CustomerType Property (UPSRates Class)

Customer classification code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomerType();
int SetCustomerType(int iCustomerType);

Unicode (Windows)
INT GetCustomerType();
INT SetCustomerType(INT iCustomerType);

CC_SHIPPER_NUMBER(0), 
CC_DAILY(1), 
CC_RETAIL(2), 
CC_STANDARD(3), 
CC_NONE(4), 
CC_REGIONAL(5), 
CC_GENERAL(6)

int dshippingsdk_upsrates_getcustomertype(void* lpObj);
int dshippingsdk_upsrates_setcustomertype(void* lpObj, int iCustomerType);

int GetCustomerType();
int SetCustomerType(int iCustomerType);

Default Value

4

Remarks

The CustomerType is applicable only if SenderCountryCode is US. The rates depend on the combination of PickupType and CustomerType.

Valid values are:

Data Type

Integer

Disclaimer Property (UPSRates Class)

Disclaimer text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDisclaimer();

Unicode (Windows)
LPWSTR GetDisclaimer();

char* dshippingsdk_upsrates_getdisclaimer(void* lpObj);

QString GetDisclaimer();

Default Value

""

Remarks

The Disclaimer is a conditional statement about the validity of the service being guaranteed, based on the SenderCountryCode and RecipientCountryCode. If applicable, this property is filled after a call to the GetShippingTime.

Service Guaranteed Disclaimers

This property is read-only.

Data Type

String

DutyType Property (UPSRates Class)

Auto duty type applicable for requests outside the US.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutyType();

Unicode (Windows)
LPWSTR GetDutyType();

char* dshippingsdk_upsrates_getdutytype(void* lpObj);

QString GetDutyType();

Default Value

"Dutiable"

Remarks

The duty is automatically calculated in such requests if the Documents is set to False. This is returned in the server response only for requests outside the US.

The possible values to be returned:

All US domestic letters and documents are Non-Dutiable.

For non-documents the following logic applies:

• a. When export and import countries are the same, duty type is Non-Dutiable;
• b. All European transborder shipments (country pair must be found on DGTM TBL #462) are Non-Dutiable;
• c. If not found in step b, the duty type is assigned from the first value larger or equal to the converted customs declared value (order by declared value ascending) for that import country;
• If not found, default the duty type to Dutiable;

Note: When processing auto duty logic and for any reason the program experiences problems getting the duty type, the duty type will be defaulted to Dutiable. If the CurrencyCode is the same as the import currency code, there will be no currency conversion and the entered value will be used in the determination of the auto duty logic.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (UPSRates 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_upsrates_getfirewallautodetect(void* lpObj);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getfirewalltype(void* lpObj);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getfirewallhost(void* lpObj);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getfirewallpassword(void* lpObj);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getfirewallport(void* lpObj);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getfirewalluser(void* lpObj);
int dshippingsdk_upsrates_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

PackageCount Property (UPSRates 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_upsrates_getpackagecount(void* lpObj);
int dshippingsdk_upsrates_setpackagecount(void* lpObj, int iPackageCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODType
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageRatingAggregate
• PackageSignatureType
• PackageSpecialServices
• PackageTotalSurcharges
• 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

PackageBaseCharge Property (UPSRates Class)

Actual Base Charge applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageBaseCharge(INT iPackageIdx);

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

QString GetPackageBaseCharge(int iPackageIdx);

Default Value

""

Remarks

Actual Base Charge applicable to this package.

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

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: 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 the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

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

This is not applicable to USPS.

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

The 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

PackageCODAmount Property (UPSRates 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_upsrates_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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

PackageHeight Property (UPSRates 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_upsrates_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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

PackageInsuredValue Property (UPSRates 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_upsrates_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getpackagenetcharge(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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

PackageRatingAggregate Property (UPSRates Class)

Rating aggregate applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageRatingAggregate(INT iPackageIdx);

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

QString GetPackageRatingAggregate(int iPackageIdx);

Default Value

""

Remarks

Rating aggregate applicable to this package.

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

PackageSignatureType Property (UPSRates 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_upsrates_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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

PackageSpecialServices Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, int64 lPackageSpecialServices);

Unicode (Windows)
LONG64 GetPackageSpecialServices(INT iPackageIdx);
INT SetPackageSpecialServices(INT iPackageIdx, LONG64 lPackageSpecialServices);

int64 dshippingsdk_upsrates_getpackagespecialservices(void* lpObj, int packageidx);
int dshippingsdk_upsrates_setpackagespecialservices(void* lpObj, int packageidx, int64 lPackageSpecialServices);

qint64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, qint64 lPackageSpecialServices);

Default Value

0

Remarks

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

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

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

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

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

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

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

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the PackageCODAmount and PackageCODType, PackageSignatureType, and PackageInsuredValue.

This property is not applicable to USPS or 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

Long64

PackageTotalSurcharges Property (UPSRates Class)

Total Actual Surcharges applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageTotalSurcharges(INT iPackageIdx);

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

QString GetPackageTotalSurcharges(int iPackageIdx);

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

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

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

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: 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, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

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

The 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 (UPSRates 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_upsrates_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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 (UPSRates 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_upsrates_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_upsrates_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

PackageServiceIndex Property (UPSRates Class)

The service index in the list of available services returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageServiceIndex();
int SetPackageServiceIndex(int iPackageServiceIndex);

Unicode (Windows)
INT GetPackageServiceIndex();
INT SetPackageServiceIndex(INT iPackageServiceIndex);

int dshippingsdk_upsrates_getpackageserviceindex(void* lpObj);
int dshippingsdk_upsrates_setpackageserviceindex(void* lpObj, int iPackageServiceIndex);

int GetPackageServiceIndex();
int SetPackageServiceIndex(int iPackageServiceIndex);

Default Value

0

Remarks

To retrieve all rating attributes on package level (PackageBaseCharge, PackageTotalSurcharges, PackageNetCharge, and PackageRatingAggregate) you must set the PackageServiceIndex from 0 to ServiceCount - 1 for each PackageIndex from 0 to PackageCount - 1.

Data Type

Integer

PickupType Property (UPSRates Class)

Pickup type used for the shipment that rate is requested for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPickupType();
int SetPickupType(int iPickupType);

Unicode (Windows)
INT GetPickupType();
INT SetPickupType(INT iPickupType);

PT_DAILY_PICKUP(0), 
PT_CUSTOMER_COUNTER(1), 
PT_ONE_TIME_PICKUP(2), 
PT_ON_CALL_AIR(3), 
PT_LETTER_CENTER(4), 
PT_AIR_SERVICE_CENTER(5), 
PT_NONE_TYPE(6)

int dshippingsdk_upsrates_getpickuptype(void* lpObj);
int dshippingsdk_upsrates_setpickuptype(void* lpObj, int iPickupType);

int GetPickupType();
int SetPickupType(int iPickupType);

Default Value

0

Remarks

The rates depend on the combination of PickupType and CustomerType.

Valid values are:

Data Type

Integer

ProxyAuthScheme Property (UPSRates 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_upsrates_getproxyauthscheme(void* lpObj);
int dshippingsdk_upsrates_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.

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

If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dshippingsdk_upsrates_getproxyautodetect(void* lpObj);
int dshippingsdk_upsrates_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

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.

Data Type

Boolean

ProxyPassword Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dshippingsdk_upsrates_getproxypassword(void* lpObj);
int dshippingsdk_upsrates_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dshippingsdk_upsrates_getproxyport(void* lpObj);
int dshippingsdk_upsrates_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dshippingsdk_upsrates_getproxyserver(void* lpObj);
int dshippingsdk_upsrates_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dshippingsdk_upsrates_getproxyssl(void* lpObj);
int dshippingsdk_upsrates_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

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:

Data Type

Integer

ProxyUser Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dshippingsdk_upsrates_getproxyuser(void* lpObj);
int dshippingsdk_upsrates_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (UPSRates Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress1();
int SetRecipientAddress1(const char* lpszRecipientAddress1);

Unicode (Windows)
LPWSTR GetRecipientAddress1();
INT SetRecipientAddress1(LPCWSTR lpszRecipientAddress1);

char* dshippingsdk_upsrates_getrecipientaddress1(void* lpObj);
int dshippingsdk_upsrates_setrecipientaddress1(void* lpObj, const char* lpszRecipientAddress1);

QString GetRecipientAddress1();
int SetRecipientAddress1(QString qsRecipientAddress1);

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 RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress2();
int SetRecipientAddress2(const char* lpszRecipientAddress2);

Unicode (Windows)
LPWSTR GetRecipientAddress2();
INT SetRecipientAddress2(LPCWSTR lpszRecipientAddress2);

char* dshippingsdk_upsrates_getrecipientaddress2(void* lpObj);
int dshippingsdk_upsrates_setrecipientaddress2(void* lpObj, const char* lpszRecipientAddress2);

QString GetRecipientAddress2();
int SetRecipientAddress2(QString qsRecipientAddress2);

Default Value

""

Remarks

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

Data Type

String

RecipientAddressFlags Property (UPSRates Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

Unicode (Windows)
INT GetRecipientAddressFlags();
INT SetRecipientAddressFlags(INT iRecipientAddressFlags);

int dshippingsdk_upsrates_getrecipientaddressflags(void* lpObj);
int dshippingsdk_upsrates_setrecipientaddressflags(void* lpObj, int iRecipientAddressFlags);

int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (UPSRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCity();
int SetRecipientCity(const char* lpszRecipientCity);

Unicode (Windows)
LPWSTR GetRecipientCity();
INT SetRecipientCity(LPCWSTR lpszRecipientCity);

char* dshippingsdk_upsrates_getrecipientcity(void* lpObj);
int dshippingsdk_upsrates_setrecipientcity(void* lpObj, const char* lpszRecipientCity);

QString GetRecipientCity();
int SetRecipientCity(QString qsRecipientCity);

Default Value

""

Remarks

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

Data Type

String

RecipientCountryCode Property (UPSRates Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCountryCode();
int SetRecipientCountryCode(const char* lpszRecipientCountryCode);

Unicode (Windows)
LPWSTR GetRecipientCountryCode();
INT SetRecipientCountryCode(LPCWSTR lpszRecipientCountryCode);

char* dshippingsdk_upsrates_getrecipientcountrycode(void* lpObj);
int dshippingsdk_upsrates_setrecipientcountrycode(void* lpObj, const char* lpszRecipientCountryCode);

QString GetRecipientCountryCode();
int SetRecipientCountryCode(QString qsRecipientCountryCode);

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

Data Type

String

RecipientState Property (UPSRates Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientState();
int SetRecipientState(const char* lpszRecipientState);

Unicode (Windows)
LPWSTR GetRecipientState();
INT SetRecipientState(LPCWSTR lpszRecipientState);

char* dshippingsdk_upsrates_getrecipientstate(void* lpObj);
int dshippingsdk_upsrates_setrecipientstate(void* lpObj, const char* lpszRecipientState);

QString GetRecipientState();
int SetRecipientState(QString qsRecipientState);

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.

Data Type

String

RecipientZipCode Property (UPSRates Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientZipCode();
int SetRecipientZipCode(const char* lpszRecipientZipCode);

Unicode (Windows)
LPWSTR GetRecipientZipCode();
INT SetRecipientZipCode(LPCWSTR lpszRecipientZipCode);

char* dshippingsdk_upsrates_getrecipientzipcode(void* lpObj);
int dshippingsdk_upsrates_setrecipientzipcode(void* lpObj, const char* lpszRecipientZipCode);

QString GetRecipientZipCode();
int SetRecipientZipCode(QString qsRecipientZipCode);

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 RecipientCity and RecipientState are not present.

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

Data Type

String

RecipientCandidateAggregate Property (UPSRates Class)

String representing the list of destination address candidates (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCandidateAggregate();

Unicode (Windows)
LPWSTR GetRecipientCandidateAggregate();

char* dshippingsdk_upsrates_getrecipientcandidateaggregate(void* lpObj);

QString GetRecipientCandidateAggregate();

Default Value

""

Remarks

If the destination address provided in the time-in-transit request (when the GetShippingTime method is called) is an invalid address, a list of potential candidates for the destination address will be returned in the server response. This is applicable for US only.

This destination address candidate list will be stored as a string in RecipientCandidateAggregate, formatted as JSON.

To get the detailed information for each destination address candidate (city, state, zip code range), the UPSAddress class can be used. To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values.

This property is read-only.

Data Type

String

RequestedService Property (UPSRates Class)

Service type for which the shipping rate is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestedService();
int SetRequestedService(int iRequestedService);

Unicode (Windows)
INT GetRequestedService();
INT SetRequestedService(INT iRequestedService);

ST_UNSPECIFIED(0), 
ST_FED_EX_PRIORITY_OVERNIGHT(10), 
ST_FED_EX_STANDARD_OVERNIGHT(11), 
ST_FED_EX_FIRST_OVERNIGHT(12), 
ST_FED_EX_2DAY(13), 
ST_FED_EX_EXPRESS_SAVER(14), 
ST_FED_EX_GROUND(15), 
ST_FED_EX_GROUND_HOME_DELIVERY(16), 
ST_FED_EX_1DAY_FREIGHT(17), 
ST_FED_EX_2DAY_FREIGHT(18), 
ST_FED_EX_3DAY_FREIGHT(19), 
ST_FED_EX_INTERNATIONAL_PRIORITY(20), 
ST_FED_EX_INTERNATIONAL_ECONOMY(21), 
ST_FED_EX_INTERNATIONAL_FIRST(22), 
ST_FED_EX_INTERNATIONAL_PRIORITY_FREIGHT(23), 
ST_FED_EX_INTERNATIONAL_ECONOMY_FREIGHT(24), 
ST_FED_EX_EUROPE_FIRST_INTERNATIONAL_PRIORITY(25), 
ST_FED_EX_SMART_POST(26), 
ST_FED_EX_2DAY_AM(27), 
ST_FED_EX_FIRST_FREIGHT(28), 
ST_FED_EX_INTERNATIONAL_GROUND(29), 
ST_FED_EX_FREIGHT_ECONOMY(30), 
ST_FED_EX_FREIGHT_PRIORITY(31), 
ST_FED_EX_INTERNATIONAL_PRIORITY_EXPRESS(32), 
ST_FED_EX_INTERNATIONAL_CONNECT_PLUS(33), 
ST_UPSFIRST_CLASS(35), 
ST_UPSPRIORITY_MAIL(36), 
ST_UPSEXPEDITED_MAIL_INNOVATIONS(37), 
ST_UPSPRIORITY_MAIL_INNOVATIONS(38), 
ST_UPSECONOMY_MAIL_INNOVATIONS(39), 
ST_UPSNEXT_DAY_AIR(40), 
ST_UPSEXPRESS(41), 
ST_UPS2ND_DAY_AIR(42), 
ST_UPSGROUND(43), 
ST_UPSWORLDWIDE_EXPRESS(44), 
ST_UPSWORLDWIDE_EXPEDITED(45), 
ST_UPSEXPEDITED(46), 
ST_UPSSTANDARD(47), 
ST_UPS3DAY_SELECT(48), 
ST_UPSNEXT_DAY_AIR_SAVER(49), 
ST_UPSSAVER(50), 
ST_UPSNEXT_DAY_AIR_EARLY_AM(51), 
ST_UPSEXPRESS_EARLY_AM(52), 
ST_UPSWORLDWIDE_EXPRESS_PLUS(53), 
ST_UPSEXPRESS_PLUS(54), 
ST_UPS2ND_DAY_AIR_AM(55), 
ST_UPSTODAY_STANDARD(56), 
ST_UPSTODAY_COURRIER(57), 
ST_UPSTODAY_INTER_CITY(58), 
ST_UPSTODAY_EXPRESS(59), 
ST_UPSTODAY_EXPRESS_SAVER(60), 
ST_UPSWORLDWIDE_EXPRESS_FREIGHT(61), 
ST_UPSSURE_POST_LESS_THAN_1LB(62), 
ST_UPSSURE_POST_1LBOR_GREATER(63), 
ST_UPSSURE_POST_BPM(64), 
ST_UPSSURE_POST_MEDIA(65), 
ST_USPSEXPRESS(70), 
ST_USPSFIRST_CLASS(71), 
ST_USPSPRIORITY(72), 
ST_USPSPARCEL_POST(73), 
ST_USPSBPM(74), 
ST_USPSMEDIA(75), 
ST_USPSLIBRARY(76), 
ST_USPSONLINE(77), 
ST_USPSGLOBAL_EXPRESS(78), 
ST_USPSPARCEL_SELECT(79), 
ST_USPSCRITICAL_MAIL(80), 
ST_USPSSTANDARD_MAIL(81), 
ST_USPSEXPRESS_MAIL_INTERNATIONAL(82), 
ST_USPSFIRST_CLASS_MAIL_INTERNATIONAL(83), 
ST_USPSPRIORITY_MAIL_INTERNATIONAL(84), 
ST_USPSPRIORITY_EXPRESS(85), 
ST_USPSRETAIL_GROUND(86), 
ST_USPSFIRST_CLASS_PACKAGE_INTERNATIONAL_SERVICE(87), 
ST_USPSPRIORITY_MAIL_EXPRESS_INTERNATIONAL(88), 
ST_CANADA_REGULAR_PARCEL(90), 
ST_CANADA_EXPEDITED_PARCEL(91), 
ST_CANADA_XPRESSPOST(92), 
ST_CANADA_LIBRARY(93), 
ST_CANADA_PRIORITY(94), 
ST_CANADA_PRIORITY_ENVELOPE_USA(95), 
ST_CANADA_PRIORITY_PAK_USA(96), 
ST_CANADA_PRIORITY_PARCEL_USA(97), 
ST_CANADA_XPRESSPOST_USA(98), 
ST_CANADA_EXPEDITED_PARCEL_USA(99), 
ST_CANADA_SMALL_PACKET_AIR_USA(100), 
ST_CANADA_TRACKED_PACKET_USA(101), 
ST_CANADA_TRACKED_PACKET_LVMUSA(102), 
ST_CANADA_PRIORITY_ENVELOPE_INTERNATIONAL(103), 
ST_CANADA_PRIORITY_PAK_INTERNATIONAL(104), 
ST_CANADA_PRIORITY_PARCEL_INTERNATIONAL(105), 
ST_CANADA_XPRESSPOST_INTERNATIONAL(106), 
ST_CANADA_SMALL_PACKET_AIR_INTERNATIONAL(107), 
ST_CANADA_SMALL_PACKET_LAND_INTERNATIONAL(108), 
ST_CANADA_PARCEL_AIR_INTERNATIONAL(109), 
ST_CANADA_PARCEL_LAND_INTERNATIONAL(110), 
ST_CANADA_TRACKED_PACKET_INTERNATIONAL(111), 
ST_FED_EX_SAME_DAY(126), 
ST_FED_EX_SAME_DAY_CITY(127), 
ST_FED_EX_SAME_DAY_METRO_AFTERNOON(128), 
ST_FED_EX_SAME_DAY_METRO_MORNING(129), 
ST_FED_EX_SAME_DAY_METRO_RUSH(130), 
ST_UPSWORLDWIDE_ECONOMY_DDU(131), 
ST_UPSWORLDWIDE_ECONOMY_DDP(132), 
ST_USPSPARCEL_SELECT_GROUND(133), 
ST_USPSPRIORITY_MAIL_CUBIC(134), 
ST_USPSGROUND_ADVANTAGE(135), 
ST_USPSGROUND_ADVANTAGE_CUBIC(136), 
ST_FED_EX_FIRST(140), 
ST_FED_EX_PRIORITY(141), 
ST_FED_EX_PRIORITY_EXPRESS(142), 
ST_FED_EX_PRIORITY_EXPRESS_FREIGHT(143), 
ST_FED_EX_PRIORITY_FREIGHT(144), 
ST_FED_EX_ECONOMY_SELECT(145)

int dshippingsdk_upsrates_getrequestedservice(void* lpObj);
int dshippingsdk_upsrates_setrequestedservice(void* lpObj, int iRequestedService);

int GetRequestedService();
int SetRequestedService(int iRequestedService);

Default Value

0

Remarks

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

Otherwise, the rate request will be considered by the UPS server as it has been made for all available services and respective rates to ship a package from the SenderAddress to RecipientAddress. The availability and the description of UPS services depend on the country of origin.

Valid values for UPS are:

Data Type

Integer

SenderAddress1 Property (UPSRates Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress1();
int SetSenderAddress1(const char* lpszSenderAddress1);

Unicode (Windows)
LPWSTR GetSenderAddress1();
INT SetSenderAddress1(LPCWSTR lpszSenderAddress1);

char* dshippingsdk_upsrates_getsenderaddress1(void* lpObj);
int dshippingsdk_upsrates_setsenderaddress1(void* lpObj, const char* lpszSenderAddress1);

QString GetSenderAddress1();
int SetSenderAddress1(QString qsSenderAddress1);

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 SenderAddress1 should not exceed 35 characters.

Data Type

String

SenderAddress2 Property (UPSRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress2();
int SetSenderAddress2(const char* lpszSenderAddress2);

Unicode (Windows)
LPWSTR GetSenderAddress2();
INT SetSenderAddress2(LPCWSTR lpszSenderAddress2);

char* dshippingsdk_upsrates_getsenderaddress2(void* lpObj);
int dshippingsdk_upsrates_setsenderaddress2(void* lpObj, const char* lpszSenderAddress2);

QString GetSenderAddress2();
int SetSenderAddress2(QString qsSenderAddress2);

Default Value

""

Remarks

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

Data Type

String

SenderCity Property (UPSRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCity();
int SetSenderCity(const char* lpszSenderCity);

Unicode (Windows)
LPWSTR GetSenderCity();
INT SetSenderCity(LPCWSTR lpszSenderCity);

char* dshippingsdk_upsrates_getsendercity(void* lpObj);
int dshippingsdk_upsrates_setsendercity(void* lpObj, const char* lpszSenderCity);

QString GetSenderCity();
int SetSenderCity(QString qsSenderCity);

Default Value

""

Remarks

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

Data Type

String

SenderCountryCode Property (UPSRates Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCountryCode();
int SetSenderCountryCode(const char* lpszSenderCountryCode);

Unicode (Windows)
LPWSTR GetSenderCountryCode();
INT SetSenderCountryCode(LPCWSTR lpszSenderCountryCode);

char* dshippingsdk_upsrates_getsendercountrycode(void* lpObj);
int dshippingsdk_upsrates_setsendercountrycode(void* lpObj, const char* lpszSenderCountryCode);

QString GetSenderCountryCode();
int SetSenderCountryCode(QString qsSenderCountryCode);

Default Value

"US"

Remarks

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

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

* Not supported by USPS

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

Data Type

String

SenderState Property (UPSRates Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderState();
int SetSenderState(const char* lpszSenderState);

Unicode (Windows)
LPWSTR GetSenderState();
INT SetSenderState(LPCWSTR lpszSenderState);