CanadaPostAccountNumber Property

The shipper's account number.

Syntax

 canadapostrates.getCanadaPostAccountNumber([callback])
 canadapostrates.setCanadaPostAccountNumber( canadaPostAccountNumber, [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 getCanadaPostAccountNumber([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 setCanadaPostAccountNumber([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 shipper's account number.

This property should be set to the customer number of the owner of the mail (mailed on behalf of customer).

Data Type

String