Parameter | Description | Data type |
---|---|---|
Account | It can take following values:
| String |
SubAccount | A composition of “Account” + “CampaignID”. | String |
CampaignId | Unique Id for the campaign. One campaign can be linked to several schedules. | Integer |
CampaignName | Name of the campaign. | String |
ScheduleId | Unique Id of the schedule linked to the campaign. The schedule defines the actual issue of content to users (shoppers). | Integer |
ScheduleDescription | Name of the schedule. | String |
ScheduleOwner | Name of the customer that created the schedule. | String |
StoreRef | Unique Id of the store in which the validation has been made. | String |
StoreName | Name of the store in which the validation has been made. | String |
TransRef | Unique Id of the transaction. | String |
DateTime | Local time of the validation. | String |
ExtParam | The external parameter passed to the POS for this validation. For customers with Promotion ID based POS integration, this contains the POS settings of the campaign, eg. a Promotion ID and/or Tender ID | String |
MerchantRemuneration | The monetary value that the merchant should be compensated per coupon redemption. | Number |
HandlingFee | A secondary monetary value that the merchant should be compensated per coupon redemption. Any handling fee that the merchant should be compensated for. It is independent of the merchant remuneration. | Number |
RebateValue | Value of the price reduction. | Number |
TenderValue | Value of the price reduction given as means of payment. | Number |
ExternalRef | Reference received from third party when coupons have been issued using Coupon API - Issue request or if content has been sent manually. | String |