LabelImageType Property

Type of label image.

Syntax

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

Possible Values

  0 (sitNone), 
  1 (sitTIF), 
  2 (sitJPG), 
  3 (sitPDF), 
  4 (sitGIF), 
  5 (sitEPL), 
  6 (sitPNG), 
  7 (sitZPL), 
  8 (sitPDFVector), 
  9 (sitPDFVectorWithFonts)

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

The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:


sitNone (0)	Enter itNone if a label is not desired. (Only the PackageTrackingNumber will be returned).
sitTIF (1)	Tagged Image File format (bitmap)
sitJPG (2)	Joint Photographic expert Group format (used only by Endicia)
sitPDF (3)	Adobe Acrobat's Portable Document Format
sitGIF (4)	CompuServe's Graphics Interchange Format
sitEPL (5)	EPL2 format (used only by Endicia)
sitPNG (6)	PNG image (used only by Endicia)
sitZPL (7)	ZPLII format (used only by Endicia)
sitPDFVector (8)	PDFVector format (used only by Endicia)
sitPDFVectorWithFonts (9)	PDFVectorWithFonts format (used only by Endicia)

Note that all USPS shipping types support sitTIF and sitPDF LabelImageTypes except stUSPSExpress ServiceType, which supports sitGIF and sitPDF.

sitTIF is not a valid value for Stamps.com.

Also, if you use the sitTIF LabelImageType, make sure your image reader is able to view multiple pages inside of a Tagged Image Format File (TIFF) file. The TIFF Files returned from USPS may contain up to 6 pages of image data.

Valid values when using Endicia are sitEPL, sitGIF, sitJPG, sitPNG, and sitZPL, when the ServiceType is stUSPSFirstClass, stUSPSPriority, stUSPSLibrary, stUSPSMedia, or stUSPSParcelPost otherwise, only sitGIF, sitJPG, and sitPNG are supported.

Data Type

Integer