Copyright 2013, Gabriel Bull, Licensed under the GNU GENERAL PUBLIC LICENSE.
This library is aimed at wrapping all the UPS APIs into a simple to use PHP Library. It currently only covers the Quantum View® and Tracking APIs, but feel free to contribute.
To use the UPS APIs, you have to request an access key from UPS. For every request, you will have to provide the Access Key, your UPS user ID and password.
This library uses PHP 5.3+.
The QuantumView Class allow you to request a Quantum View Data subscription.
$quantumView = new UPS\QuantumView(
$accessKey,
$userId,
$password
);
try {
// Get the subscription for all events for the last hour
$events = $quantumView->getSubscription(null, (time() - 3600));
foreach($events as $event) {
// Your code here
echo $event->Type;
}
} catch (Exception $e) {
var_dump($e);
}QuantumView parameters are:
nameName of subscription requested by user. If null, all events will be returned.beginDateTimeBeginning date time for the retrieval criteria of the subscriptions. Format: Y-m-d H:i:s or Unix timestamp.endDateTimeEnding date time for the retrieval criteria of the subscriptions. Format: Y-m-d H:i:s or Unix timestamp.fileNameFile name of specific subscription requested by user.bookmarkBookmarks the file for next retrieval.
If you provide a beginDateTime, but no endDateTime, the endDateTime will default to the current date time.
To use the fileName parameter, do not provide a beginDateTime.
The Tracking Class allow you to track a shipment using the UPS Tracking API.
$tracking = new UPS\Tracking(
$accessKey,
$userId,
$password
);
try {
$shipment = $tracking->track('TRACKING NUMBER');
foreach($shipment->Package->Activity as $activity) {
var_dump($activity);
}
} catch (Exception $e) {
var_dump($e);
}Tracking parameters are:
trackingNumberThe package’s tracking number.requestOptionOptional processing. For Mail Innovations the only valid options are Last Activity and All activity.