Data reports

Coupon issues (campaign or period)
Coupon validations (campaign or period)
Multi user subscription report
Games issued
Games played
Members
Receipts
Settlement report
Shop transaction (campaign or period)
Shop settlement (campaign or period)
Subscriptions report
Subscriptions settlement report
Surveys (campaign or period)
Points Transaction
Detailed Points Transaction
Gift Card Report

Coupon issues (campaign or period)

ParameterDescriptionData type
CampaignIdUnique Id for the campaign. One campaign can be linked to several schedules.Integer
CampaignNameName of the campaign.String
ScheduleIdUnique Id of the schedule linked to the campaign.Integer
Schedule DescriptionName of the schedule.String
MediaTypeIndicates whether it game was issued on App, SMS or as a Codes campaign.String
CustomerUnique Id for the customer owner of the campaign.Integer
Date TimeLocal time of issue of the coupon.String
DateTimeUTCUTC time of issue of the coupon.String
ExpirationDateTimeLocal time of the expiration.String
ExpirationDateTimeUTCUTC time of the expiration.String
ValueCodeThe unique code for this coupon.String
UserReferenceUnique identifier of the user (shopper).String
ValidationLimitNumber of times each coupon can be validated.Integer
ExternalRefReference received from third party when coupons have been issued using Coupon API - Issue request or if content has been sent manually.String

 

 

 

Coupon validations (campaign or period)

ParameterDescriptionData type
CampaignIdUnique Id for the campaign. One campaign can be linked to several schedules.Integer
CampaignNameName of the campaign.String
ScheduleIdUnique Id of the schedule linked to the campaign.Integer
ScheduleDescriptionName of the schedule.String
ScheduleOwnerName of the customer that created the schedule.String
MediaTypeIndicates whether the coupon was issued on App, SMS or as a Codes campaign.String
CustomerUnique Id for the customer owner of the campaign.Integer
CountryCustomer's country of operation.String
StoreRefUnique Id of the store in which the validation has been made.String
StoreNameName of the store in which the validation has been made.String
POSRefUnique Id of the POS.String
OperatorRefId of the cashier that served this customer.String
TransRefUnique Id of the transaction.String
DateTimeLocal time of the validation.String
DateTimeUTCUTC time of the validation.String
ValueCodeUnique coupon code that has been validated.String
UserReferenceUnique identifier of the user.String
ExtParamFor customers with Promotion ID based POS integration, this contains the POS settings of the campaign, eg. a Promotion ID and/or Tender IDString
MerchantRemunerationThe monetary value that the merchant should be compensated per coupon redemption.Number
HandlingFeeA secondary monetary value that the merchant should be compensated per coupon redemption.Number
RebateValueValue of the price reduction.Number
TenderValueValue of the price reeduction given as means of payment.Number
TotalValueThe total value of the complete receipt where this coupon was used.Number
ValidationCountNumber of times a coupon has been validated.Integer
ExternalRefReference received from third party when coupons have been issued using Coupon API - Issue request or if content has been sent manually.String

 

 

 

Multi user subscription report

ParameterDescriptionData type
ParentMemberIDUnique Id for member that owns the family enabled subscription plan. One parent can be linked to several children, depending on plan configuration.String
ParentAppUserIDUnique App Id for member that owns the family enabled subscription plan. One parent can be linked to several children, depending on plan configuration.String
ChildAppMemberIDUnique Member Id for member that has been given access to family enabled subscription plan. One child can be linked to several parents.String
ChildAppUserIDUnique App Id for member that has been given access to family enabled subscription plan. One child can be linked to several parents.String
StartedDateDate and time when child was granted access to campaign by parent.Date
StoppedDateDate and time when child's access to campaign was revoked by parent.Date
State (Active/Inactive)A parameter that indicates whether (Active) or not (Inactive) child has access to the family subscription plan at time of report creation.String

 

 

 

Games issued

ParameterDescriptionData type
Game IdUnique id of the game.Integer
Schedule IdUnique Id of the schedule (campaign) that the game belongs to.Integer
Schedule DescriptionName of the scheduleString
Media TypeIndicates whether it game was issued on App, SMS or as a Codes campaign.String
Customer IdUnique Id for the customer.Integer
Issue TimeLocal time of the issue.String
Issue Time UTCUTC time of the issue.String
Expiration TimeLocal time of the expiration.String
Expiration Time UTCUTC time of the expiration.String
UserUnique identifier of the user (shopper).String

 

 

 

Games played

ParameterDescriptionData type
Game IdUnique id of the game.Integer
Schedule IdUnique Id of the schedule (campaign) that the game belongs to.String
Schedule DescriptionName of the scheduleString
Media TypeIndicates whether the game was issued on App, SMS or as a Codes campaign.String
Customer IdUnique Id for the customer.Integer
Issue TimeLocal time of the issue.String
Issue Time UTCUTC time of the issue.String
Redemption TimeLocal time when the user has played the game.String
Redemption Time UTCUTC time when the user has played the game.String
UserUnique identifier of the user (shopper).String
Prize IdUnique Id of the prize.Integer
Prize NameName of the prize.String
Chosen PrizeIndicates the prize chosen by the user when it is possible to select it.String
Game StateIndicates when the game has been played.String
Game ResultIndicates if the user won.String

 

 

 

Members

ParameterDescriptionData type
UserIdUnique Id for the user (shopper).String
CurrentJoinDate when the user first became a member.String
LocalStoreId(s)Unique Ids of the preferred stores for this user.Integer
LocalStoreName(s)Name of the selected stores.String
BirthdayString
GenderString
NotesAdditional notes.String
Postbox/ZipString
LastBirthdaySMSDate of the last birthday reward sent to the user.String
MemberUserGroupsUserGroups to which this user belongs.String
MSNPhone number of the user.Integer
NameString
AddressString
E-mailString
CulturePreferred language for the user.String
TierOnly relevant for customers with points program. Member tier.String
ExternalIdentifierOnly relevant for customers with foreignId. Unique member identifier.String
MemberIdUnique identifier for each member.Long

 

 

 

Receipts

ParameterDescriptionData type
ReceiptIdUnique Id of the receipt. Each item on the receipt will fill one line in the report. Example: if user purchases three items, receipt will cover three lines.String
SubTotalTotal basket value.Number
Rebate On SubTotalPrice reduction on the total basket value.Number
Tender On SubTotalPrice reduction given as means of payment on the total basket value.Number
Total Tax AmountTotal amount of taxes the user has paid.Number
Total To PayTotal basket value shopper has paid.Number
EANEuropean Article NumberInteger
Product CodeCode of the purchased product (s).String
QuantityNumber of purchased products.Number
Sales PriceRetail price.Number
RebatePrice reduction.Number
TenderPrice reduction given as means of payment.Number
Rebated PricePrice after rebate.Number
Tax AmountAmount of taxes per product.Number
Tax PercentagePercentage at which product is taxed.Number
Tax DescriptionExtra field to add tax informationString
Operator RefId of the cashier that served this customer.String
DescriptionDescription of the purchased products.String
POS RefUnique Id of the POS.String
Store RefUnique Id of the store in which the purchase has been made.String
Trans RefUnique Id of the transaction.String
User RefUnique identifier of the user.String
Local TimeLocal time of the purchase.String

 

 

 

Settlement report

ParameterDescriptionData type
AccountString
SubAccountString
CampaignIdUnique Id for the campaign. One campaign can be linked to several schedules.Integer
CampaignNameName of the campaign.String
ScheduleIdUnique Id of the schedule linked to the campaign. The schedule defines the actual issue of content to users (shoppers).Integer
ScheduleDescriptionName of the schedule.String
ScheduleOwnerName of the customer that created the schedule.String
StoreRefUnique Id of the store in which the validation has been made.String
StoreNameName of the store in which the validation has been made.String
TransRefUnique Id of the transaction.String
DateTimeLocal time of the validation.String
ExtParamFor customers with Promotion ID based POS integration, this contains the POS settings of the campaign, eg. a Promotion ID and/or Tender IDString
MerchantRemunerationThe monetary value that the merchant should be compensated per coupon redemption.Number
HandlingFeeA secondary monetary value that the merchant should be compensated per coupon redemption.Number
RebateValueValue of the price reduction.Number
TenderValueValue of the price reeduction given as means of payment.Number
ExternalRefReference received from third party when coupons have been issued using Coupon API - Issue request or if content has been sent manually.String

 

 

 

Shop transaction (campaign or period)

