IdentifierType Property
The identifier type to be used to track a package.
Syntax
canadaposttrack.getIdentifierType([callback]) canadaposttrack.setIdentifierType( identifierType, [callback])
Possible Values
0 (itTrackingNumber), 1 (itDNC), 2 (itReference)
Default Value
0
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 getIdentifierType([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 setIdentifierType([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 defines what type of identifier will be used in TrackShipment to get the tracking details. Possible values are:
0 (itTrackingNumber - default) | The 12, 13, or 16 character tracking number or Parcel Identification Number (PIN). |
1 (itDNC) | The 15 character Delivery Notice Card (DNC) number. |
2 (itReference) | The customer reference number used when the shipment was created. |
Data Type
Integer