CommercialInvoiceNumber Property

Customer's assigned invoice number.

Syntax

 upsshipintl.getCommercialInvoiceNumber([callback])
 upsshipintl.setCommercialInvoiceNumber( commercialInvoiceNumber, [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 getCommercialInvoiceNumber([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 setCommercialInvoiceNumber([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

Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice.

Data Type

String