USPSUserId Property

User Id for logging in to the USPS Server .

Syntax

 uspsship.getUSPSUserId([callback])
 uspsship.setUSPSUserId( USPSUserId, [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 getUSPSUserId([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 setUSPSUserId([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 the USPS Server.

This User Id is provided to you by USPS when you register for service. The UserId 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.

When PostageProvider has been set to ppEndicia, this must be the Requester Id (also called the Partner Id) associated with your postage account that was supplied to you by Endicia upon registration.

Data Type

String