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

ShipDate Property

Date package will be mailed.

Syntax

 uspsshipintl.getShipDate([callback])
 uspsshipintl.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

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. For USPS, the 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.

This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.

Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2015-08-01.

This property is also returned after the following carrier pickup methods are called:

  • PickupAvailability
  • SchedulePickup
  • ChangePickup
  • PickupInquiry
This indicates the date on which the packages will be picked up from the specified location.

Data Type

String

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