OrderDescription Property

Description of items the customer is purchasing.

Syntax

 expresscheckout.getOrderDescription([callback])
 expresscheckout.setOrderDescription( orderDescription, [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 getOrderDescription([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 setOrderDescription([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

This property is optional.

Character length and limitations: 127 single-byte alphanumeric characters.

This property is optional when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

Data Type

String