UPSUserId Property

User Id for logging in to UPS.

Syntax

 upsship.getUPSUserId([callback])
 upsship.setUPSUserId( UPSUserId, [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 getUPSUserId([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 setUPSUserId([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

User Id for logging in to UPS. A UPSUserId and UPSPassword will be required with each request made to UPS. These are used to authenticate the client system during login.

The UserId is the one you chose to login with when you registered for service with UPS. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Sharing the security elements (UPSUserId, UPSPassword, UPSAccessKey, and UPSDeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement.

Maximum length: 16.

Data Type

String