UPSFreightRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Rates service.

Syntax

UPSFreightRates

Remarks

The UPSFreightRates class provides a way to retrieve rates for freight shipments. To use the class first set RequestedService to the service for which rates will be retrieved. Then specify the sender, recipient, and shipment information and call GetRates. Upon response Charges, TotalCharge, BillableWeight, and DimensionalWeight will be populated. For instance:

component.UPSServer = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderName = "Developer Test 1" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientName = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "200" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.GetRates Debug.Print ("Total Charge: " & component.TotalCharge) Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("Dimensional Weight: " & component.DimensionalWeight) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print (component.ChargeType(0) & ": " & component.ChargeValue()) Next i

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.

BillableWeight Property (UPSFreightRates Class)

Represents the billable weight associated with the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBillableWeight();

Unicode (Windows)
LPWSTR GetBillableWeight();

char* dshippingsdk_upsfreightrates_getbillableweight(void* lpObj);

QString GetBillableWeight();

Default Value

""

Remarks

This property is read-only.

Data Type

String

ChargeCount Property (UPSFreightRates Class)

The number of records in the Charge arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChargeCount();
int SetChargeCount(int iChargeCount);

Unicode (Windows)
INT GetChargeCount();
INT SetChargeCount(INT iChargeCount);

int dshippingsdk_upsfreightrates_getchargecount(void* lpObj);
int dshippingsdk_upsfreightrates_setchargecount(void* lpObj, int iChargeCount);

