PHP UPS API Wrapper

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.

UPS APIs

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.

Requirements

This library uses PHP 5.3+.

Installation

It is recommended that you install the PHP UPS API Wrapper library through composer.

{
    "require": {
        "gabrielbull/ups-api": "dev-master"
    }
}

QuantumView Class

The QuantumView Class allow you to request a Quantum View Data subscription.

Example

$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);
}

Parameters

QuantumView parameters are:

• name Name of subscription requested by user. If null, all events will be returned.
• beginDateTime Beginning date time for the retrieval criteria of the subscriptions. Format: Y-m-d H:i:s or Unix timestamp.
• endDateTime Ending date time for the retrieval criteria of the subscriptions. Format: Y-m-d H:i:s or Unix timestamp.
• fileName File name of specific subscription requested by user.
• bookmark Bookmarks 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.

Tracking Class

The Tracking Class allow you to track a shipment using the UPS Tracking API.

Example

$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);
}

Parameters

Tracking parameters are:

• trackingNumber The package’s tracking number.
• requestOption Optional processing. For Mail Innovations the only valid options are Last Activity and All activity.