LabelImageType Property

Type of image or printer commands the shipping label is to be formatted in.

Syntax

 upsshipintl.getLabelImageType([callback])
 upsshipintl.setLabelImageType( labelImageType, [callback])

Possible Values

  0 (uitGIF), 
  1 (uitEPL), 
  2 (uitSPL), 
  3 (uitZPL), 
  4 (uitStar)

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 getLabelImageType([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 setLabelImageType([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 element defines the print method code that the labels are to be generated to. It is applicable and required to be provided in a ship request for forward shipments or return shipments. The value selection depends on the printer type used to print the shipping label.

Valid image types and their meanings with the corresponding usage are listed below:


Value	Usage
uitGIF(0)	To be used for image formats.
uitEPL (1)	To be used with EPL2 formatted labels.
uitSPL (2)	To be used with SPL formatted labels.
uitZPL (3)	To be used with ZPL formatted labels.
uitStar (4)	To be used with STAR printer formatted labels. Not a valid image type when using Mail Innovations.

There are two types of shipping labels supported: plain paper (when printing to an HP compatible laser or inkjet type printer only. In this case, the only possible value for the LabelImageType is 0 (litGIF)), and thermal (when printing to thermal printers only. In this case, possible values for the LabelImageType are 1, 2, 3 and 4).

While the content of each of these labels is the same, their usages are different. Each provides a bar-coded image for the purpose of scanning the package during handling. The uses of each label depend on the type of working environment to be used.

Data Type

Integer