Batch Transactions

Record a batch of transactions for a customer account, including redemptions.

The data to be submitted to the API is composed of the following fields:

Fields common to all campaign types:

Fields for Points-Based Campaigns:

Fields for Gift-Card Campaigns:

Fields for Buy-X-Get-One-Free / Membership Campaigns:

Notes:

• 'service_product' is not the "id" but the "description" returned by the BuyX Campaign Items List API call. This is because some clients import lists of transaction with items they did not pre-enter in the admin interface. Thus, the import does allows new (service_product) items to be used that have not been pre-defined.
• The caveat is that each service_product name must be exactly spelled and capitalized the same, usually not an issue when that information is taken from another database or output from a POS or inventory management system.  

Fields for Events (Visits) Based Campaigns:

Fields for Earn-per-Event (Visits) Campaigns:

Notes:

• 'code' is either
  • the unique Customer ID recored in the 'code' field when the customer account was first created AND there was no 'card_number'), or
  • the 'card_number' of the customer.
• If date is not given, today's date will be used.
• Unless there's a good reason, include the 'no-undo' = 'yes' directive, otherwise every batch will be listed in the Manage Customer Records section.

Example PHP Request for Points-Based Campaign:

If you are using PHP, the $data array would look like this:

1. $data['user_id'] = 'john1970';
2. $data['user_password'] = '1959caadac9b13dcb3';
3. $data['type'] = 'batch_transactions';
4. $data['account_id'] = 'greatwidgets';
5. $data['delimiter'] = 'pipe';
6. $data['apply_ratio'] = 'yes';
7. $data['no-undo'] = 'yes';
8. $data['visits_header_1'] = 'campaign_id';
9. $data['visits_header_2'] = 'code';
10. $data['visits_header_3'] = 'redeemed';
11. $data['visits_header_4'] = 'amount';
12. $data['visits_header_5'] = 'date';
13. $data['visits_header_6'] = 'authorization';
14. $data['visits_header_7'] = 'none';
15. $data['Visits_Data'] = '
16. 4638472975924871|12121|N|14,95|03/15/2010|API test import 1
17. 4638472975924871|12121|N|50|03/15/2010|API test import 2
18. 4638472975924871|12121|N|34.67|03/15/2010|API test import 3
19. 4638472975924871|12121|N|0,50|03/15/2010|API test import 4
20. 4638472975924871|12121|N|.75|03/15/2010|API test import 5
21. 4638472975924871|12121|N|2.00|03/15/2010|API test import 6
22. 4638472975924871|12121|Y|1500|03/15/2010|API test redeem 1
23. ';

Success XML Response:

1. <response status="success">
2. <batch status="imported">
3. <transactions>7</transactions>
4. </batch>
5. </response>

Error XML Response:

1. <response status="error">
2. <error>Error message</error>
3. </response>