Data reports

Coupon issues (campaign or period)
Coupon validations (campaign or period)
Multi user subscription report
Games issued (campaign or period)
Games played (campaign or period)
Members
Receipts
Settlement report
Shop transaction report
Subscriptions report
Subscriptions settlement report
Surveys (campaign or period)

 

 

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
ScheduleDescriptionName of the schedule.String
MediaTypeIndicates whether it game was issued on App, SMS or as a Codes campaign.String
CustomerDateTimeLocal 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
CustomerIdUnique 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 (campaign or period)

ParameterDescriptionData type
GameIdUnique id of the game.Integer
ScheduleIdUnique Id of the schedule (campaign) that the game belongs to.Integer
ScheduleDescriptionName of the scheduleString
MediaTypeIndicates whether it game was issued on App, SMS or as a Codes campaign.String
CustomerIdUnique Id for the customer.Integer
IssueTimeLocal time of the issue.String
IssueTimeUTCUTC time of the issue.String
ExpirationTimeLocal time of the expiration.String
ExpirationTimeUTCUTC time of the expiration.String
UserUnique identifier of the user (shopper).String

 

 

Games played (campaign or period)

ParameterDescriptionData type
GameIdUnique id of the game.Integer
ScheduleIdUnique Id of the schedule (campaign) that the game belongs to.String
ScheduleDescriptionName of the scheduleString
MediaTypeIndicates whether the game was issued on App, SMS or as a Codes campaign.String
CustomerIdUnique Id for the customer.Integer
IssueTimeLocal time of the issue.String
IssueTimeUTCUTC time of the issue.String
RedemptionTimeLocal time when the user has played the game.String
RedemptionTimeUTCUTC time when the user has played the game.String
UserUnique identifier of the user (shopper).String
PrizeIdUnique Id of the prize.Integer
PrizeNameName of the prize.String
ChosenPrizeIndicates the prize chosen by the user when it is possible to select it.String
GameStateIndicates when the game has been played.String
GameResultIndicates if the user won.String

 

 

Members

ParameterDescriptionData type
UserIdUnique Id for the user (shopper).String
CurrentJoinDate when the user first became a member.String
LocalStoreIdsUnique Ids of the preferred stores for this user.Integer
LocalStoreNamesName of the selected stores.String
Birthday.String
Gender.String
NotesAdditional notes.String
Postbox/Zip.String
LastBirthdaySMSDate of the last birthday reward sent to the user.String
MemberUserGroupsUserGroups to which this user belongs.String
MSNPhone number of the user.Integer
Name.String
Address.String
E-mail.String
CulturePreferred language for the user.String

 

 

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
RebateOnSubTotalPrice reduction on the total basket value.Number
TenderOnSubTotalPrice reduction given as means of payment on the total basket value.Number
TotalTaxAmountTotal amount of taxes the user has paid.Number
TotalToPayTotal basket value shopper has paid.Number
EANEuropean Article NumberInteger
ProductCodeCode of the purchased product (s).String
QuantityNumber of purchased products.Number
SalesPriceRetail price.Number
RebatePrice reduction.Number
TenderPrice reduction given as means of payment.Number
RebatedPricePrice after rebate.Number
TaxAmountAmount of taxes per product.Number
TaxPercentagePercentage at which product is taxed.Number
DescriptionDescription of the purchased products.String
OperatorRefId of the cashier that served this customer.String
POSRefUnique Id of the POS.String
StoreRefUnique Id of the store in which the purchase has been made.String
TransRefUnique Id of the transaction.String
UserRefUnique identifier of the user.String
LocalTimeLocal time of the purchase.String
CouponCodeCode of the coupon used in purchase.String
CampaignIdUnique Id for the campaign.Integer
MemberIdUnique Id of the user.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 report

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 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
TypeRenewal of the subscription, or a New oneString
Discount %Percentage discount customer has received (1 - Paid / Regular price)String
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

 

Subscriptions settlement report

 

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 WashesTotal number of washes made by user on this subscription periodInteger
Value/WashValue per wash (Subcription amount / Total washes)Number
StoreStore in which the washes have been madeString
# Washes/StoreNumber of washes in the storeInteger
Allocation AmountAmount of money to be alloacted per store (Value/wash * # washes/store)Number
Upselling AmountAmount of money from upselling, to be allocated to the registered local storeNumber
Total AmountAllocation amount + Upselling amountNumber
Tax AmountThe tax amount paid by customer, tax part of total amountNumber

 

 

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
DateIssuedLocal time of the issue.String
DateStartedLocal time when the user started the survey.String
DateCompletedLocal time when the user finished the survey.String
ExternalRefIndicates if a coupon has been manually sent from Dashboard.String
Question 1 answers {question text}Answers of the survey. The question text can be found in the column header.String
Question 2 answers {question text}Answers of the survey. The question text can be found in the column header.String
Etc.