CODTotalAmount Property
The total amount to be collected on shipment level.
Syntax
upsshipintl.getCODTotalAmount([callback]) upsshipintl.setCODTotalAmount( CODTotalAmount, [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 getCODTotalAmount([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 setCODTotalAmount([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 indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).
For MPS COD shipments (when Packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the PackageCODAmount.
Format: Two explicit decimals (e.g.5.00).
Data Type
String