ShipmentId Property

The unique identifier for this shipment.

Syntax

 canadapostshipintl.getShipmentId([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 getShipmentId([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 setShipmentId([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

A unique identifier for the shipment. This can be used in any future calls to TransmitShipments, using the ExcludedShipments config to indicate that this shipment is to be excluded from the manifest.

This property is read-only.

Data Type

String