function MCAPI::campaignEcommOrders in Mailchimp 7
Same name and namespace in other branches
- 6.2 MCAPI.class.php \MCAPI::campaignEcommOrders()
Retrieve the Ecommerce Orders tracked by campaignEcommAddOrder()
Stats
@returnf store_id string the store id generated by the plugin used to uniquely identify a store @returnf store_name string the store name collected by the plugin - often the domain name @returnf order_id string the internal order id the store tracked this order by @returnf email string the email address that received this campaign and is associated with this order @returnf order_total double the order total @returnf tax_total double the total tax for the order (if collected) @returnf ship_total double the shipping total for the order (if collected) @returnf order_date string the date the order was tracked - from the store if possible, otherwise the GMT time we recieved it @returnf lines array containing detail of the order - product, category, quantity, item cost
Parameters
string $cid the campaign id to pull bounces for (can be gathered using campaigns()):
integer $start optional for large data sets, the page number to start at - defaults to 1st page of data (page 0):
integer $limit optional for large data sets, the number of results to return - defaults to 100, upper limit set at 500:
string $since optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in <strong>GMT</strong>:
Return value
array orders the orders and their details that we've collected for this campaign
File
- ./
MCAPI.class.php, line 708
Class
Code
function campaignEcommOrders($cid, $start = 0, $limit = 100, $since = NULL) {
$params = array();
$params["cid"] = $cid;
$params["start"] = $start;
$params["limit"] = $limit;
$params["since"] = $since;
return $this
->callServer("campaignEcommOrders", $params);
}