ChargeDescription Property
The description of the rate.
Syntax
upsfreightrates.getChargeDescription(index, [callback]) upsfreightrates.setChargeDescription(index, chargeDescription, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getChargeDescription([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setChargeDescription([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
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:
Fuel Surcharge | |
Arrival Notification | |
Amount after Discount | |
Border Processing Fee | |
Custom Manifest Fee | |
Collect on Delivery fee | |
Construction Site Delivery | |
Deficit Rate | |
Deficit Weight | |
Deficit Charge | |
Discounted Amount | |
Discount Rate (as a percentage) | |
Hazardous Materials Charge | |
High Cost Service Area Surcharge | |
Holiday/Weekend Pickup or Delivery | |
Inside Pickup/Delivery | |
Custom Charge | |
Liftgate Fee | |
Gross Charges | |
Minimum Charge Applies | |
Ocean Fuel Surcharge | |
Residential Pickup/Delivery | |
Remote Location Fee | |
Sorting and Segregation | |
Total Island Charges | |
Total Ocean Charges |
The size of the array is controlled by the ChargeCount property.
This property is not available at design time.
Data Type
String