Using Simple Rates¶

What are simple rates?¶

Although RocketShipIt can return very detailed information about a particular rate or carrier services it is often easier to have access to a simple array that holds only the total monetary value of the rates. This is exactly what getSimpleRates() does.

Using it¶

UPS

The following code will generate an array of all available UPS services to 90210:

<?php
$rate = new \RocketShipIt\Rate('UPS');

$rate->setParameter('toCode', '90210');
$rate->setParameter('weight', '5');
$rate->setParameter('residentialAddressIndicator', '0');

$response = $rate->getSimpleRates();

FedEx

The following code will generate an array of all available FedEx services to 59715:

<?php
$rate = new \RocketShipIt\Rate('FedEx');

$rate->setParameter('toCode', '59715');
$rate->setParameter('weight', '5');

$response = $rate->getSimpleRates();

USPS

The following code will generate an array of all available USPS services to 90210:

<?php
$rate = new \RocketShipIt\Rate('USPS');
$rate->setParameter('toCode', '90210');
$rate->setParameter('weight', '5');

$response = $rate->getSimpleRates();

Simple rates also work with multiple packages:

<?php
$rate = new \RocketShipIt\Rate('USPS');
$rate->setParameter('toCode','90210');
$rate->setParameter('service','ALL');

$package = new \RocketShipIt\Package('USPS');
$package->setParameter('weight', 1);
$package->setParameter('length', 8);
$package->setParameter('width', 2);
$package->setParameter('height', 2);
$rate->addPackageToShipment($package);

$package = new \RocketShipIt\Package('USPS');
$package->setParameter('weight', 1);
$package->setParameter('length', 8);
$package->setParameter('width', 2);
$package->setParameter('height', 2);
$rate->addPackageToShipment($package);

$response = $rate->getSimpleRates();

Stamps.com

Example:

<?php
$rate = new \RocketShipIt\Rate('stamps');
$rate->setParameter('toCode', '90210');
$rate->setParameter('weight', '5');

$response = $rate->getSimpleRates();

Canada Post

Example:

<?php
$rate = new \RocketShipIt\Rate('canada');
$rate->setParameter('shipCity','BELLEVILLE');
$rate->setParameter('shipCode','K8N5W6');
$rate->setParameter('toCode','94115');
$rate->setParameter('weight','5');

$response = $rate->getSimpleRates();

Example UPS output¶

getSimpleRates() will produce an Array similar to this:

Array
(
    [0] => Array
        (
            [desc] => UPS Ground
            [rate] => 24.84
            [service_code] => 03
        )

    [1] => Array
        (
            [desc] => UPS 3 Day Select
            [rate] => 42.92
            [service_code] => 12
        )

    [2] => Array
        (
            [desc] => UPS 2nd Day Air
            [rate] => 58.10
            [service_code] => 02
        )

    [3] => Array
        (
            [desc] => UPS Next Day Air Saver
            [rate] => 139.26
            [service_code] => 13
        )

    [4] => Array
        (
            [desc] => UPS Next Day Air Early AM
            [rate] => 216.32
            [service_code] => 14
        )

    [5] => Array
        (
            [desc] => UPS Next Day Air
            [rate] => 149.42
            [service_code] => 01
        )
)

What happens when there is an error with the rate?:

Array
(
    [error] => The requested service is unavailable between the selected locations.
)

RocketShipIt will still produce an array with a special rate called “error”. The value of this will be set to the english description of the error.

How do I detect an error?

There are many ways but the easiest is to use PHP’s array_key_exists():

<?php
if (array_key_exists('error', $response)) {
    $theError = $response['error'];
}

Example FedEx output¶

getSimpleRates() will produce an Array similar to this:

Array
(
    [0] => Array
        (
            [desc] => FedEx Priority Overnight
            [rate] => 37.4
            [service_code] => PRIORITY_OVERNIGHT
        )

    [1] => Array
        (
            [desc] => FedEx Standard Overnight
            [rate] => 27.56
            [service_code] => STANDARD_OVERNIGHT
        )

    [2] => Array
        (
            [desc] => FedEx 2 Day AM
            [rate] => 17.78
            [service_code] => FEDEX_2_DAY_AM
        )

    [3] => Array
        (
            [desc] => FedEx 2 Day
            [rate] => 15.46
            [service_code] => FEDEX_2_DAY
        )

    [4] => Array
        (
            [desc] => FedEx Express Saver
            [rate] => 14.41
            [service_code] => FEDEX_EXPRESS_SAVER
        )

    [5] => Array
        (
            [desc] => FedEx Ground
            [rate] => 7.22
            [service_code] => FEDEX_GROUND
        )
)

Example USPS output¶

getSimpleRates() will produce an Array similar to this:

Example Stamps.com output¶

getSimpleRates() will produce an Array similar to this:

Example Canada Post output¶

getSimpleRates() will produce an Array similar to this:

Array
(
    [0] => Array
        (
            [desc] => Canada Post Expedited Parcel USA
            [rate] => 36.18
            [service_code] => USA.EP
        )

    [1] => Array
        (
            [desc] => Canada Post Priority Worldwide parcel USA
            [rate] => 171.81
            [service_code] => USA.PW.PARCEL
        )

    [2] => Array
        (
            [desc] => Canada Post Xpresspost USA
            [rate] => 58.11
            [service_code] => USA.XP
        )

)