Aggregate Property

String representing the list of address candidates (if any).

Object Oriented Interface

public function getAggregate();
public function setAggregate($value);

Procedural Interface

inship_upsaddress_get($res, 7 );
inship_upsaddress_set($res, 7, $value );

Default Value

''

Remarks

If the address provided in the request is an invalid or ambiguous address, a list of potential candidates will be returned in the server response.

This address candidate list will be stored as a string in Aggregate, formatted as XML.

This can be used with the UPSRates class to get the detailed information for each origin/destination address candidate (city, state, zip code range) by setting the Aggregate to UPSRates's SenderCandidateAggregate or RecipientCandidateAggregate after a call to GetShippingTime.

Data Type

String