Campaign Promotions List

Returns a list of the promotions available for a given campaigns.

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

Notes:

• When using this call, the 'account_id' MUST be the unique Owner ID that is found in the "Edit Account Information" page reached from the main page / control panel.
• The 'campaign_id' MUST be the unique Campaign ID that is found in the "Edit Campaign" page reached from the main page / control panel listing of campaigns.
• The searchField and sortField are:
  • promotion - For the text description of the promotion
  • operation - Whether the promotion is a "+" (add) or "x" (multiply) promotion.
  • multiplier - The amount the promotion adds to or multiplies the transaction amount by.

Example PHP Request:

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

1. $data['API'] = '1.5';
2. $data['user_id'] = 'john1970';
3. $data['user_api_key'] = '1959caadac9b13dcb3';
4. $data['account_id'] = 'greatwidgets';
5. $data['type'] = 'campaign_promos';
6. $data['campaign_id'] = '1111222233334444';
7. $data['searchField'] = 'promotion';
8. $data['searchValue'] = 'Bonus';
9. $data['searchOper'] = 'cn';
10. $data['sortField'] = 'promotion';
11. $data['sortOrder'] = 'ASC';
12. $data['offset'] = '30';
13. $data['length'] = '10';

Success XML Response:

1. <response status="success">
2. <campaign>
3. <id>1111222233334444</id>
4. <name>Campaign Name</name>
5. </campaign>
6. <pagination>
7. <total>56</total>
8. <offset>30</offset>
9. </pagination>
10. <promotions>
11. <promotion>
12. <id>365</id>
13. <operand>+</operand>
14. <value>1000</value>
15. <description>Sign-up Bonus</description>
16. <promo_custom_id>XFA-567</promo_custom_id>
17. <promo_start_date>2013-08-01 00:00:00</promo_start_date>
18. <promo_end_date>2013-08-31 23:59:59</promo_end_date>
19. </promotion>
20. <promotion>
21. <id>423</id>
22. <operand>x</operand>
23. <value>1.2</value>
24. <description>20% More Points Tuesdays Bonus</description>
25. <promo_custom_id>XFA-256</promo_custom_id>
26. <promo_start_date>2013-09-01 08:00:00</promo_start_date>
27. <promo_end_date>2013-09-31 23:59:59</promo_end_date>
28. </promotion>
29. ...
30. </promotions>
31. </response>

Notes:
Operands are either:

• "+" to add or subtract (negative value) an amount from the transaction.
• "x" to multiply the amount of the transaction by the value

No Promos XML Response:

1. <response status="none">
2. <message>Language-specific message</message>
3. </response>

Error XML Response:

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