API Documentation

API DOCUMENTATION

Last Update: Mar 28, 2022



Premiere Access Enterprise-Level API Calls API Calls Overview Clients (Businesses) Account - Update Account - Info Dashboard - Info Custom Fields Customer Field - Create Customer Fields - List Customer Field - Update Customer Field - Delete Transaction Field - Create Transaction Fields - List Transaction Field - Update Transaction Field - Delete Reward Custom Field - Create Reward Custom Fields - List Reward Custom Field - Update Reward Custom Field - Delete Users (Business Employees) User - New User - Update Users - List User - Info User - Delete Users - Add to Campaign Users - Rem. from Campaign Loyalty Programs Campaign - New Campaign Campaign - New Reward Campaign - New Promo Campaign - New BuyX Item Campaign - New Depreciation Campaign - New Fee Campaign - Update Campaign Campaign - Update Reward Campaign - Update Promo Campaign - Update BuyX Item Campaign - Update Depreciation Campaign - Update Fee Campaign - List Campaigns Campaign - List Deactivated Campaign - List Rewards Campaign - List Promotions Campaign - List Depreciations Campaign - List Fees Campaign - List BuyX Items Campaign - Delete Campaign Campaign - Delete Reward Campaign - Delete Promo Campaign - Delete BuyX Item Campaign - Delete Depreciation Campaign - Delete Fee Campaign - Deactivate Campaign - Reactivate Customers Customer - New/Register Customer - Update Customer - Generate Card # Customer - Batch Customer - Search Customer - Find Customer - Information Customer - Exists Customer - Balance & History Customer - Delete Customer - Validate Card Replace Transactions Transaction - Record Transaction - Redeem Transaction - Batch Transaction - Delete Misc. Calls: Token - Get Token - Validate Audit Reports All Transactions All Redeemed Transactions Campaign Totals Customer Balances Marketing Reports All Customers New Customers Frequent Customers Missing Customers Birthdays Custom Date Range Customer Search Reference Currency Codes Country Codes Timezones Available Languages User Permission Levels Replacement Codes Premium APIs Email Templates Email Template - New Email Template - Update Email Template - Information Email Templates - List Email Template - Delete SMS Templates SMS List Service Providers SMS Add Credentials SMS Update Credentials SMS Template - New SMS Template - Update SMS Template - Information SMS Templates - List SMS Template - Delete Memberships Membership Program - New Membership Program - Update Membership Program - Info Membership Programs - List Membership Program - Delete Membership Level - New Membership Level - Update Membership Level - Info Membership Levels - List Membership Level - Delete Boost Promos Fixed Boost - New Fixed Boost - Update Temporary Boost - New Temporary Boost - Update Recurring Boost - New Recurring Boost - Update Boost - Info Boost - List Boost - Delete

BuyX Campaign Items List

Returns a list of the items that can be accumulated for the given "Buy X Get One Free" campaign.

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

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959caadac9b13dcb3	Required
account_id	greatwidgets	Required
type	buyx_items_list	Required
campaign_id	1111222233334444	Required

searchField	service_product or reward_id buy_amount	Optional
searchOper	eq (equal) ne (not equal) bw (begins with) bn (does not begin with) ew (ends with) en (does not end with) cn (contains) nc (does not contain) nu (is null/empty) nn (is not null/empty) in (is in - comma-separated list) ni (is not in - comma-separated list)	Optional
searchValue	Coffee (service_product)or 51 (reward_id) or 10 (buy_amount)	Optional

sortField	service_product or reward_id buy_amount	Optional
sortOrder	DESC or ASC	Optional

offset	0	Optional
length	10	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:

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:
  - service_product - For the text description of the items accumulated
  - reward_id - the Reward ID of the item.
  - buy_amount - The amount of times the item has to be purchased to earn a free one.

Example PHP Request:

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

$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['type'] = 'buyx_items_list';
$data['account_id'] = 'greatwidgets';
$data['campaign_id'] = '1111222233334444';
$data['searchField'] = 'service_product';
$data['searchValue'] = 'Coffee';
$data['searchOper'] = 'cn';
$data['sortField'] = 'service_product';
$data['sortOrder'] = 'ASC';
$data['offset'] = '30';
$data['length'] = '10';

Success XML Response:

<response status="success">
<campaign>
<id>1111222233334444</id>
<name>Store Rewards!</name>
</campaign>
<pagination>
<total>56</total>
<offset>30</offset>
<pagination>
<buyx_items>
<item>
<id>345</id>
<description>Coffees and Lattes</description>
<quantity>8</quantity>
</item>
<item>
<id>494</id>
<description>Blended Drinks</description>
<quantity>12</quantity>
<reward_id>12398749834</reward_id>
</item>
...
</buyx_items>
</response>

Notes:

The "quantity" is the amount of the item needed to be purchased before the next one is free – Not a customer's balance.
When identifying the item (or "reward") to the API, you MUST use the <id> that is returned in the XML construct, NOT the <reward_id> which corresponds to the optional item_identifier field.

Error XML Response:

<response status="error">
<error>Error message</error>
</response>