Difference between revisions of "Functions:orderGetSummary"

Revision as of 13:57, 24 February 2009

Description

Retrieves summary order information. Useful for perpetual shopping carts.

Syntax

$orderArr = eV::orderGetSummary([INT $orderId]);

Paramaters

• orderId INTEGER (optional)

unique order key of order information to retrieve. Defaults to the current sessions shopping cart's orderId.

Return Values

Returns associative array of summary order information. Return array is as follows:

Array
(
    [orderNumber] => INT
    [completeDate] => DATETIME
    [cancelDate] => DATETIME
    [itemTotal] => DECIMAL
    [itemSurchargeTotal] => DECIMAL
    [totalQuantity] => INT
    [taxTotal] => DECIMAL
    [baseShipTotal] => DECIMAL
    [shipTotal] => DECIMAL
    [paymentTotal] => DECIMAL
    [discountTotal] => DECIMAL
    [totalOrderCost] => DECIMAL
    [totalDue] => DECIMAL
)

Element details from the returned array are as follows:

Examples

// get the cart summary data
$orderArr = eV::orderGetSummary();
 
// output some of the results
echo "YOUR SHOPPING CART
<hr>
Total Number of Items:" . $orderArr['totalQuantity'] . "<br>
Total Value:" . eV::dollarFormat($orderArr['totalOrderCost']);