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

RecipientAddressFlags Property

Various flags that denote information about the address.

Syntax

 upsrates.getRecipientAddressFlags([callback])
 upsrates.setRecipientAddressFlags( recipientAddressFlags, [callback])

Default Value

0


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 getRecipientAddressFlags([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 setRecipientAddressFlags([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

Various flags that denote information about the address.

ValueMeaning
0x00000001 POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShipIntl addresses.
0x00000002 Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial.

Data Type

Integer

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