ShipperAccountNumber Property

Account number associated with shipment.

Syntax

 eztrack.getShipperAccountNumber([callback])
 eztrack.setShipperAccountNumber( shipperAccountNumber, [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 getShipperAccountNumber([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 setShipperAccountNumber([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 indicates the account number associated with shipment (as opposed to the AccountNumber, which is that of party sending the request).

For FedEx, when providing the ShipperAccountNumber, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the RecipientCountryCode and RecipientZipCode (applicable countries) are required. The Reply data may be restricted if ShipperAccountNumber is not provided.

For UPS, this can be provided in a track request to narrow down the search results. It can also be returned in the server response when the TrackShipment method is called.

This is not used by the USPS class.

Data Type

String