ShipDateStart Property

Start of ship date range used to narrow search.

Syntax

 eztrack.getShipDateStart([callback])
 eztrack.setShipDateStart( shipDateStart, [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 getShipDateStart([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 setShipDateStart([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

For FedEx, this property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateEnd is required. Format: YYYY-MM-DD.

For UPS, this describes the start of a pickup date range used to narrow down the search, and is optional. However, this is considered in the request only if ShipDateEnd is set as well. Otherwise, it will be disregarded. Format: YYYYMMDD.

This property does not apply to USPS.

Data Type

String