PHP UPS API Wrapper

This library is aimed at wrapping all the UPS API into a simple to use PHP Library. It currently covers the Quantum View®, Tracking API, Shipping API, Rating API and Time in Transit API. Feel free to contribute.

Table Of Content

1. Requirements
2. Installation
3. QuantumView Class
   • Example
   • Parameters
4. Tracking Class
   • Example
   • Parameters
5. Rate Class
   • Example
   • Parameters
6. TimeInTransit Class
   • Example
   • Parameters
7. Shipping Class

Requirements

This library uses PHP 5.3+.

To use the UPS API, 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.

Installation

It is recommended that you install the PHP UPS API Wrapper library through composer. To do so, add the following lines to your composer.json file.

{
    "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.

Rate Class

The Rate Class allow you to get shipment rates using the UPS Rate API.

Example

$rate = new Ups\Rate(
	$accessKey,
	$userId,
	$password
);

try {
    $shipment = new Shipment();

    $shipperAddress = $shipment->getShipper()->getAddress();
    $shipperAddress->setPostalCode('99205');

    $shipTo = $shipment->getShipTo();
    $shipTo->setCompanyName('Test Ship To');
    $shipToAddress = $shipTo->getAddress();
    $shipToAddress->setPostalCode('99205');

    $package = new Package();
    $package->getPackagingType()->setCode(PackagingType::PT_PACKAGE);
    $package->getPackageWeight()->setWeight(10);

    $shipment->addPackage($package);

    var_dump($rate->getRate($shipment));
} catch (Exception $e) {
    var_dump($e);
}

Parameters

• rateRequest Mandatory. rateRequest Object with shipment details

This Rate class is not finished yet! Parameter should be added when it will be finished.

TimeInTransit Class

The TimeInTransit Class allow you to get all transit times using the UPS TimeInTransit API.

Example

$timeInTransit = new Ups\TimeInTransit($access, $userid, $passwd);

try {
    $times = $timeInTransit->getTimeInTransit($timeInTransitequest);

	foreach($times->ServiceSummary as $serviceSummary) {
		var_dump($serviceSummary);
	}

} catch (Exception $e) {
    var_dump($e);
}

Parameters

• timeInTransitRequest Mandatory. timeInTransitRequest Object with shipment details

Shipping Class

Documentation for this class is coming.