RateType Property

Indicates the type of rates to be returned.

Syntax

 fedexrates.getRateType([callback])
 fedexrates.setRateType( rateType, [callback])

Possible Values

  0 (rtList), 
  1 (rtAccount)

Default Value

0

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 getRateType([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 setRateType([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

Possible values are as follows:

If you request list rates, you must set the RateType to 0 (rtList) and you will receive both the discount and list rate quote in the reply. List rates are available for Express and Ground U.S. shipments.

If you request the discount rate, you must set the RateType to 1 (rtAccount), and the class will return only discount rates that are applicable to your FedEx account. Discount rates are available for all services and origin/destination pairs.

Data Type

Integer