PackageReturnReceipt Property

Image of the receipt for a return shipment.

Syntax

 upsship.getPackageReturnReceipt(index, [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 getPackageReturnReceipt([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setPackageReturnReceipt([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

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the PackageReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

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

This property is read-only and not available at design time.

Data Type

Buffer