REPORTS OrderDetails API Version 1

Aldo Lambruschini

Modified on: Mon, 18 Jan, 2021 at 1:23 PM

REPORTS OrderDetails API Version 1

Updated on 2014-03-31
Current Version: Version 1
Deprecated Version:
Requests Allowed: GET & SOAP

Summary:

Returns an array of orders, potentially filtered by affiliate,conversion and order

You can also obtain this from within your CAKE instance by going to the Reports main tab then the offers sub tab where you are allowed to export.

Resource/WSDL Page:

http://<your_domain_here>/api/1/reports.asmx?op=OrderDetails

Parameters

api_key Required Type: STRING Length (Max/Min): 50	This api_key Must be a valid API key (exisiting and NOT expired) You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list. Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
start_date Required Type: DATE Length (Max/Min): N/A	Allowed formats: "YYYY-mm-dd","mm-dd-YYYY", "mm/dd/YYYY", "yyyy/mm/dd" Example Values: 2014-04-03
end_date Required Type: DATE Length (Max/Min): N/A	Allowed formats: "YYYY-mm-dd","dd-mm-YYYY" When time stamp is excluded 00:00:00 is assumed, and data on end date will not be included. Example Values: 2014-04-03
affiliate_id Required Type: INTEGER Length (Max/Min): N/A	If passing anything <= 0 the result will include all affiliates. Example Values: 1234
conversion_id Required Type: INTEGER Length (Max/Min): N/A	If passing anything <= 0 the result will include all conversions. Example Values: 1234
order_id Optional Type: STRING Length (Max/Min): N/A	This is the identifier for a unique order. Leave blank to pass all values Example Values: 1234
start_at_row Required Type: INTEGER Length (Max/Min): N/A	Must pass at least 0 as value, which means start at the beginning of the data set. Example Values: 3
row_limit Required Type: INTEGER Length (Max/Min): N/A	Must pass at least 0 as value, which means no limit. Example Values: 3
sort_field Required Type: STRING Length (Max/Min): N/A	Accepts "conversion_id","order_id", "sku_code" or 0 to ignore this filter.The value could be any integer in order to ignore this filter. Example Values: 0
sort_descending Required Type: BOOL Length (Max/Min): N/A	Example Values: TRUE

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	https://demo-new.cakemarketing.com/api/1/reports.asmx/OrderDetails?api_key=3YmDJeT3VHTFhDqAjr2OlQ&start_date=2014-08-25&end_date=2014-08-26&affiliate_id=0&conversion_id=0&order_id=1308&start_at_row=0&row_limit=1000&sort_field=order_id&sort_descending=true

Sample XML Response:

<order_detail_report_responseorder_detail_report_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/1/">
<success>true</success>
<row_count>0</row_count>
<order_details>
<order_detail>
<conversion_id>10313</conversion_id>
<order_id>1308</order_id>
<sku_code>637</sku_code>
<sku_name>637</sku_name>
<product_name>GoPro - Hero3+ Black Edition Camera</product_name>
<category_name>Electronics > Cameras</category_name>
<master_category_name>Cameras & Optics</master_category_name>
<quantity>1</quantity>
<line_item_discount>0.00000000000000</line_item_discount>
<line_item_subtotal>399.99000000000000</line_item_subtotal>
</order_detail>
</order_details>
</order_detail_report_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API Key does not exist or is expired