PackageCODLabel Property
Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
Syntax
canadapostship.getPackageCODLabel(index, [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 getPackageCODLabel([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 setPackageCODLabel([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
Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the PackageCODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.
Since MPS Ground packages do not travel together and may be delivered at different times, a PackageCODLabel return label will be generated for each package that uses COD service.
On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.
This property is only applicable to FedEx.
The size of the array is controlled by the PackageCount property.
This property is read-only and not available at design time.
Data Type
Buffer