OriginPostalCode Property
The Postal Code of the client sending location when using the Canada Post provider.
Syntax
canadapostship.getOriginPostalCode([callback]) canadapostship.setOriginPostalCode( originPostalCode, [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 getOriginPostalCode([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 setOriginPostalCode([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 is used to specify the postal code of the client sending location to determine the nearest Post Office (this information is used for pricing). To force selection of a particular Post Office, the postal code of the desired Post Office should be used.
If packages are picked up by Canada Post enter the postal code of your location.
This must be set to a valid six character postal code such as A9A9A9
Note: This value is only used when a CanadaPostContractId is specified.
Data Type
String