Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

IdentifierType Property

Type of shipment identifier by which the shipment is to be tracked.

Syntax

 eztrack.getIdentifierType([callback])
 eztrack.setIdentifierType( identifierType, [callback])

Possible Values

  0 (itFedExTrackingNumberOrDoorTag), 
  1 (itFedExBillOfLading), 
  2 (itFedExCODReturnTrackingNumber), 
  3 (itFedExCustomerAuthorizationNumber), 
  4 (itFedExCustomerReference), 
  5 (itFedExDepartment), 
  6 (itFedExFreeFormReference), 
  7 (itFedExGroundShipmentId), 
  8 (itFedExGroundMPS), 
  9 (itFedExInvoiceNumber), 
  10 (itFedExPartnerCarrierNumber), 
  11 (itFedExPartNumber), 
  12 (itFedExPONumber), 
  13 (itFedExRMANumber), 
  14 (itFedExTrackingControlNumber), 
  15 (itFedExShipperReference), 
  16 (itFedExStandardMPS), 
  17 (itUPSPackageTrackingNumber), 
  18 (itUPSMasterTrackingNumber), 
  19 (itUPSReferenceNumber), 
  20 (itUPSShipmentBookmark)

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.

This property is not applicable to USPS.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0