PickupPaymentMethod Property

The method of payment for a pickup.

Syntax

 upsship.getPickupPaymentMethod([callback])
 upsship.setPickupPaymentMethod( pickupPaymentMethod, [callback])

Possible Values

  0 (ppmNone), 
  1 (ppmAccount), 
  2 (ppmTrackingNumber), 
  3 (ppmCheckOrMoneyOrder)

Default Value

1

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 getPickupPaymentMethod([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 setPickupPaymentMethod([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

This indicates how the pickup will be paid for.

The valid values are as follows:

Data Type

Integer