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

MailingLocation Property

Postal Office Zip Code where the item will be mailed (if different from ZipCode ).

Syntax

 uspsshipintl.getMailingLocation([callback])
 uspsshipintl.setMailingLocation( mailingLocation, [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 getMailingLocation([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 setMailingLocation([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

The value of this property is optional.

If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (SenderZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

This way, you convey this difference to the USPS Server.

This property is not applicable for International First Class mail.

Data Type

String

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