Back to Documentation Overview

campaignEcommOrders

public static campaignEcommOrders(string apikey, string cid, integer start, integer limit, string since)

Retrieve the Ecommerce Orders tracked by campaignEcommAddOrder()

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   -  orders the orders and their details that we've collected for this campaign
Returned Fields:
store_id string the store id generated by the plugin used to uniquely identify a store
store_name string the store name collected by the plugin - often the domain name
order_id string the internal order id the store tracked this order by
email string the email address that received this campaign and is associated with this order
order_total double the order total
tax_total double the total tax for the order (if collected)
ship_total double the shipping total for the order (if collected)
order_date string the date the order was tracked - from the store if possible, otherwise the GMT time we recieved it
lines array containing detail of the order - product, category, quantity, item cost
Add New Note User Contributed Notes for campaignEcommOrders
No notes, yet... Will you be the first??