ShipDate Property

Date package will be mailed.

Syntax

 ezship.getShipDate([callback])
 ezship.setShipDate( shipDate, [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 getShipDate([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 setShipDate([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 is the date on which the package was tendered to FedEx. This is required to be provided in a ship request. This date should not be a past date or a date more than 10 days in the future. If future day shipping is requested (i.e., the corresponding flag of Future Day is present in the ShipmentSpecialServices): for Express shipping this value must be less than or equal to 10 days in the future; for Express freight, this must be less than or equal to 5 days in the future. If not provided, defaults to the current date. Format: YYYY-MM-DD (e.g. 2008-09-30).

This property is not applicable to UPS.

For USPS, you can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. Ship date may be today plus 0 to 3 days in advance. Enter the date in either format: dd-mmm-yyyy, such as 14-Feb-2001, or mm/dd/yyyy, such as 02/14/2001.

Data Type

String