PackageLocation Property

The location of pickup.

Syntax

 uspsship.getPackageLocation([callback])
 uspsship.setPackageLocation( packageLocation, [callback])

Possible Values

  0 (plNotSet), 
  1 (plFrontDoor), 
  2 (plBackDoor), 
  3 (plSideDoor), 
  4 (plKnockOnDoor), 
  5 (plMailRoom), 
  6 (plOffice), 
  7 (plReception), 
  8 (plInMailbox), 
  9 (plOther)

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 getPackageLocation([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 setPackageLocation([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

This property is required when the following methods are called:

SchedulePickup (required)
ChangePickup (optional)
CancelPickup (optional)

and it is retrieved in the:

PickupInquiry method call.

The allowed values to be selected are: Front Door, Back Door, Side Door, Knock on Door/Ring Bell, Mail Room, Office, Reception, In/At Mailbox, Other

Note: When plOther is selected, the SpecialInstructions property is required to be entered.

Data Type

Integer