CODType Property

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

Syntax

 upsrates.getCODType([callback])
 upsrates.setCODType( CODType, [callback])

Possible Values

  0 (codtsCash), 
  1 (codtsCheck)

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 getCODType([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 setCODType([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

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

Valid values are:

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

Data Type

Integer