PickupContainerType Property

The type of container to be picked up.

Syntax

 upsship.getPickupContainerType([callback])
 upsship.setPickupContainerType( pickupContainerType, [callback])

Possible Values

  0 (pccPackage), 
  1 (pccLetter), 
  2 (pccPallet)

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 getPickupContainerType([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 setPickupContainerType([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 what type of container is being picked up.

Note the pccPallet is only valid if ServiceType is set to stUPSWorldwideExpressFreight.

Data Type

Integer