CommodityFreightPackagingType Property

Identifies the Commodity item's packaging type.

Syntax

 upsfreightrates.getCommodityFreightPackagingType(index, [callback])
 upsfreightrates.setCommodityFreightPackagingType(index,  commodityFreightPackagingType, [callback])

Possible Values

  0 (cptBag), 
  1 (cptBale), 
  2 (cptBarrel), 
  3 (cptBundle), 
  4 (cptBin), 
  5 (cptBox), 
  6 (cptBasket), 
  7 (cptBunch), 
  8 (cptCabinet), 
  9 (cptCan), 
  10 (cptCarrier), 
  11 (cptCase), 
  12 (cptCarboy), 
  13 (cptContainer), 
  14 (cptCrate), 
  15 (cptCask), 
  16 (cptCarton), 
  17 (cptCylinder), 
  18 (cptDrum), 
  19 (cptLoose), 
  20 (cptOther), 
  21 (cptPail), 
  22 (cptPieces), 
  23 (cptPackage), 
  24 (cptPipe), 
  25 (cpt), 
  26 (cptPallet), 
  27 (cptRack), 
  28 (cptReel), 
  29 (cptRoll), 
  30 (cptSkid), 
  31 (cptSpool), 
  32 (cptTube), 
  33 (cptTank), 
  34 (cptUnit), 
  35 (cptVanPack), 
  36 (cptWrapped)

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 getCommodityFreightPackagingType([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 setCommodityFreightPackagingType([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

Identifies the Commodity item's packaging type. Possible values are:

NOTE: This property is only applicable to UPS freight.

The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer