PostageProvider Property

The postage provider to use.

Syntax

 uspsrates.getPostageProvider([callback])
 uspsrates.setPostageProvider( postageProvider, [callback])

Possible Values

  0 (ppNone), 
  1 (ppEndicia), 
  2 (ppStamps)

Default Value

0

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 getPostageProvider([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 setPostageProvider([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

When set to none, the class will communicate with USPS servers to get rates and print labels. USPS web services do not provide postage.

If postage is necessary, set this property to ppEndicia to use Endicia's web services which provides postage. In order to use this provider, an Endicia account must be set up through their website.

Once you have an Endicia USPSAccountNumber, you should also have obtained a USPSUserId and USPSPassword uniquely assigned to your account by Endicia. These values are all necessary to get rates and shipping labels through their web services.

Data Type

Integer