UPSFreightRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Rates service.

Class Name

DShippingSDK_UPSFreightRates

Procedural Interface

 dshippingsdk_upsfreightrates_open();
 dshippingsdk_upsfreightrates_close($res);
 dshippingsdk_upsfreightrates_register_callback($res, $id, $function);
 dshippingsdk_upsfreightrates_get_last_error($res);
 dshippingsdk_upsfreightrates_get_last_error_code($res);
 dshippingsdk_upsfreightrates_set($res, $id, $index, $value);
 dshippingsdk_upsfreightrates_get($res, $id, $index);
 dshippingsdk_upsfreightrates_do_config($res, $configurationstring);
 dshippingsdk_upsfreightrates_do_getrates($res);
 dshippingsdk_upsfreightrates_do_reset($res);

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 (DShippingSDK_UPSFreightRates Class)

Represents the billable weight associated with the shipment.

Object Oriented Interface

public function getBillableWeight();

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 1 );

Default Value

''

Remarks

This property is read-only.

Data Type

String

ChargeCount Property (DShippingSDK_UPSFreightRates Class)

The number of records in the Charge arrays.

Object Oriented Interface

public function getChargeCount();


public function setChargeCount($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 2 );


dshippingsdk_upsfreightrates_set($res, 2, $value );

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 (DShippingSDK_UPSFreightRates Class)

Indicates the type of the charge.

Object Oriented Interface

public function getChargeType($chargeindex);


public function setChargeType($chargeindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 3 , $chargeindex);


dshippingsdk_upsfreightrates_set($res, 3, $value , $chargeindex);

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 (DShippingSDK_UPSFreightRates Class)

The description of the rate.

Object Oriented Interface

public function getChargeDescription($chargeindex);


public function setChargeDescription($chargeindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 4 , $chargeindex);


dshippingsdk_upsfreightrates_set($res, 4, $value , $chargeindex);

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 (DShippingSDK_UPSFreightRates Class)

The value of the charge type specified by ChargeType .

Object Oriented Interface

public function getChargeValue($chargeindex);


public function setChargeValue($chargeindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 5 , $chargeindex);


dshippingsdk_upsfreightrates_set($res, 5, $value , $chargeindex);

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getCODPayorType();


public function setCODPayorType($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 6 );


dshippingsdk_upsfreightrates_set($res, 6, $value );

Default Value

0

Remarks

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

Data Type

Integer

CODTotalAmount Property (DShippingSDK_UPSFreightRates Class)

The total amount of additional fees.

Object Oriented Interface

public function getCODTotalAmount();


public function setCODTotalAmount($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 7 );


