RecipientPostalCode Property

This is identifies of a region (usually small) for mail/package delivery.

Syntax

 canadapostshipintl.getRecipientPostalCode([callback])
 canadapostshipintl.setRecipientPostalCode( recipientPostalCode, [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 getRecipientPostalCode([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 setRecipientPostalCode([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 is identifies of a region (usually small) for mail/package delivery. Format and presence of this property will vary, depending on country. The format for Canadian postal codes is A9A9A9.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientProvince are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 14.

Data Type

String