LabelOption Property

Indicates type of label the USPS Server will return.

Syntax

 uspsship.getLabelOption([callback])
 uspsship.setLabelOption( labelOption, [callback])

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 getLabelOption([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 setLabelOption([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

For Delivery and Signature confirmation, the USPS Server may return either an entire label with the 'To' and 'From' address and the confirmation barcode, or a label with only the barcode and tracking number may be returned. Label options 1 and 2 are available for both Delivery Confirmation labels and Signature Confirmation labels. Detailed descriptions of these label options are included below.


Option	Description
1	A graphic image is returned that will include a barcode, a delivery or signature confirmation number (PackageTrackingNumber) with return name and address and delivery name and address;
2	A graphic image is returned that will include a barcode and a delivery confirmation number (PackageTrackingNumber) without the return and delivery name and address. This option is convenient for shippers who already have mailing labels and just want the Confirmation barcode.

Data Type

String