dshippingsdk_upsfreightrates_set($res, 7, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getCODType();


public function setCODType($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 8 );


dshippingsdk_upsfreightrates_set($res, 8, $value );

Default Value

0

Remarks

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

Data Type

Integer

CommodityCount Property (DShippingSDK_UPSFreightRates Class)

The number of records in the Commodity arrays.

Object Oriented Interface

public function getCommodityCount();


public function setCommodityCount($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 9 );


dshippingsdk_upsfreightrates_set($res, 9, $value );

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 (DShippingSDK_UPSFreightRates Class)

Complete and accurate description of this commodity line item.

Object Oriented Interface

public function getCommodityDescription($commodityindex);


public function setCommodityDescription($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 10 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 10, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

Indicates the freight class of the commodity.

Object Oriented Interface

public function getCommodityFreightClass($commodityindex);


public function setCommodityFreightClass($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 12 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 12, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

Identifies if the Commodity item is hazardous.

Object Oriented Interface

public function getCommodityFreightIsHazardous($commodityindex);


public function setCommodityFreightIsHazardous($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 13 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 13, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

Identifies the National Motor Freight Classification numbers.

Object Oriented Interface

public function getCommodityFreightNMFC($commodityindex);


public function setCommodityFreightNMFC($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 14 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 14, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

Identifies the sub code of National Motor Freight Classification numbers.

Object Oriented Interface

public function getCommodityFreightNMFCSub($commodityindex);


public function setCommodityFreightNMFCSub($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 15 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 15, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

Identifies the Commodity item's packaging type.

Object Oriented Interface

public function getCommodityFreightPackagingType($commodityindex);


public function setCommodityFreightPackagingType($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 16 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 16, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getCommodityNumberOfPieces($commodityindex);


public function setCommodityNumberOfPieces($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 19 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 19, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

The value of an individual item being shipped.

Object Oriented Interface

public function getCommodityValue($commodityindex);


public function setCommodityValue($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 26 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 26, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getCommodityWeight($commodityindex);


public function setCommodityWeight($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 27 , $commodityindex);


dshippingsdk_upsfreightrates_set($res, 27, $value , $commodityindex);

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 (DShippingSDK_UPSFreightRates Class)

Represents the dimensional weight associated with the shipment.

Object Oriented Interface

public function getDimensionalWeight();

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 28 );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 29 );


dshippingsdk_upsfreightrates_set($res, 29, $value );

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 (DShippingSDK_UPSFreightRates Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 30 );


dshippingsdk_upsfreightrates_set($res, 30, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 31 );


dshippingsdk_upsfreightrates_set($res, 31, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 32 );


dshippingsdk_upsfreightrates_set($res, 32, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 33 );


dshippingsdk_upsfreightrates_set($res, 33, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 34 );


dshippingsdk_upsfreightrates_set($res, 34, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getHandlingUnit();


public function setHandlingUnit($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 35 );


dshippingsdk_upsfreightrates_set($res, 35, $value );

Default Value

''

Remarks

Data Type

String

OverSeasLegHeight Property (DShippingSDK_UPSFreightRates Class)

The height of the shipment.

Object Oriented Interface

public function getOverSeasLegHeight();


public function setOverSeasLegHeight($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 36 );


dshippingsdk_upsfreightrates_set($res, 36, $value );

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 (DShippingSDK_UPSFreightRates Class)

The length of the shipment.

Object Oriented Interface

public function getOverSeasLegLength();


public function setOverSeasLegLength($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 37 );


dshippingsdk_upsfreightrates_set($res, 37, $value );

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 (DShippingSDK_UPSFreightRates Class)

The price per CubicFoot.

Object Oriented Interface

public function getOverSeasLegPricePerCubicFoot();


public function setOverSeasLegPricePerCubicFoot($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 38 );


dshippingsdk_upsfreightrates_set($res, 38, $value );

Default Value

''

Remarks

The price per CubicFoot.

Data Type

String

OverSeasLegPricePerCWT Property (DShippingSDK_UPSFreightRates Class)

Price per Hundredweight.

Object Oriented Interface

public function getOverSeasLegPricePerCWT();


public function setOverSeasLegPricePerCWT($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 39 );


dshippingsdk_upsfreightrates_set($res, 39, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getOverSeasLegTotalCubicFeet();


public function setOverSeasLegTotalCubicFeet($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 40 );


dshippingsdk_upsfreightrates_set($res, 40, $value );

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 (DShippingSDK_UPSFreightRates Class)

The width of the shipment.

Object Oriented Interface

public function getOverSeasLegWidth();


public function setOverSeasLegWidth($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 41 );


dshippingsdk_upsfreightrates_set($res, 41, $value );

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 (DShippingSDK_UPSFreightRates Class)

Street name.

Object Oriented Interface

public function getPayorAddress1();


public function setPayorAddress1($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 43 );


dshippingsdk_upsfreightrates_set($res, 43, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getPayorAddress2();


public function setPayorAddress2($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 44 );


dshippingsdk_upsfreightrates_set($res, 44, $value );

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 (DShippingSDK_UPSFreightRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getPayorCity();


public function setPayorCity($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 45 );


dshippingsdk_upsfreightrates_set($res, 45, $value );

Default Value

''

Remarks

Name of city, town, etc.

Data Type

String

PayorCountryCode Property (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getPayorCountryCode();


public function setPayorCountryCode($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 46 );


dshippingsdk_upsfreightrates_set($res, 46, $value );

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 (DShippingSDK_UPSFreightRates Class)

Identifies the payor's name.

Object Oriented Interface

public function getPayorName();


public function setPayorName($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 47 );


dshippingsdk_upsfreightrates_set($res, 47, $value );

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 (DShippingSDK_UPSFreightRates Class)

Method of payment for shipment, or duties and taxes.

Object Oriented Interface

public function getPayorType();


public function setPayorType($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 48 );


dshippingsdk_upsfreightrates_set($res, 48, $value );

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 (DShippingSDK_UPSFreightRates Class)

State or province code.

Object Oriented Interface

public function getPayorState();


public function setPayorState($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 49 );


dshippingsdk_upsfreightrates_set($res, 49, $value );

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 (DShippingSDK_UPSFreightRates Class)

Payor's postal code (if applicable).

Object Oriented Interface

public function getPayorZipCode();


public function setPayorZipCode($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 50 );


dshippingsdk_upsfreightrates_set($res, 50, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 51 );


dshippingsdk_upsfreightrates_set($res, 51, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 52 );


dshippingsdk_upsfreightrates_set($res, 52, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 53 );


dshippingsdk_upsfreightrates_set($res, 53, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 54 );


dshippingsdk_upsfreightrates_set($res, 54, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 55 );


dshippingsdk_upsfreightrates_set($res, 55, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 56 );


dshippingsdk_upsfreightrates_set($res, 56, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 57 );


dshippingsdk_upsfreightrates_set($res, 57, $value );

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 (DShippingSDK_UPSFreightRates Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 58 );


dshippingsdk_upsfreightrates_set($res, 58, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getRecipientAddress2();


public function setRecipientAddress2($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 59 );


dshippingsdk_upsfreightrates_set($res, 59, $value );

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 (DShippingSDK_UPSFreightRates Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 60 );


dshippingsdk_upsfreightrates_set($res, 60, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_UPSFreightRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 61 );


dshippingsdk_upsfreightrates_set($res, 61, $value );

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 (DShippingSDK_UPSFreightRates Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 62 );


dshippingsdk_upsfreightrates_set($res, 62, $value );

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 (DShippingSDK_UPSFreightRates Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 63 );


dshippingsdk_upsfreightrates_set($res, 63, $value );

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 (DShippingSDK_UPSFreightRates Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 64 );


dshippingsdk_upsfreightrates_set($res, 64, $value );

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 (DShippingSDK_UPSFreightRates Class)

Identifies the recipient's name or company name.

Object Oriented Interface

public function getRecipientName();


public function setRecipientName($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 65 );


dshippingsdk_upsfreightrates_set($res, 65, $value );

Default Value

''

Remarks

The recipient's name or company name.

Data Type

String

RequestedService Property (DShippingSDK_UPSFreightRates Class)

The service selected for the shipment.

Object Oriented Interface

public function getRequestedService();


public function setRequestedService($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 66 );


dshippingsdk_upsfreightrates_set($res, 66, $value );

Default Value

0

Remarks

Specifies the service for the shipment.

Valid values for UPS Freight are:

Data Type

Integer

SenderAddress1 Property (DShippingSDK_UPSFreightRates Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 67 );


dshippingsdk_upsfreightrates_set($res, 67, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getSenderAddress2();


public function setSenderAddress2($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 68 );


dshippingsdk_upsfreightrates_set($res, 68, $value );

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 (DShippingSDK_UPSFreightRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 70 );


dshippingsdk_upsfreightrates_set($res, 70, $value );

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 (DShippingSDK_UPSFreightRates Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 71 );


dshippingsdk_upsfreightrates_set($res, 71, $value );

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 (DShippingSDK_UPSFreightRates Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 72 );


dshippingsdk_upsfreightrates_set($res, 72, $value );

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 (DShippingSDK_UPSFreightRates Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 73 );


dshippingsdk_upsfreightrates_set($res, 73, $value );

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 (DShippingSDK_UPSFreightRates Class)

Identifies the sender's locations name or company name.

Object Oriented Interface

public function getSenderName();


public function setSenderName($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 74 );


dshippingsdk_upsfreightrates_set($res, 74, $value );

Default Value

''

Remarks

Data Type

String

SSLAcceptServerCertEncoded Property (DShippingSDK_UPSFreightRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 76 );


dshippingsdk_upsfreightrates_set($res, 76, $value );

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 (DShippingSDK_UPSFreightRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 104 );


dshippingsdk_upsfreightrates_set($res, 104, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 120 );


dshippingsdk_upsfreightrates_set($res, 120, $value );

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 designations are the most common User and Machine certificate stores in Windows:

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

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_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.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 121 );


dshippingsdk_upsfreightrates_set($res, 121, $value );

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 (DShippingSDK_UPSFreightRates Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 122 );


dshippingsdk_upsfreightrates_set($res, 122, $value );

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 123 );


dshippingsdk_upsfreightrates_set($res, 123, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DShippingSDK_UPSFreightRates Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 131 );


dshippingsdk_upsfreightrates_set($res, 131, $value );

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 (DShippingSDK_UPSFreightRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 133 );

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 (DShippingSDK_UPSFreightRates Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 160 );


dshippingsdk_upsfreightrates_set($res, 160, $value );

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 (DShippingSDK_UPSFreightRates Class)

Represents the total shipment charge.

Object Oriented Interface

public function getTotalCharge();

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 161 );

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 (DShippingSDK_UPSFreightRates Class)

The shipper's UPS account number.

Object Oriented Interface

public function getUPSAccountNumber();


public function setUPSAccountNumber($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 162 );


dshippingsdk_upsfreightrates_set($res, 162, $value );

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 (DShippingSDK_UPSFreightRates Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getUPSAuthorizationToken();


public function setUPSAuthorizationToken($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 163 );


dshippingsdk_upsfreightrates_set($res, 163, $value );

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 (DShippingSDK_UPSFreightRates Class)

URL for the UPS server where the requests are sent.

Object Oriented Interface

public function getUPSServer();


public function setUPSServer($value);

Procedural Interface

dshippingsdk_upsfreightrates_get($res, 164 );


dshippingsdk_upsfreightrates_set($res, 164, $value );

Default Value

''

Remarks

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

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

The following URLs may be used for testing:

Data Type

String

Config Method (DShippingSDK_UPSFreightRates Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_upsfreightrates_do_config($res, $configurationstring);

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.

GetRates Method (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function doGetRates();

Procedural Interface

dshippingsdk_upsfreightrates_do_getrates($res);

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.

Reset Method (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_upsfreightrates_do_reset($res);

Remarks

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

Error Event (DShippingSDK_UPSFreightRates Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_upsfreightrates_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (DShippingSDK_UPSFreightRates Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_upsfreightrates_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'message'

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 (DShippingSDK_UPSFreightRates Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_upsfreightrates_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (DShippingSDK_UPSFreightRates Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_upsfreightrates_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (UPSFreightRates Class)

UPSFreightRates Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings