Dataset Details
demographics
This table contains demographic information for a portion of households. Due to nature of the data, the demographic information is not available for all households.
| Variable | Description |
|---|---|
household_id |
Uniquely identifies each household |
age |
Estimated age range |
income |
Household income |
home_ownership |
Homeowner, renter, etc. |
marital_status |
Marital status (Married, Single, Unknown) |
household_size |
Size of household up to 5+ |
household_comp |
Household composition |
kid_count |
Number of children present up to 3+ |
transactions
Contains transaction-level product purchases by households (what you would normally see on a receipt). Use a sample of all transactions (transactions_sample) or get the entire data set with get_transactions().
| Variable | Definition |
|---|---|
household_id |
Uniquely identifies each household |
store_id |
Uniquely identifies each store |
basket_id |
Uniquely identifies each purchase occasion |
product_id |
Uniquely identifies each product |
quantity |
Number of the product purchased during the trip |
sales_value |
Amount of dollars the retailer receives from sale |
retail_disc |
Discount applied due to the retailer’s loyalty card program |
coupon_disc |
Discount applied due to a manufacturer coupon |
coupon_match_disc |
Discount applied due to retailer’s match of manufacturer coupon |
week |
Week of the transaction; Ranges 1-53 |
transaction_timestamp |
Date and time of day when the transaction occurred |
The variable sales_value in this table is the amount of dollars received by the retailer on the sale of the specific product, taking the coupon match and loyalty card discount into account. It is not the actual price paid by the customer. If a customer uses a coupon, the actual price paid will be less than the sales_value because the manufacturer issuing the coupon will reimburse the retailer for the amount of the coupon.
To calculate the actual product prices, use the formulas below:
- Loyalty card price = (sales_value – (retail_disc + coupon_match_disc)) / quantity
- Non-loyalty card price = (sales_value – (coupon_match_disc)) / quantity
The example below demonstrates how to calculate the actual shelf price of the product:
- Line 1 – When this product was purchased the
retail_discandcoupon_discwere both zero, meaning the price of the product is the same as the amount received by the retailer. - Line 2 – Two items of this product were purchased, and there was a retail discount applied due to a loyalty card. To determine the regular shelf price of the product (exclusive of loyalty card discount) we take the sum of the amount paid and the discount, then divide it by the quantity (\(\$3.34 + \$0.36) \div 2 = \$1.85\). The shelf price of the product including loyalty card discount is \(\$3.34 \div 2 = \$1.67\). In this case, the customer paid $3.34 for both of these products, which is the same amount the retailer received.
- Line 3 – The actual shelf price of each product here is (\(\$2.89 + \$0.45) \div 2 = \$1.67\). In this case, the customer paid $2.34 (\(\$2.89 - \$0.55\)) for these products, but the retailer will receive $2.89 due to reimbursement of the manufacturer discount.
campaigns
Contains identifying information for the marketing campaigns each households participated in.
| Variable | Definition |
|---|---|
campaign_id |
Uniquely identifies each campaign; Ranges 1-27 |
household_id |
Uniquely identifies each household |
campaign_descriptions
Contains campaign metatdata, specifically the time a campaign was active.
| Variable | Definition |
|---|---|
campaign_id |
Uniquely identifies each campaign; Ranges 1-27 |
campaign_type |
Type of campaign (Type A, Type B, Type C) |
start_date |
Start date of campaign |
end_date |
End date of campaign |
products
Contains metatdata regarding the products purchased (brand, description, etc.).
| Variable | Definition |
|---|---|
product_id |
Uniquely identifies each product |
manufacturer_id |
Uniquely identifies each manufacturer |
department |
Groups similar products together |
brand |
Indicates private or national label brand |
product_category |
Groups similar products together at lower level |
product_type |
Groups similar products together at lowest level |
package_size |
Indicates package size (not available for all products) |
coupons
This table lists all the coupons sent to customers as part of a campaign, as well as the products for which each coupon is redeemable. Some coupons are redeemable for multiple products. One example is a coupon for any private label frozen vegetable. There are a large number of products where this coupon could be redeemed.
For campaign TypeA, this table provides the pool of possible coupons. Each customer participating in a Type A campaign received 16 coupons out of the pool. The 16 coupons were selected based on the customer’s prior purchase behavior. Identifying the specific 16 coupons that each customer received is outside the scope of this database.
For campaign Type B and Type C, all customers participating in a campaign receives all coupons pertaining to that campaign.
| Variable | Definition |
|---|---|
coupon_upc |
Uniquely identifies each coupon (unique to household and campaign) |
product_id |
Uniquely identifies each product |
campaign_id |
Uniquely identifies each campaign |
coupon_redemptions
Contains individual coupon redemptions (household, day, UPC code, campaign) that can be used to measure campaign efficacy and coupon usage on specific products.
| Variable | Definition |
|---|---|
household_id |
Uniquely identifies each household |
coupon_upc |
Uniquely identifies each coupon (unique to household and campaign) |
campaign_id |
Uniquely identifies each campaign |
redemption_date |
Date when the coupon was redeemed |
promotions
Contains product placement information (e.g. mailer page placement and in-store display placement) corresponding to campaigns. Use a sample of all promotions (promotions_sample) or get the entire data set with get_promotions().
| Variable | Definition |
|---|---|
product_id |
Uniquely identifies each product |
store_id |
Uniquely identifies each store |
display_location |
Display location (0-display, 1-store front, 2-store rear, 3-front end cap, 4-mid-aisle end cap, 5-rear end cap, 6-side aisle end cap, 7-in-aisle, 9-secondary location display, A-in-shelf) |
mailer_location |
Mailer location (0-not on ad, A-interior page feature, C-interior page line item, D-front page feature, F-back page feature, H-wrap front feature, J-wrap interior coupon, L-wrap back feature, P-interior page coupon, X-free on interior page, Z-free on front page, back page, or wrap) |
week |
Week of the transaction; Ranges 1-53 |