« Back to Documentation Overview

campaignEcommOrders – v1.3

 campaignEcommOrders(string apikey, string cid, int start, int limit, string since)

Retrieve the Ecommerce Orders tracked by campaignEcommOrderAdd()

Section
Campaign Stats
Parameters
apikey a valid API Key for your user account. Get by visiting your API dashboard
cid the campaign id to pull bounces for (can be gathered using campaigns())
start optional - for large data sets, the page number to start at - defaults to 1st page of data (page 0)
limit optional - for large data sets, the number of results to return - defaults to 100, upper limit set at 500
since optional - pull only messages since this time - use YYYY-MM-DD HH:II:SS format in GMT
Returns
array the total matching orders and the specific orders for the requested page
inttotalthe total matching orders
arraydatathe actual data for each order being returned
stringstore_idthe store id generated by the plugin used to uniquely identify a store
stringstore_namethe store name collected by the plugin - often the domain name
stringorder_idthe internal order id the store tracked this order by
stringemail the email address that received this campaign and is associated with this order
doubleorder_totalthe order total
doubletax_totalthe total tax for the order (if collected)
doubleship_totalthe shipping total for the order (if collected)
stringorder_datethe date the order was tracked - from the store if possible, otherwise the GMT time we recieved it
arraylinescontaining detail of the order:
intline_numthe line number assigned to this line
intproduct_idthe product id assigned to this item
stringproduct_namethe product name
stringproduct_skuthe sku for the product
intproduct_category_idthe id for the product category
stringproduct_category_namethe product category name
intqtythe quantity of items ordered
cost the total cost of items ordered