« Back to Documentation OverviewcampaignEcommOrders – v1.3
campaignEcommOrders(string apikey, string cid, int start, int limit, string since)
Retrieve the Ecommerce Orders tracked by campaignEcommOrderAdd()
| 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
| int | total | the total matching orders
| | array | data | the actual data for each order being returned
| string | store_id | the store id generated by the plugin used to uniquely identify a store
| | string | store_name | the store name collected by the plugin - often the domain name
| | string | order_id | the internal order id the store tracked this order by
| | string | email | the email address that received this campaign and is associated with this order
| | double | order_total | the order total
| | double | tax_total | the total tax for the order (if collected)
| | double | ship_total | the shipping total for the order (if collected)
| | string | order_date | the date the order was tracked - from the store if possible, otherwise the GMT time we recieved it
| | array | lines | containing detail of the order:
| int | line_num | the line number assigned to this line
| | int | product_id | the product id assigned to this item
| | string | product_name | the product name
| | string | product_sku | the sku for the product
| | int | product_category_id | the id for the product category
| | string | product_category_name | the product category name
| | int | qty | the quantity of items ordered
| | cost the total cost of items ordered
| | | |