Pre-Existing Report: All Transactions
Generate a report with all the transactions between two date ranges in the selected campaigns.
The data to be submitted to the API is composed of the following fields:
|
|
field |
|
Example |
|
Note |
|
|
|
user_id |
|
john1970 |
|
Required |
|
|
|
user_password |
|
1959caadac9b13dcb3 |
|
Required |
|
|
|
account_id |
|
greatwidgets |
|
Required |
|
|
|
type |
|
reports |
|
Required |
|
|
|
report |
|
transactions_all |
|
Required |
|
|
|
date_start |
|
2010-01-01 |
|
Required |
|
|
|
date_end |
|
2011-12-31 |
|
Optional |
|
|
|
last |
|
9242 |
|
Optional. Last Transaction ID. View Notes |
|
|
|
selected_campaigns |
|
123456789012,21987654321 |
|
Required |
|
|
|
restrict_by_user |
|
cashier324 |
|
Optional |
|
|
|
show_activations |
|
Yes |
|
Optional |
|
|
|
|
|
|
|
|
|
|
|
Output Format: |
|
|
|
output |
|
JSON or XML |
|
Optional. If not provided, defaults to XML |
|
|
|
callback |
|
someFunctionName |
|
Optional: JSONP format |
|
|
|
condensed |
|
yes |
|
Optional (No white space) Applies only to JSON(P) output |
|
|
|
|
|
|
|
|
|
Notes:
- The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
- Use the last parameter to limit the results to those transactions recorded after the "Last" Transaction ID you have included in the request.
- Separate each selected_campaigns with a comma (no spaces!)
- Use the restrict_by_user parameter to limit the transactions to only those recorded by that user.
- To include non-transaction "customer activated" transactions, include the parameter show_activations and set it to Yes.
Example PHP Request:
If you are using PHP, the $data array would look like this:
- $data['user_id'] = 'john1970';
- $data['user_password'] = '1959caadac9b13dcb3';
- $data['account_id'] = 'greatwidgets';
- $data['type'] = 'reports';
- $data['report'] = 'transactions_all';
- $data['date_start'] = '2010-01-01';
- $data['date_end'] = '2011-12-31';
- $data['selected_campaigns'] = '123456789012,210987654321';
Success XML Response (New / Updated User):
- <response status="success">
- <transaction>
- <code>1850396893739825</code><code>1850396893739825</code>
- <date>2011-08-10</date>
- <authorization>20% Discount</authorization>
- <campaign_id>123456789012</campaign_id>
- <user_name>Store_Clerk</user_name>
- <user_custom1></user_custom1>
- <first_name>Demo</first_name>
- <last_name>McDemo</last_name>
- <phone>555-5555</phone>
- <email>mcdemo@example.com</email>
- <custom1></custom1>
- <redeemed>R</redeemed>
- <code_to_show>1111111111111</code_to_show>
- <amount_number>-250</amount_number>
- <amount_type>Points</amount_type>
- <transaction_id>4338</transaction_id>
- </transaction>
- <transaction>
- ...
- </transaction>
- </response>
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|