IdentifierType Property
Type of shipment identifier by which the shipment is to be tracked.
Syntax
fedextrack.getIdentifierType([callback]) fedextrack.setIdentifierType( identifierType, [callback])
Possible Values
0 (fitTrackingNumberOrDoorTag), 1 (fitBillOfLading), 2 (fitCODReturnTrackingNumber), 3 (fitCustomerAuthorizationNumber), 4 (fitCustomerReference), 5 (fitDepartment), 6 (fitFreeFormReference), 7 (fitGroundShipmentId), 8 (fitGroundMPS), 9 (fitInvoiceNumber), 10 (fitPartnerCarrierNumber), 11 (fitPartNumber), 12 (fitPONumber), 13 (fitRMANumber), 14 (fitTrackingControlNumber), 15 (fitShipperReference), 16 (fitStandardMPS)
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 is required if the track request will be made for an identifier other than Tracking Number.
Possible values are as follows:
Value | Type Description |
fitTrackingNumberOrDoorTag (0) | Tracking Number Or DoorTag |
fitBillOfLading (1) | Bill of Lading (BOL) |
fitCODReturnTrackingNumber (2) | COD Return Tracking Number |
fitCustomerAuthorizationNumber (3) | Customer Authorization Number |
fitCustomerReference (4) | Customer Reference |
fitDepartment (5) | Department |
fitFreeFormReference (6) | Free Form Reference |
fitGroundShipmentId (7) | Ground Shipment Id |
fitGroundMPS (8) | Ground Multi Piece Shipment (MPS) |
fitInvoiceNumber (9) | Invoice Number |
fitPartnerCarrierNumber (10) | Partner Carrier Number |
fitPartNumber (11) | Part Number |
fitPONumber (12) | Purchase Order Number |
fitRMANumber (13) | Return Materials Authorization (RMA) Number |
fitTrackingControlNumber (14) | Tracking Control Number (TCN) |
fitShipperReference (15) | Shipper Reference |
fitStandardMPS (16) | Standard MPS |
To limit the number of tracking replies for a specific reference, you can enter a date range (ShipDateStart and ShipDateEnd) for this search.
When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.
Data Type
Integer