API:Product:get weight

Retrieves the weight, in ounces, of an item or the sum total of the weight of a collection of items.

Calling

$api->product->get_weight($item_sku); $api->product->get_weight(array($item_sku_1, $item_sku_2, ..., $item_sku_n));

Parameters

$item_sku - The SKU of an item. May also be a list of items in which case the sum weight total of the items is returned. (List of Products)

Returns

The weight, in ounces, of the item or collection of items.

Exceptions

AoPSAPI_Exception::MISSING_PARAMETER - Missing item sku or list of item skus

AoPSAPI_Exception::INVALID_PARAMETER - An invalid item sku was passed in

AoPSAPI_Exception::INVALID_PERMISSIONS - API Application does not have permission to submit order

Example

require_once 'AoPSAPI.php';

$api = new AoPSAPI('<api_key>', '<secret_key>'); try {

   $result = $api->product->get_weight('intro:algebra');
   echo 'The weight of Introduction to Algebra is ' . $result . ' ounces.
';

   $result = $api->product->get_weight(array('intro:algebra', 'intro:algebra:solutions'));
   echo 'The combined weight of Introduction to Algebra and its solutions manual is ' .
        $result . ' ounces.
';

} catch (AoPSAPI_Exception $ex) {

   echo $ex->getMessage() . "
";

}

Output

The weight of Introduction to Algebra is 53 ounces.
The combined weight of Introduction to Algebra and its solutions manual is 79 ounces.

See Also

List of Products