The purpose of this report is allow the retailer to match all transactions on the app towards the money coming in from the payment provider. The key field in the report is “Payment Ref”. This is the transaction reference from the payment provider.

ParameterDescriptionData type
Internal IDLiquid Barcodes internal transaction idString
Shop offer IDUnique Id for the shop offer. Shop offer is a product customers can buy in the web shop / in app.Number
Shop offer nameName of the shop offerString
Processing dateDate when shop offer was purchasedString
Processing date UTCDate when shop offer was purchased in UTCString
User referenceUnique identifier of the user.String
Merchant remunerationStore compensation per purchased shop offer.Number
Retail pricePrice paid by customer for the shop offer.Number
CurrencyCurrencyString
Payment refTransaction reference from the payment providerString
Payment provider nameName of the payment providerString
Payment methodDescription of the payment method used to buy the shop offerString
Member IDUnique identifier of the user.String
Store IDStore identifierNumber
CodeID of the content that was issued as result of the purchase of the shop offerNumber
Tax AmountThe tax amount paid by customer for the shop offerNumber
Promo codesCode used by customer on purchase of shop offer, giving a rebated priceString
Tax detailsBreakdown of the tax amount on different tax ratesString

 

 

 

Shop settlement (campaign or period)

The purpose of this report is to allow the retailer to allocate single-use coupon sales amount received to the central merchant account (HQ), to the stores where usage has happened.  For a given period the report will show single-use coupon codes that are: Used in the report period, Expired in the report period, Active at report period end (purchased before or on period end, but not used or expired at report end). The shop transaction report only show transactions for a specific date/period (processing date), whereas the shop settlement report will show all used/expired/active codes for the date/period report is generated. Report details: “Code status”: “Used” or “Expired” – or “Active” if not used or expired. “Store ID”: If Code status = Used, column show StoreID, If Code status = Expired, column show StoreID of shopper’s local (home) store, If Code status = Active, column is blank. “DateTime”: show the local time of usage or expiration time. If Code status = Used, time of coupon usage, If Code status = Expired, expiration time, If Code status = Active, column is blank.

ParameterDescriptionData Type
CodeID of the content that was issued as result of the purchase of the shop offerNumber
Store IDStore identifierNumber
DateTimeLocal time of usageString
DateTimeUTCUTC time of usageString
Internal IDLiquid Barcodes internal transaction idString
Shop offer IDUnique Id for the shop offer. Shop offer is a product customers can buy in the web shop / in app.Number
Shop offer nameName of the shop offerString
Processing dateDate when shop offer was purchasedString
Processing date UTCDate when shop offer was purchased in UTCString
User referenceUnique identifier of the user.String
Merchant remunerationStore compensation per purchased shop offer.Number
Retail pricePrice paid by customer for the shop offer.Number
CurrencyCurrencyString
Payment refTransaction reference from the payment providerString
Payment provider nameName of the payment providerString
Payment methodDescription of the payment method used to buy the shop offerString
Member IDUnique identifier of the user.String
Tax AmountThe tax amount paid by customer for the shop offerNumber
Promo codeCode used by customer on purchase of shop offer, giving a rebated priceString

 

 

 

Subscriptions report

ParameterDescriptionData type
DateDay for which the report has been requestedString
UserIDUnique Id for the userString
Start DateLocal time of the first startString
Pay DateLocal time when the payment successString
End DateLocal time for the end of the subscriptionString
MonthNumber of months the subscription has been activeInteger
TypeThe type of subscription transaction: Renewal or NewString
Discount %Percentage discount customer has received (1 - Paid / Regular price)String
Type SubscriptionName of the subscription shop offer productString
Regular priceNormal price of the subscriptionNumber
PaidPrice user has actually paidNumber
Payment TypePayment method of the userString
Favorite StoreUser's preferred storeString
Upgrade/DowngradeIf payment was related to an Upgrade or Downgrade of their planString
Promo codesCode used by customer on purchase of shop offer, giving a rebated priceString

 

 

 

Subscriptions settlement report

