UPSServer Property

URL for the UPS server where the requests are sent.

Syntax

 upsship.getUPSServer([callback])
 upsship.setUPSServer( UPSServer, [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 getUPSServer([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 setUPSServer([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 UPS server where the requests are sent.

Each request requires specific processing based on the type; therefore, each component has a unique URL for connection purposes.

The following URLs may be used for testing:

In a production environment, the URL for connecting to a UPS server (production environment) will be provided to you by UPS when you subscribe for UPS OnLine Tools.

Data Type

String