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

PackageReferences Property

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Syntax

 fedextrack.getPackageReferences([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 getPackageReferences([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 setPackageReferences([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 should be inspected after a call to the TrackShipment method. When populated, it is a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).

Reference Type can be any of the following values:

Reference Type
BILL_OF_LADING (or BOL)
COD_RETURN_TRACKING_NUMBER
CUSTOMER_AUTHORIZATION_NUMBER (or CUSTAUTHNUM)
CUSTOMER_REFERENCE (or CUR)
DEPARTMENT
FREE_FORM_REFERENCE
GROUND_SHIPMENT_ID
GROUND_MPS
INVOICE (or INV)
PARTNER_CARRIER_NUMBER (or PARTNERCARNBR)
PART_NUMBER
PURCHASE_ORDER
RETURN_MATERIALS_AUTHORIZATION (or RMA)
TRACKING_CONTROL_NUMBER (TCN)
SHIPPER_REFERENCE (or SHR)
STANDARD_MPS

This property is read-only.

Data Type

String

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