PickupType Property

Pickup type used for the shipment that rate is requested for.

Syntax

 upsrates.getPickupType([callback])
 upsrates.setPickupType( pickupType, [callback])

Possible Values

  0 (ptDailyPickup), 
  1 (ptCustomerCounter), 
  2 (ptOneTimePickup), 
  3 (ptOnCallAir), 
  4 (ptLetterCenter), 
  5 (ptAirServiceCenter), 
  6 (ptNoneType)

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 getPickupType([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 setPickupType([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

The rates depend on the combination of PickupType and CustomerType.

Valid values are:

Data Type

Integer