int GetChargeCount();
int SetChargeCount(int iChargeCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChargeDescription
• ChargeType
• ChargeValue

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

This property is not available at design time.

Data Type

Integer

ChargeType Property (UPSFreightRates Class)

Indicates the type of the charge.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChargeType(int iChargeIndex);
int SetChargeType(int iChargeIndex, const char* lpszChargeType);

Unicode (Windows)
LPWSTR GetChargeType(INT iChargeIndex);
INT SetChargeType(INT iChargeIndex, LPCWSTR lpszChargeType);

char* dshippingsdk_upsfreightrates_getchargetype(void* lpObj, int chargeindex);
int dshippingsdk_upsfreightrates_setchargetype(void* lpObj, int chargeindex, const char* lpszChargeType);

QString GetChargeType(int iChargeIndex);
int SetChargeType(int iChargeIndex, QString qsChargeType);

Default Value

""

Remarks

Indicates the type of the charge. A partial list of possible values are:

The ChargeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

ChargeDescription Property (UPSFreightRates Class)

The description of the rate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChargeDescription(int iChargeIndex);
int SetChargeDescription(int iChargeIndex, const char* lpszChargeDescription);

Unicode (Windows)
LPWSTR GetChargeDescription(INT iChargeIndex);
INT SetChargeDescription(INT iChargeIndex, LPCWSTR lpszChargeDescription);

char* dshippingsdk_upsfreightrates_getchargedescription(void* lpObj, int chargeindex);
int dshippingsdk_upsfreightrates_setchargedescription(void* lpObj, int chargeindex, const char* lpszChargeDescription);

QString GetChargeDescription(int iChargeIndex);
int SetChargeDescription(int iChargeIndex, QString qsChargeDescription);

Default Value

""

Remarks

The description of the rate. The text description is provided by the class based on the value in ChargeType. If a description is not know for the ChargeType this property will hold an empty string. Possible values are:

The ChargeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

ChargeValue Property (UPSFreightRates Class)

The value of the charge type specified by ChargeType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChargeValue(int iChargeIndex);
int SetChargeValue(int iChargeIndex, const char* lpszChargeValue);

Unicode (Windows)
LPWSTR GetChargeValue(INT iChargeIndex);
INT SetChargeValue(INT iChargeIndex, LPCWSTR lpszChargeValue);

char* dshippingsdk_upsfreightrates_getchargevalue(void* lpObj, int chargeindex);
int dshippingsdk_upsfreightrates_setchargevalue(void* lpObj, int chargeindex, const char* lpszChargeValue);

QString GetChargeValue(int iChargeIndex);
int SetChargeValue(int iChargeIndex, QString qsChargeValue);

Default Value

""

Remarks

The value of the charge type specified by ChargeType.

The ChargeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

CODPayorType Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCODPayorType();
int SetCODPayorType(int iCODPayorType);

Unicode (Windows)
INT GetCODPayorType();
INT SetCODPayorType(INT iCODPayorType);

FCODPT_COLLECT(0), 
FCODPT_PREPAID(1)

int dshippingsdk_upsfreightrates_getcodpayortype(void* lpObj);
int dshippingsdk_upsfreightrates_setcodpayortype(void* lpObj, int iCODPayorType);

int GetCODPayorType();
int SetCODPayorType(int iCODPayorType);

Default Value

0

Remarks

This property specifies the type of COD payment. Possible values are:

Data Type

Integer

CODTotalAmount Property (UPSFreightRates Class)

The total amount of additional fees.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_upsfreightrates_getcodtotalamount(void* lpObj);
int dshippingsdk_upsfreightrates_setcodtotalamount(void* lpObj, const char* lpszCODTotalAmount);

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

Default Value

""

Remarks

UPS Freight handles your payment collections upon delivery and sends the payment to you (if applicable) for an additional charge.

Data Type

String

CODType Property (UPSFreightRates 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);

FCODTS_CERTIFIED_CHECK(0), 
FCODTS_CASH(1), 
FCODTS_COMPANY_CHECK(2)

int dshippingsdk_upsfreightrates_getcodtype(void* lpObj);
int dshippingsdk_upsfreightrates_setcodtype(void* lpObj, int iCODType);

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

Default Value

0

Remarks

This property specifies the type of COD requested. Possible values are:

Data Type

Integer

CommodityCount Property (UPSFreightRates 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_upsfreightrates_getcommoditycount(void* lpObj);
int dshippingsdk_upsfreightrates_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
• CommodityFreightClass
• CommodityFreightIsHazardous
• CommodityFreightNMFC
• CommodityFreightNMFCSub
• CommodityFreightPackagingType
• CommodityNumberOfPieces
• 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 (UPSFreightRates 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_upsfreightrates_getcommoditydescription(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_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

CommodityFreightClass Property (UPSFreightRates Class)

Indicates the freight class of the commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityFreightClass(int iCommodityIndex);
int SetCommodityFreightClass(int iCommodityIndex, const char* lpszCommodityFreightClass);

Unicode (Windows)
LPWSTR GetCommodityFreightClass(INT iCommodityIndex);
INT SetCommodityFreightClass(INT iCommodityIndex, LPCWSTR lpszCommodityFreightClass);

char* dshippingsdk_upsfreightrates_getcommodityfreightclass(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_setcommodityfreightclass(void* lpObj, int commodityindex, const char* lpszCommodityFreightClass);

QString GetCommodityFreightClass(int iCommodityIndex);
int SetCommodityFreightClass(int iCommodityIndex, QString qsCommodityFreightClass);

Default Value

""

Remarks

Indicates the freight class of the commodity.

The following table lists freight classes available from UPS freight services.

NOTE: This field is only applicable to UPS freight.

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

CommodityFreightIsHazardous Property (UPSFreightRates Class)

Identifies if the Commodity item is hazardous.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityFreightIsHazardous(int iCommodityIndex);
int SetCommodityFreightIsHazardous(int iCommodityIndex, int bCommodityFreightIsHazardous);

Unicode (Windows)
BOOL GetCommodityFreightIsHazardous(INT iCommodityIndex);
INT SetCommodityFreightIsHazardous(INT iCommodityIndex, BOOL bCommodityFreightIsHazardous);

int dshippingsdk_upsfreightrates_getcommodityfreightishazardous(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_setcommodityfreightishazardous(void* lpObj, int commodityindex, int bCommodityFreightIsHazardous);

bool GetCommodityFreightIsHazardous(int iCommodityIndex);
int SetCommodityFreightIsHazardous(int iCommodityIndex, bool bCommodityFreightIsHazardous);

Default Value

FALSE

Remarks

Identifies if the Commodity item is hazardous.

NOTE: This field is only applicable to UPS freight.

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

Boolean

CommodityFreightNMFC Property (UPSFreightRates Class)

Identifies the National Motor Freight Classification numbers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityFreightNMFC(int iCommodityIndex);
int SetCommodityFreightNMFC(int iCommodityIndex, const char* lpszCommodityFreightNMFC);

Unicode (Windows)
LPWSTR GetCommodityFreightNMFC(INT iCommodityIndex);
INT SetCommodityFreightNMFC(INT iCommodityIndex, LPCWSTR lpszCommodityFreightNMFC);

char* dshippingsdk_upsfreightrates_getcommodityfreightnmfc(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_setcommodityfreightnmfc(void* lpObj, int commodityindex, const char* lpszCommodityFreightNMFC);

QString GetCommodityFreightNMFC(int iCommodityIndex);
int SetCommodityFreightNMFC(int iCommodityIndex, QString qsCommodityFreightNMFC);

Default Value

""

Remarks

Identifies the National Motor Freight Classification numbers.

NOTE: This field is only applicable to UPS freight.

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

CommodityFreightNMFCSub Property (UPSFreightRates Class)

Identifies the sub code of National Motor Freight Classification numbers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityFreightNMFCSub(int iCommodityIndex);
int SetCommodityFreightNMFCSub(int iCommodityIndex, const char* lpszCommodityFreightNMFCSub);

Unicode (Windows)
LPWSTR GetCommodityFreightNMFCSub(INT iCommodityIndex);
INT SetCommodityFreightNMFCSub(INT iCommodityIndex, LPCWSTR lpszCommodityFreightNMFCSub);

char* dshippingsdk_upsfreightrates_getcommodityfreightnmfcsub(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_setcommodityfreightnmfcsub(void* lpObj, int commodityindex, const char* lpszCommodityFreightNMFCSub);

QString GetCommodityFreightNMFCSub(int iCommodityIndex);
int SetCommodityFreightNMFCSub(int iCommodityIndex, QString qsCommodityFreightNMFCSub);

Default Value

""

Remarks

Identifies the sub code of National Motor Freight Classification numbers.

NOTE: This field is only applicable to UPS freight.

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

CommodityFreightPackagingType Property (UPSFreightRates Class)

Identifies the Commodity item's packaging type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityFreightPackagingType(int iCommodityIndex);
int SetCommodityFreightPackagingType(int iCommodityIndex, int iCommodityFreightPackagingType);

Unicode (Windows)
INT GetCommodityFreightPackagingType(INT iCommodityIndex);
INT SetCommodityFreightPackagingType(INT iCommodityIndex, INT iCommodityFreightPackagingType);

CPT_BAG(0), 
CPT_BALE(1), 
CPT_BARREL(2), 
CPT_BUNDLE(3), 
CPT_BIN(4), 
CPT_BOX(5), 
CPT_BASKET(6), 
CPT_BUNCH(7), 
CPT_CABINET(8), 
CPT_CAN(9), 
CPT_CARRIER(10), 
CPT_CASE(11), 
CPT_CARBOY(12), 
CPT_CONTAINER(13), 
CPT_CRATE(14), 
CPT_CASK(15), 
CPT_CARTON(16), 
CPT_CYLINDER(17), 
CPT_DRUM(18), 
CPT_LOOSE(19), 
CPT_OTHER(20), 
CPT_PAIL(21), 
CPT_PIECES(22), 
CPT_PACKAGE(23), 
CPT_PIPE(24), 
LINE(25), 
CPT_PALLET(26), 
CPT_RACK(27), 
CPT_REEL(28), 
CPT_ROLL(29), 
CPT_SKID(30), 
CPT_SPOOL(31), 
CPT_TUBE(32), 
CPT_TANK(33), 
CPT_UNIT(34), 
CPT_VAN_PACK(35), 
CPT_WRAPPED(36)

int dshippingsdk_upsfreightrates_getcommodityfreightpackagingtype(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_setcommodityfreightpackagingtype(void* lpObj, int commodityindex, int iCommodityFreightPackagingType);

int GetCommodityFreightPackagingType(int iCommodityIndex);
int SetCommodityFreightPackagingType(int iCommodityIndex, int iCommodityFreightPackagingType);

Default Value

0

Remarks

Identifies the Commodity item's packaging type. Possible values are:

NOTE: This field is only applicable to UPS freight.

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

CommodityNumberOfPieces Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityNumberOfPieces(int iCommodityIndex);
int SetCommodityNumberOfPieces(int iCommodityIndex, int iCommodityNumberOfPieces);

Unicode (Windows)
INT GetCommodityNumberOfPieces(INT iCommodityIndex);
INT SetCommodityNumberOfPieces(INT iCommodityIndex, INT iCommodityNumberOfPieces);

int dshippingsdk_upsfreightrates_getcommoditynumberofpieces(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_setcommoditynumberofpieces(void* lpObj, int commodityindex, int iCommodityNumberOfPieces);

int GetCommodityNumberOfPieces(int iCommodityIndex);
int SetCommodityNumberOfPieces(int iCommodityIndex, int iCommodityNumberOfPieces);

Default Value

1

Remarks

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

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

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

This property is not applicable to USPS.

The 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 (UPSFreightRates 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_upsfreightrates_getcommodityvalue(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getcommodityweight(void* lpObj, int commodityindex);
int dshippingsdk_upsfreightrates_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

DimensionalWeight Property (UPSFreightRates Class)

Represents the dimensional weight associated with the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDimensionalWeight();

Unicode (Windows)
LPWSTR GetDimensionalWeight();

char* dshippingsdk_upsfreightrates_getdimensionalweight(void* lpObj);

QString GetDimensionalWeight();

Default Value

""

Remarks

The dimensional weight as calculated by the server and returned in the response.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (UPSFreightRates 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_upsfreightrates_getfirewallautodetect(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getfirewalltype(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getfirewallhost(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getfirewallpassword(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getfirewallport(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getfirewalluser(void* lpObj);
int dshippingsdk_upsfreightrates_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

HandlingUnit Property (UPSFreightRates Class)

Describe the Handling Units (Movable Pieces) in this Shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHandlingUnit();
int SetHandlingUnit(const char* lpszHandlingUnit);

Unicode (Windows)
LPWSTR GetHandlingUnit();
INT SetHandlingUnit(LPCWSTR lpszHandlingUnit);

char* dshippingsdk_upsfreightrates_gethandlingunit(void* lpObj);
int dshippingsdk_upsfreightrates_sethandlingunit(void* lpObj, const char* lpszHandlingUnit);

QString GetHandlingUnit();
int SetHandlingUnit(QString qsHandlingUnit);

Default Value

""

Remarks

Data Type

String

OverSeasLegHeight Property (UPSFreightRates Class)

The height of the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverSeasLegHeight();
int SetOverSeasLegHeight(int iOverSeasLegHeight);

Unicode (Windows)
INT GetOverSeasLegHeight();
INT SetOverSeasLegHeight(INT iOverSeasLegHeight);

int dshippingsdk_upsfreightrates_getoverseaslegheight(void* lpObj);
int dshippingsdk_upsfreightrates_setoverseaslegheight(void* lpObj, int iOverSeasLegHeight);

int GetOverSeasLegHeight();
int SetOverSeasLegHeight(int iOverSeasLegHeight);

Default Value

0

Remarks

The height of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

OverSeasLegLength Property (UPSFreightRates Class)

The length of the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverSeasLegLength();
int SetOverSeasLegLength(int iOverSeasLegLength);

Unicode (Windows)
INT GetOverSeasLegLength();
INT SetOverSeasLegLength(INT iOverSeasLegLength);

int dshippingsdk_upsfreightrates_getoverseasleglength(void* lpObj);
int dshippingsdk_upsfreightrates_setoverseasleglength(void* lpObj, int iOverSeasLegLength);

int GetOverSeasLegLength();
int SetOverSeasLegLength(int iOverSeasLegLength);

Default Value

0

Remarks

The length of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

OverSeasLegPricePerCubicFoot Property (UPSFreightRates Class)

The price per CubicFoot.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOverSeasLegPricePerCubicFoot();
int SetOverSeasLegPricePerCubicFoot(const char* lpszOverSeasLegPricePerCubicFoot);

Unicode (Windows)
LPWSTR GetOverSeasLegPricePerCubicFoot();
INT SetOverSeasLegPricePerCubicFoot(LPCWSTR lpszOverSeasLegPricePerCubicFoot);

char* dshippingsdk_upsfreightrates_getoverseaslegpricepercubicfoot(void* lpObj);
int dshippingsdk_upsfreightrates_setoverseaslegpricepercubicfoot(void* lpObj, const char* lpszOverSeasLegPricePerCubicFoot);

QString GetOverSeasLegPricePerCubicFoot();
int SetOverSeasLegPricePerCubicFoot(QString qsOverSeasLegPricePerCubicFoot);

Default Value

""

Remarks

The price per CubicFoot.

Data Type

String

OverSeasLegPricePerCWT Property (UPSFreightRates Class)

Price per Hundredweight.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOverSeasLegPricePerCWT();
int SetOverSeasLegPricePerCWT(const char* lpszOverSeasLegPricePerCWT);

Unicode (Windows)
LPWSTR GetOverSeasLegPricePerCWT();
INT SetOverSeasLegPricePerCWT(LPCWSTR lpszOverSeasLegPricePerCWT);

char* dshippingsdk_upsfreightrates_getoverseaslegpricepercwt(void* lpObj);
int dshippingsdk_upsfreightrates_setoverseaslegpricepercwt(void* lpObj, const char* lpszOverSeasLegPricePerCWT);

QString GetOverSeasLegPricePerCWT();
int SetOverSeasLegPricePerCWT(QString qsOverSeasLegPricePerCWT);

Default Value

""

Remarks

Price per Hundredweight. For shipments with Puerto Rico as a destination, you may specify this amount before shipping.

Data Type

String

OverSeasLegTotalCubicFeet Property (UPSFreightRates Class)

Total cubic weight of the shipment, obtained by multiplying width by height by depth.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOverSeasLegTotalCubicFeet();
int SetOverSeasLegTotalCubicFeet(const char* lpszOverSeasLegTotalCubicFeet);

Unicode (Windows)
LPWSTR GetOverSeasLegTotalCubicFeet();
INT SetOverSeasLegTotalCubicFeet(LPCWSTR lpszOverSeasLegTotalCubicFeet);

char* dshippingsdk_upsfreightrates_getoverseaslegtotalcubicfeet(void* lpObj);
int dshippingsdk_upsfreightrates_setoverseaslegtotalcubicfeet(void* lpObj, const char* lpszOverSeasLegTotalCubicFeet);

QString GetOverSeasLegTotalCubicFeet();
int SetOverSeasLegTotalCubicFeet(QString qsOverSeasLegTotalCubicFeet);

Default Value

""

Remarks

Total cubic weight of the shipment, obtained by multiplying width by height by depth. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this amount before shipping.

Data Type

String

OverSeasLegWidth Property (UPSFreightRates Class)

The width of the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverSeasLegWidth();
int SetOverSeasLegWidth(int iOverSeasLegWidth);

Unicode (Windows)
INT GetOverSeasLegWidth();
INT SetOverSeasLegWidth(INT iOverSeasLegWidth);

int dshippingsdk_upsfreightrates_getoverseaslegwidth(void* lpObj);
int dshippingsdk_upsfreightrates_setoverseaslegwidth(void* lpObj, int iOverSeasLegWidth);

int GetOverSeasLegWidth();
int SetOverSeasLegWidth(int iOverSeasLegWidth);

Default Value

0

Remarks

The width of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

PayorAddress1 Property (UPSFreightRates Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorAddress1();
int SetPayorAddress1(const char* lpszPayorAddress1);

Unicode (Windows)
LPWSTR GetPayorAddress1();
INT SetPayorAddress1(LPCWSTR lpszPayorAddress1);

char* dshippingsdk_upsfreightrates_getpayoraddress1(void* lpObj);
int dshippingsdk_upsfreightrates_setpayoraddress1(void* lpObj, const char* lpszPayorAddress1);

QString GetPayorAddress1();
int SetPayorAddress1(QString qsPayorAddress1);

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. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorAddress2 Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorAddress2();
int SetPayorAddress2(const char* lpszPayorAddress2);

Unicode (Windows)
LPWSTR GetPayorAddress2();
INT SetPayorAddress2(LPCWSTR lpszPayorAddress2);

char* dshippingsdk_upsfreightrates_getpayoraddress2(void* lpObj);
int dshippingsdk_upsfreightrates_setpayoraddress2(void* lpObj, const char* lpszPayorAddress2);

QString GetPayorAddress2();
int SetPayorAddress2(QString qsPayorAddress2);

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorCity Property (UPSFreightRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorCity();
int SetPayorCity(const char* lpszPayorCity);

Unicode (Windows)
LPWSTR GetPayorCity();
INT SetPayorCity(LPCWSTR lpszPayorCity);

char* dshippingsdk_upsfreightrates_getpayorcity(void* lpObj);
int dshippingsdk_upsfreightrates_setpayorcity(void* lpObj, const char* lpszPayorCity);

QString GetPayorCity();
int SetPayorCity(QString qsPayorCity);

Default Value

""

Remarks

Name of city, town, etc.

Data Type

String

PayorCountryCode Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorCountryCode();
int SetPayorCountryCode(const char* lpszPayorCountryCode);

Unicode (Windows)
LPWSTR GetPayorCountryCode();
INT SetPayorCountryCode(LPCWSTR lpszPayorCountryCode);

char* dshippingsdk_upsfreightrates_getpayorcountrycode(void* lpObj);
int dshippingsdk_upsfreightrates_setpayorcountrycode(void* lpObj, const char* lpszPayorCountryCode);

QString GetPayorCountryCode();
int SetPayorCountryCode(QString qsPayorCountryCode);

Default Value

"US"

Remarks

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

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

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

Data Type

String

PayorName Property (UPSFreightRates Class)

Identifies the payor's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorName();
int SetPayorName(const char* lpszPayorName);

Unicode (Windows)
LPWSTR GetPayorName();
INT SetPayorName(LPCWSTR lpszPayorName);

char* dshippingsdk_upsfreightrates_getpayorname(void* lpObj);
int dshippingsdk_upsfreightrates_setpayorname(void* lpObj, const char* lpszPayorName);

QString GetPayorName();
int SetPayorName(QString qsPayorName);

Default Value

""

Remarks

Identifies the payor's name.

PayorName is required only if PayorType is set to 'THIRDPARTY'.

Note: This property is only applicable to UPSFreightRates and UPSFreightShip.

Data Type

String

PayorType Property (UPSFreightRates Class)

Method of payment for shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPayorType();
int SetPayorType(int iPayorType);

Unicode (Windows)
INT GetPayorType();
INT SetPayorType(INT iPayorType);

PT_SENDER(0), 
PT_RECIPIENT(1), 
PT_THIRD_PARTY(2), 
PT_COLLECT(3), 
PT_CONSIGNEE(4)

int dshippingsdk_upsfreightrates_getpayortype(void* lpObj);
int dshippingsdk_upsfreightrates_setpayortype(void* lpObj, int iPayorType);

int GetPayorType();
int SetPayorType(int iPayorType);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

PayorState Property (UPSFreightRates Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorState();
int SetPayorState(const char* lpszPayorState);

Unicode (Windows)
LPWSTR GetPayorState();
INT SetPayorState(LPCWSTR lpszPayorState);

char* dshippingsdk_upsfreightrates_getpayorstate(void* lpObj);
int dshippingsdk_upsfreightrates_setpayorstate(void* lpObj, const char* lpszPayorState);

QString GetPayorState();
int SetPayorState(QString qsPayorState);

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

PayorZipCode Property (UPSFreightRates Class)

Payor's postal code (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorZipCode();
int SetPayorZipCode(const char* lpszPayorZipCode);

Unicode (Windows)
LPWSTR GetPayorZipCode();
INT SetPayorZipCode(LPCWSTR lpszPayorZipCode);

char* dshippingsdk_upsfreightrates_getpayorzipcode(void* lpObj);
int dshippingsdk_upsfreightrates_setpayorzipcode(void* lpObj, const char* lpszPayorZipCode);

QString GetPayorZipCode();
int SetPayorZipCode(QString qsPayorZipCode);

Default Value

""

Remarks

Payor's postal code (if applicable).

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

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

Maximum length: 10.

Data Type

String

ProxyAuthScheme Property (UPSFreightRates 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_upsfreightrates_getproxyauthscheme(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getproxyautodetect(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getproxypassword(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getproxyport(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getproxyserver(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getproxyssl(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates Class)

This property contains a user name, 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_upsfreightrates_getproxyuser(void* lpObj);
int dshippingsdk_upsfreightrates_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a user name, 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

RecipientAddress1 Property (UPSFreightRates 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_upsfreightrates_getrecipientaddress1(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getrecipientaddress2(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getrecipientaddressflags(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getrecipientcity(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getrecipientcountrycode(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getrecipientstate(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getrecipientzipcode(void* lpObj);
int dshippingsdk_upsfreightrates_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

RecipientName Property (UPSFreightRates Class)

Identifies the recipient's name or company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientName();
int SetRecipientName(const char* lpszRecipientName);

Unicode (Windows)
LPWSTR GetRecipientName();
INT SetRecipientName(LPCWSTR lpszRecipientName);

char* dshippingsdk_upsfreightrates_getrecipientname(void* lpObj);
int dshippingsdk_upsfreightrates_setrecipientname(void* lpObj, const char* lpszRecipientName);

QString GetRecipientName();
int SetRecipientName(QString qsRecipientName);

Default Value

""

Remarks

The recipient's name or company name.

Data Type

String

RequestedService Property (UPSFreightRates Class)

The service selected for the shipment.

Syntax

• C++
• C
• Qt

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

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

ST_UPSFREIGHT(0), 
ST_UPSFREIGHT_GUARANTEED(1)

int dshippingsdk_upsfreightrates_getrequestedservice(void* lpObj);
int dshippingsdk_upsfreightrates_setrequestedservice(void* lpObj, int iRequestedService);

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

Default Value

0

Remarks

Specifies the service for the shipment.

Valid values for UPS Freight are:

Data Type

Integer

SenderAddress1 Property (UPSFreightRates 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_upsfreightrates_getsenderaddress1(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getsenderaddress2(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getsendercity(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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_upsfreightrates_getsendercountrycode(void* lpObj);
int dshippingsdk_upsfreightrates_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 (UPSFreightRates 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);

char* dshippingsdk_upsfreightrates_getsenderstate(void* lpObj);
int dshippingsdk_upsfreightrates_setsenderstate(void* lpObj, const char* lpszSenderState);

QString GetSenderState();
int SetSenderState(QString qsSenderState);

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

SenderZipCode Property (UPSFreightRates Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderZipCode();
int SetSenderZipCode(const char* lpszSenderZipCode);

Unicode (Windows)
LPWSTR GetSenderZipCode();
INT SetSenderZipCode(LPCWSTR lpszSenderZipCode);

char* dshippingsdk_upsfreightrates_getsenderzipcode(void* lpObj);
int dshippingsdk_upsfreightrates_setsenderzipcode(void* lpObj, const char* lpszSenderZipCode);

QString GetSenderZipCode();
int SetSenderZipCode(QString qsSenderZipCode);

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 SenderCity and SenderState are not present.

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

Data Type

String

SenderName Property (UPSFreightRates Class)

Identifies the sender's locations name or company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderName();
int SetSenderName(const char* lpszSenderName);

Unicode (Windows)
LPWSTR GetSenderName();
INT SetSenderName(LPCWSTR lpszSenderName);

char* dshippingsdk_upsfreightrates_getsendername(void* lpObj);
int dshippingsdk_upsfreightrates_setsendername(void* lpObj, const char* lpszSenderName);

QString GetSenderName();
int SetSenderName(QString qsSenderName);

Default Value

""

Remarks

Data Type

String

SSLAcceptServerCertEncoded Property (UPSFreightRates Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dshippingsdk_upsfreightrates_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dshippingsdk_upsfreightrates_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (UPSFreightRates Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dshippingsdk_upsfreightrates_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dshippingsdk_upsfreightrates_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dshippingsdk_upsfreightrates_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dshippingsdk_upsfreightrates_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dshippingsdk_upsfreightrates_getsslcertstorepassword(void* lpObj);
int dshippingsdk_upsfreightrates_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (UPSFreightRates Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dshippingsdk_upsfreightrates_getsslcertstoretype(void* lpObj);
int dshippingsdk_upsfreightrates_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dshippingsdk_upsfreightrates_getsslcertsubject(void* lpObj);
int dshippingsdk_upsfreightrates_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (UPSFreightRates Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dshippingsdk_upsfreightrates_getsslprovider(void* lpObj);
int dshippingsdk_upsfreightrates_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (UPSFreightRates Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dshippingsdk_upsfreightrates_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

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

Data Type

Binary String

Timeout Property (UPSFreightRates Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dshippingsdk_upsfreightrates_gettimeout(void* lpObj);
int dshippingsdk_upsfreightrates_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalCharge Property (UPSFreightRates Class)

Represents the total shipment charge.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalCharge();

Unicode (Windows)
LPWSTR GetTotalCharge();

char* dshippingsdk_upsfreightrates_gettotalcharge(void* lpObj);

QString GetTotalCharge();

Default Value

""

Remarks

This property holds the total charge associated with the shipment. The value is represented in dollars and cents with two decimal places. For instance "1500.25".

This property is read-only.

Data Type

String

UPSAccountNumber Property (UPSFreightRates Class)

The shipper's UPS account number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUPSAccountNumber();
int SetUPSAccountNumber(const char* lpszUPSAccountNumber);

Unicode (Windows)
LPWSTR GetUPSAccountNumber();
INT SetUPSAccountNumber(LPCWSTR lpszUPSAccountNumber);

char* dshippingsdk_upsfreightrates_getupsaccountnumber(void* lpObj);
int dshippingsdk_upsfreightrates_setupsaccountnumber(void* lpObj, const char* lpszUPSAccountNumber);

QString GetUPSAccountNumber();
int SetUPSAccountNumber(QString qsUPSAccountNumber);

Default Value

""

Remarks

The shipper's UPS account number.

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

Data Type

String

UPSAuthorizationToken Property (UPSFreightRates Class)

Authorization Token used to authenticate the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUPSAuthorizationToken();
int SetUPSAuthorizationToken(const char* lpszUPSAuthorizationToken);

Unicode (Windows)
LPWSTR GetUPSAuthorizationToken();
INT SetUPSAuthorizationToken(LPCWSTR lpszUPSAuthorizationToken);

char* dshippingsdk_upsfreightrates_getupsauthorizationtoken(void* lpObj);
int dshippingsdk_upsfreightrates_setupsauthorizationtoken(void* lpObj, const char* lpszUPSAuthorizationToken);

QString GetUPSAuthorizationToken();
int SetUPSAuthorizationToken(QString qsUPSAuthorizationToken);

Default Value

""

Remarks

Authorization Token used to authenticate the request.

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

Data Type

String

UPSServer Property (UPSFreightRates Class)

URL for the UPS server where the requests are sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUPSServer();
int SetUPSServer(const char* lpszUPSServer);

Unicode (Windows)
LPWSTR GetUPSServer();
INT SetUPSServer(LPCWSTR lpszUPSServer);

char* dshippingsdk_upsfreightrates_getupsserver(void* lpObj);
int dshippingsdk_upsfreightrates_setupsserver(void* lpObj, const char* lpszUPSServer);

QString GetUPSServer();
int SetUPSServer(QString qsUPSServer);

Default Value

""

Remarks

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

Normally, you do not need to set this property, by default the componernt will send the requests to the preset production end-point. You can utilize the TestMode Config to switch from production to testing.

The following URLs may be used for testing:

Data Type

String

Config Method (UPSFreightRates Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dshippingsdk_upsfreightrates_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetRates Method (UPSFreightRates Class)

Returns rate information for a specified or all available UPS RequestedService s.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRates();

Unicode (Windows)
INT GetRates();

int dshippingsdk_upsfreightrates_getrates(void* lpObj);

int GetRates();

Remarks

To get the courtesy rate quotes for UPS services, you can call the GetRates method. The RequestedService property identifies the UPS service for which you want to retrieve rate information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (UPSFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dshippingsdk_upsfreightrates_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (UPSFreightRates Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(UPSFreightRatesErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} UPSFreightRatesErrorEventParams;


Unicode (Windows)
virtual INT FireError(UPSFreightRatesErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} UPSFreightRatesErrorEventParams;

#define EID_UPSFREIGHTRATES_ERROR 1

virtual INT DSHIPPINGSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class UPSFreightRatesErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(UPSFreightRatesErrorEventParams *e);

// Or, subclass UPSFreightRates and override this emitter function.
virtual int FireError(UPSFreightRatesErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (UPSFreightRates Class)

Notification returned by the server upon successful request (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(UPSFreightRatesNotificationEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} UPSFreightRatesNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(UPSFreightRatesNotificationEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} UPSFreightRatesNotificationEventParams;

#define EID_UPSFREIGHTRATES_NOTIFICATION 2

virtual INT DSHIPPINGSDK_CALL FireNotification(LPSTR &lpszMessage);

class UPSFreightRatesNotificationEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(UPSFreightRatesNotificationEventParams *e);

// Or, subclass UPSFreightRates and override this emitter function.
virtual int FireNotification(UPSFreightRatesNotificationEventParams *e) {...}

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (UPSFreightRates Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(UPSFreightRatesSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} UPSFreightRatesSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(UPSFreightRatesSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} UPSFreightRatesSSLServerAuthenticationEventParams;

#define EID_UPSFREIGHTRATES_SSLSERVERAUTHENTICATION 3

virtual INT DSHIPPINGSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class UPSFreightRatesSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(UPSFreightRatesSSLServerAuthenticationEventParams *e);

// Or, subclass UPSFreightRates and override this emitter function.
virtual int FireSSLServerAuthentication(UPSFreightRatesSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (UPSFreightRates Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(UPSFreightRatesSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} UPSFreightRatesSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(UPSFreightRatesSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} UPSFreightRatesSSLStatusEventParams;

#define EID_UPSFREIGHTRATES_SSLSTATUS 4

virtual INT DSHIPPINGSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class UPSFreightRatesSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(UPSFreightRatesSSLStatusEventParams *e);

// Or, subclass UPSFreightRates and override this emitter function.
virtual int FireSSLStatus(UPSFreightRatesSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (UPSFreightRates Class)