Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

CanadaPostServer Property

URL for the server where the requests are sent.

Syntax

 canadaposttrack.getCanadaPostServer([callback])
 canadaposttrack.setCanadaPostServer( canadaPostServer, [callback])

Default Value

"https://soa-gw.canadapost.ca/"


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 getCanadaPostServer([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 setCanadaPostServer([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

URL for the server where the requests are sent.

By default this is set to Canada Post's production server: "https://soa-gw.canadapost.ca/"

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0