CustomerReceiptFile Property

Filename for CustomerReceipt (optional).

Syntax

 uspsship.getCustomerReceiptFile([callback])
 uspsship.setCustomerReceiptFile( customerReceiptFile, [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 getCustomerReceiptFile([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 setCustomerReceiptFile([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

When this property is set to a valid filename, the contents of the CustomerReceipt property are written into the file.

The file will be saved in the format defined by the value of LabelImageType property, and the filename should include the appropriate extension.

Data Type

String