Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

CustomerReceipt Property

Image of the Customer Online Record.

Syntax

 uspsship.getCustomerReceipt([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 getCustomerReceipt([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 setCustomerReceipt([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

If you want to have the Customer Online Label Record and PackageShippingLabel in separate image files, you can accomplish this by setting the SeparateReceipt property to True. This image can be generated in PDF, TIF or GIF format. The image type is determined by setting LabelImageType property prior to submitting the request.

The Customer Receipt must be presented when filing an indemnity claim and/or for a postage refund.

This property is read-only.

Data Type

Buffer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0