Formatting an Item Group
Follow the CSV formatting rules for your Item Groups. Download a CSV template here:
Formatting Guides
Please follow these file formatting rules before uploading your Item Group:
Your file must be in a comma-separated value (CSV) format. We recommend saving as a UTF-8 file to preserve any special character formatting.
Headers should always be present.
Item name(s) is/are the minimum requirement and should always be entered as it is printed on the receipt (or as it is sent in the API integrations).
Quantity is always 1. If left blank, the value will default to 1.
Adjusted cost is only required for a Price Adjustment offer type. Otherwise, leave blank.
Offer types Fixed Discount ($) and Fixed Discount (%) DO NOT require a qualifying item group.
When you are setting up an offer, the way you to format your qualifying item groups are dependent on the offer type. Here are example Item Groups for each offer type:
Free Item
You're setting up a Free Item offer, enter all the items that qualify as the free item. In the offer setup, set this item group as the Eligible Qualifier and Reward Items. The member will be able to redeem any one of these items as a free item.
item_name | quantity | adjusted_cost |
---|---|---|
Watermelon Cooler | 1 | |
Summer Salad | 1 | |
Strawberry Sorbet | 1 |
BOGO
You're setting up a BOGO offer, enter all the items that qualify for the Buy One Get One (BOGO) offer. In the offer setup, set this item group as the Eligible Qualifier Items and Eligible Reward Items. If any two of these items are in their cart, the member will be able to redeem one as the free item (of equal or lesser value).
For more advanced BOGO offers, you can also define separate Item Groups for the Eligible Qualifier Items and the Eligible Reward Items. For example, Buy a sandwich, get a free chips. Where the Eligible Qualifier Items group will consist of sandwich line-items and the Eligible Rewards Items group will consist of chip line-items.
item_name | quantity | adjusted_cost |
---|---|---|
Turkey Sandwich | 1 | |
BLT Sandwich | 1 | |
Reuben Sandwich | 1 |
Price Adjustment
You're setting up a Price Adjustment offer type, enter all the items that qualify for a price adjustment and the discounted price. In the offer setup set this group as the Eligible Qualifier Items and the Eligible Reward Items. The member will be able to purchase any of the line-items at the discounted price (e.g. $5 Sub Special, usually priced at $7).
Note: the "adjusted_cost" is the cost of the item you want it to be, not the amount to be discounted. The discount will be calculated automatically.
item_name | quantity | adjusted_cost |
---|---|---|
Meatball Sub | 1 | 5 |
Roast Beef Sub | 1 | 5 |
Grilled Portabello Sub | 1 | 5 |
Managing an Item Group
An Item Group is a list of line-items used to limit the eligible items for an offer redemption. When a member wants to redeem an offer, their order will be first validated for the correct item names and quantity of items, and then the correct discount is applied. When the member’s order does not have the specified line-items from the Item Group, an error occurs that prevents the offer from being redeemed.
Note: this workflow varies slightly per integration type. Contact your Customer Success Manager for more details.
Things to Know
When creating or updating an Item Group with special characters, be sure to save your file as a UTF-8 .csv to preserve its formatting.
Create New Item Group
Before you create your Item Group, know your campaign objective and review the Formatting Item Groups Guidelines.
-
Navigate to Campaigns > Item Groups.
-
Click the add
icon to create a new item group. -
Name your item group.
-
Drag and drop or upload your CSV file containing your group of items.
IMPORTANT: Your file must follow the Formatting Item Groups Guidelines.
-
Click on Save to create your item group.
View Item Group
There are 2 ways to view the items in group — viewing direct within the dashboard, and downloading it as a CSV file. Downloading the item group is also helpful when you want to update a group.
View in Dashboard
Navigate to Campaigns > Item Groups.
In the row of the Item Group, go to Manage > View.
Download Item Group
-
Navigate to Campaigns > Item Groups.
-
In the row of the Item Group, go to Manage > View.
-
Click the download
icon, and the CSV file will directly download to your device.
Update Item Group
Update/Overwrite
Updating your Item Group will overwrite all its contents. This is recommended for any modifications — such as an add, remove, and/or edit item(s).
-
Navigate to Campaigns > Item Groups.
-
In the row of the Item Group, go to Manage > View.
-
Click the update
icon. -
Upload your new CSV file containing the updated items and Save Changes.
IMPORTANT: Your file must follow the Formatting Item Groups Guidelines.
Delete Item(s) within a Group
An Item Group must have at least 1 item. If you want to update all the items in a list, we recommend using the update method.
-
Navigate to Campaigns > Item Groups.
-
In the row of the Item Group, go to Manage > View.
-
Select the checkbox next to the item(s) you want to delete.
-
Click the delete
icon. -
Confirm your delete of selected items.