The purpose of this report is to allow the retailer to allocate the subscription amount received to the central merchant account (HQ), to the stores where the usage has been over the subscription period. In the report only concluded subscription periods for a member (subscriber) will be present i.e. 30 days after the payment date. For a member there can be multiple rows, if usage across multiple stores. If the member have only used the subscription at one store there will be only one row for this member. If the member has not used the subscription at all in the subscription period there will be one row and the store is the member`s local/home store. The report auto-allocates the entire subscription amount to the local/home store if there is no usage. For members with usage across multiple stores the allocation amount is pro-rata based on usage.

ParameterDescriptionData type
Customer #Unique id for the userString
Payment ref.Payment reference id from the payment providerString
Payment dateLocal time of the paymentString
Subscription AmountTotal paid for the subscription periodNumber
Total UsageTotal number of usage made by user on this subscription periodInteger
Value/UsageValue per usage (Subscription amount / Total usage)Number
StoreStore in which the usage have been madeString
# Usage/StoreNumber of usage in the storeInteger
Allocation AmountAmount of money to be allocated per store (Value/usage * # Usage/store)Number
Upselling AmountAmount of money from upselling, to be allocated to the correct store of usage. Upselling amount is disaggregated to show each upsell transaction on individual rows with Payment Ref, Payment Date, Store, Upselling Amount and Tax Amount.Number
Total AmountAllocation amount + Upselling amountNumber
Allocation Amount Before TaxAmount of money to be allocated per store (Value/usage * # Usage/store) excluding TaxNumber
Upselling Amount Before TaxAmount of money from upselling, to be allocated to the correct store excluding TaxNumber
Total Amount Before TaxAllocation amount + Upselling amount excluding TaxNumber
Tax AmountThe tax amount paid by customer, tax part of total amountNumber
Tax DetailsBreakdown of the tax amount on different tax ratesString

 

 

 

Surveys (campaign or period)

ParameterDescriptionData type
MsnPhone number of the user.Integer
UserIdUnique identifier of the user.String
SurveyIdUnique Id of the answered survey.Integer
Date IssuedLocal time of the issue.String
Date StartedLocal time when the user started the survey.String
Date CompletedLocal time when the user finished the survey.String
External RefIndicates if a coupon has been manually sent from Dashboard.String
Question 1 answers (selection option)Answers of the survey. The selection option text can be found in the column header.String
Question 2 answers (selection option)Answers of the survey. The selection option text can be found in the column header.String
Etc.
 

 

Points Transaction

ParameterDescriptionData type
TypeEarned, Spent, ExpiredString
UserReferenceUnique identifier of the userString
MemberIdUnique Id of the userString
TimestampThe time stamp of points earningString
PointsNetChangeThe change in points as result of rule or purchase using pointsNumber
BonusPointsBonusPoints earned e.g. as gold memberNumber
PointsRewardRuleIDID of the points earn ruleNumber
PointsRewardRuleNameDescription of the points earn ruleString
ExpirationDateThe time stamp of the points expiryString
 

 

Detailed Points Transaction

ParameterDescriptionData type
TypeEarned, Spent, ExpiredString
UserReferenceUnique identifier of the user.String
MemberIdUnique Id of the user.String
TimestampThe time stamp of points earningString
PointsNetChangeThe change in points as result of rule or purchase using pointsNumber
BonusPointsBonusPoints earned e.g. as gold memberNumber
StoreRefUnique Id of the store in which the purchase has been made.String
TransRefUnique Id of the transaction.String
ReceiptIdUnique Id of the receipt.String
EarnRuleIdUnique Id of the rule.Integer
EarnRuleNameName of the points earn ruleString
ExpirationDateThe time stamp of the points expiryString
BurnRuleIdsUnique Id of the burn ruleInteger
BurnRulesNamesName of the points burn ruleString
Shop Offer IdUnique Id for the shop offer. Shop offer is a product customers can buy in the web shop / in app.Integer
Shop offer nameName of the shop offerString
 

 

Gift Card Report

ParameterDescriptionData Type
StoreRef*Unique Id of the store in which the purchase has been made.String
Date*Date for which the gift card has been usedString
ExtParam*For customers with Promotion ID based POS integration, this contains the POS settings of the campaign, eg. a Promotion ID and/or Tender IDString
Description*Top-up, SpendString
Total amount*Total allocation amountNumber
Number of transactions*Number of times the transaction have been madeNumber
Period**Defined period covered by the transactionString
Type**Balance, ExpiredString
Amount**Total currency value of remaining balance on all active cards or value of all expired cards in the period.Number
NumberOfCards**Total number of active cards or number of cards that have expired in the period.Number

*Gift Card Transaction Report
**Gift Card Balance Report