ShipmentDescription Property

A textual description of goods for the whole shipment.

Syntax

 upsshipintl.getShipmentDescription([callback])
 upsshipintl.setShipmentDescription( shipmentDescription, [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 getShipmentDescription([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 setShipmentDescription([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 is applicable to international shipments only. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc..

This is required to be provided in a ship request if all of the listed conditions are true:

• the SenderCountryCode and RecipientCountryCode are not the same;
• the SenderCountryCode and/or RecipientCountryCode are not in the European Union; or the SenderCountryCode and RecipientCountryCode are both in the European Union; and ServiceType is not 'UPS Standard'.
• the packaging type of any packages contained in the shipment is not 'UPS Letter';

Maximum length: 35 characters.

Data Type

String