--- title: "Create" method: POST path: "/connect/messages" tags: ["Message At Till"] --- # Create `POST /connect/messages` This API endpoint allows the calling application to request a set of additional information from EES AIR. These Messages could then be displayed on a Till screen, printed on a Consumer receipt, etc. EES AIR uses configurations or even data from external systems to construct returned Messages. ## Headers - `Accept-Encoding` '''' | ''gzip'' | ''deflate'' | ''gzip,deflate'' | ''deflate,gzip'', string - `Connection` 'keep-alive' | 'close', string - `Content-Type` string, string - `X-EES-AUTH-CLIENT-ID` string, string, required - `X-EES-AUTH-HASH` string, string, required - `X-EES-TRANSACTION-ID` string, string - `X-CUSTOM-SUBSYSTEM-ID` string, string - `X-CUSTOM-KEY` string, string ## Request body - object - `walletId` string, string — EES Wallet ID. Issued coupons will be added to the wallet associated to this walletId. Optional - `identity` object — The Identity that this message relates to. - `identityValue` string, string — Identity Value - `reference` string, string, required — Merchant Reference for a Consumer Transaction - `location` LocationEntity - `location` string, string — [Optional] Outlet incoming identifier where Transaction has happened - `basket` union - StandardBasketEntity - `type` 'STANDARD', required - `summary` object - `totalItems` integer, required — Basket Items count - `totalBasketValue` integer, required — Total Basket monetary Value after discounts, denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`) - `totalDiscountAmount` object - `promotions` integer, nullable — Promotions Discount Amount. If basket adjustment adds to discounts, this amount will be added to - `staff` integer, nullable — Staff Discount Amount - `general` integer, nullable — General Discount Amount - `totalQualifyingAmount` object, nullable - `points` integer — Basket Monetary Value for Loyalty Points calculations - `baseEarn` integer — Basket Monetary Value used for calculating base earn, overriding totalBasketValue. Adheres to basket discounts - `promotions` integer — Basket Monetary Value for Promotion Offer selections - `discount` integer — Basket Monetary Value for Discount calculations - `staff` integer — Basket Monetary Value for Staff Discount or Promotions - `totalTaxAmount` integer — Total Tax Amount denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`) - `adjustmentRules` AdjustmentRulesEntity - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about - `externalAdjustmentReason` string — The reason for externalAdjustment - `ignore` boolean — Ignore object as if not sent - `redemptionChannel` string, string — The redemption channel used for this request - `contents` object[], nullable - `sku` string, string — Item SKU - `upc` string, string — Item SKU - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag - `description` string, string — Product Name - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' | 'EACH' — The metric in which the item is measure (nullable) - `itemUnitCount` number — Item Quantity - `itemUnitDiscount` integer — Discount per Item - `totalUnitCost` integer — Total cost for this item - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts) - `taxRate` number, float — Tax Rate (Percentage) - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit - `qualifies` object, nullable - `discount` boolean, required — Determines if the item is eligible for basket level discounting. If false this item will not qualify for basket level discounts but still qualify for product level discounts. However this is possible to override based on the ‘ignorePreviousExcludes’ key on a campaign. - `points` boolean, required — Determines if the item is eligible for Base Earn points. If false this item will not qualify for Base Earn points but still qualify for basket and product level discounts. - `meta` MetaEntity - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `adjustmentRules` AdjustmentRulesEntity - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about - `externalAdjustmentReason` string — The reason for externalAdjustment - `ignore` boolean — Ignore object as if not sent - `relatedContents` object[] — Recursive list of contents related to the parent item with the same schema as this object. - `sku` string, string — Item SKU - `upc` string, string — Item SKU - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag - `description` string, string — Product Name - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' — The metric in which the item is measure (nullable) - `itemUnitCount` number — Item Quantity - `itemUnitDiscount` integer — Discount per Item - `totalUnitCost` integer — Total cost for this item - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts) - `taxRate` number, float — Tax Rate (Percentage) - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit - `qualifies` object, nullable - `discount` boolean, required — Determines if the item is eligible for basket level discounting. If false this item will not qualify for basket level discounts but still qualify for product level discounts. However this is possible to override based on the ‘ignorePreviousExcludes’ key on a campaign. - `points` boolean, required — Determines if the item is eligible for Base Earn points. If false this item will not qualify for Base Earn points but still qualify for basket and product level discounts. - `meta` MetaEntity - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `adjustmentRules` AdjustmentRulesEntity - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about - `externalAdjustmentReason` string — The reason for externalAdjustment - `ignore` boolean — Ignore object as if not sent - `relatedContents` unknown - `payment` object[], nullable - `tenderType` string, string, required — Tender type - predefined by Eagle Eye - `amount` integer, required — Monetary amount of payment in lowest unit of currency - `bin` string, string — The bin for the tender - `identifier` string, string — An identifying value of what was scanned, could be a token, barcode, gift-card - EnrichedBasketEntity - `type` 'ENRICHED', required - `summary` object, required - `totalItems` integer, required — Basket Items count - `totalBasketValue` integer, required — Total Basket monetary Value after discounts, denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`) - `totalQualifyingAmount` object, nullable - `points` integer, nullable — Basket Monetary Value for Loyalty Points calculations - `baseEarn` integer — Basket Monetary Value used for calculating base earn, overriding totalBasketValue. Adheres to basket discounts - `promotions` integer, nullable — Basket Monetary Value for Promotion Offer selections - `discount` integer, nullable — Basket Monetary Value for Discount calculations - `staff` integer, nullable — Basket Monetary Value for Staff Discount or Promotions - `totalTaxAmount` integer, nullable — Total Tax Amount denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`) - `totalDiscountAmount` object - `promotions` integer, nullable — Promotions Discount Amount. If basket adjustment adds to discounts, this amount will be added to - `staff` integer, nullable — Staff Discount Amount - `general` integer, nullable — General Discount Amount - `fulfilledBaseEarn` object[] — Records the base earn points rewarded to customer during mid fulfil requests. - `targetedAccountId` string, string — EES AIR Account ID. - `points` integer — Total value of base earn points rewarded. - `adjustmentRules` AdjustmentRulesEntity - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about - `externalAdjustmentReason` string — The reason for externalAdjustment - `ignore` boolean — Ignore object as if not sent - `tenderResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'createRedeem' — Operation Type - `value` integer — Operation Amount - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `targetedAccountId` string, string — EES AIR Account ID - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable - `multiItem` string[] - `totalTenderAmount` integer — The amount of tender value in the lowest unit of currency - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'createRedeem' — Operation Type - `value` integer — Operation Amount - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `targetedAccountId` string, string — EES AIR Account ID - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable - `multiItem` string[] - `totalDiscountAmount` integer — The monetary effect of the discount in the lowest unit of currency - `totalMatchingUnits` integer — The number of products the adjustment was applied to - `instanceId` string, string — A mechanism to distinguish each individual reward that has been given for any account - `bounceBackResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Campaign Id - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' - `value` integer — Value of transaction - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccounts` string[] - `targetAccountId` string, string — EES AIR Account ID - `qualifiesResults` object[] — If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it - `totalMatchingUnits` integer — The number of products forming part of the offer's qualification - `totalMatchingSpend` integer — The monetary value this product contributes towards the offer's qualification - `instanceId` string, string — The reference back to the offer reward which these qualifiers relate - `adjudicationResults` object[] - `resourceType` 'CAMPAIGN' | 'PROGRAMME' | 'SCHEME' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' — Operation Type - `value` integer — Operation Amount (please note: value and balances attributes are mutually exclusive) - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccounts` string[] - `targetedAccountId` string, string — EES AIR Account ID - `totalMatchingUnits` integer, nullable — The minimum number of products required to trigger offer - `results` EnrichedBasketSummaryResultsEntity - `points` object - `spend` integer — Total value of points spent during transaction - `debit` integer — Total value of points debited during transaction - `refund` integer — Total value of points clawed-back during refund transaction - `totalPointsTaken` integer — Sum of all negative balance actions (spend + debit + refund) - `earn` integer — Total value of points earned during transaction - `credit` integer — Total value of points credited during transaction - `totalPointsGiven` integer — Sum of all positive balance actions (earn + credit) - `totalMonetaryValue` integer — Monetary value of points using Scheme rules - `redemptionChannel` string, string — The redemption channel used for this request - `redemptionChannel` string, string — The redemption channel used for this request - `contents` object[], nullable - `sku` string, string — Item SKU - `upc` string, string — Item SKU - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag - `description` string, string — Product Name - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' | 'EACH' — The metric in which the item is measure (nullable) - `itemUnitCount` number — Item Quantity - `itemFulfilmentCount` number, nullable — Number Of Items Fulfilled - `itemUnitDiscount` integer — Discount per Item - `totalUnitCost` integer — Total cost for this item - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts) - `taxRate` number, float — The rate of tax being applied to this item (percentage) - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit - `qualifies` object, nullable - `discount` boolean, required — Determines if the item is eligible for discounting - `points` boolean, required — Determines if the item is eligible for points - `meta` MetaEntity - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `adjustmentRules` AdjustmentRulesEntity - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about - `externalAdjustmentReason` string — The reason for externalAdjustment - `ignore` boolean — Ignore object as if not sent - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'createRedeem' — Operation Type - `value` integer — Operation Amount - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `targetedAccountId` string, string — EES AIR Account ID - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable - `multiItem` string[] - `totalDiscountAmount` integer — The monetary effect of the discount in the lowest unit of currency - `totalMatchingUnits` integer — The number of products the adjustment was applied to - `instanceId` string, string — A mechanism to distinguish each individual reward that has been given for any account - `tenderResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'createRedeem' — Operation Type - `value` integer — Operation Amount - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `targetedAccountId` string, string — EES AIR Account ID - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable - `multiItem` string[] - `totalTenderAmount` integer — The amount of tender value in the lowest unit of currency - `bounceBackResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Campaign Id - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' - `value` integer — Value of transaction - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccounts` string[] - `targetAccountId` string, string — EES AIR Account ID - `qualifiesResults` object[] — If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it - `totalMatchingUnits` integer — The number of products forming part of the offer's qualification - `totalMatchingSpend` integer — The monetary value this product contributes towards the offer's qualification - `instanceId` string, string — The reference back to the offer reward which these qualifiers relate - `contributionResults` object[], nullable — If an offer was spend £30 get £5 off, this entity would be against each of the products contributing to the £5 off, with their combined `value`s adding up to the £5. - `value` integer — The proportional contribution to the discount/points given - `instanceId` string, string — The reference back to the offer which these items contributed - `adjudicationResults` object[] - `resourceType` 'CAMPAIGN' | 'PROGRAMME' | 'SCHEME' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' — Operation Type - `value` integer — Operation Amount (please note: value and balances attributes are mutually exclusive) - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccounts` string[] - `targetAccountId` string, string — EES AIR Account ID - `totalMatchingUnits` integer, nullable — The minimum number of products required to trigger offer - `relatedContents` object[] — Recursive list of contents related to the parent item with the same schema as this object. - `sku` string, string — Item SKU - `upc` string, string — Item SKU - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag - `description` string, string — Product Name - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' — The metric in which the item is measure (nullable) - `itemUnitCount` number — Item Quantity - `itemFulfilmentCount` number, nullable — Number Of Items Fulfilled - `itemUnitDiscount` integer — Discount per Item - `totalUnitCost` integer — Total cost for this item - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts) - `taxRate` number, float — The rate of tax being applied to this item (percentage) - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit - `qualifies` object, nullable - `discount` boolean, required — Determines if the item is eligible for discounting - `points` boolean, required — Determines if the item is eligible for points - `meta` MetaEntity - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `adjustmentRules` AdjustmentRulesEntity - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about - `externalAdjustmentReason` string — The reason for externalAdjustment - `ignore` boolean — Ignore object as if not sent - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'createRedeem' — Operation Type - `value` integer — Operation Amount - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `targetedAccountId` string, string — EES AIR Account ID - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable - `multiItem` string[] - `totalDiscountAmount` integer — The monetary effect of the discount in the lowest unit of currency - `totalMatchingUnits` integer — The number of products the adjustment was applied to - `instanceId` string, string — A mechanism to distinguish each individual reward that has been given for any account - `tenderResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'createRedeem' — Operation Type - `value` integer — Operation Amount - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `targetedAccountId` string, string — EES AIR Account ID - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable - `multiItem` string[] - `totalTenderAmount` integer — The amount of tender value in the lowest unit of currency - `bounceBackResults` object[] - `resourceType` 'CAMPAIGN' — EES Resource Type - `resourceId` string, string — EES AIR Campaign Id - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' - `value` integer — Value of transaction - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - … - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccounts` string[] - `targetAccountId` string, string — EES AIR Account ID - `qualifiesResults` object[] — If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it - `totalMatchingUnits` integer — The number of products forming part of the offer's qualification - `totalMatchingSpend` integer — The monetary value this product contributes towards the offer's qualification - `instanceId` string, string — The reference back to the offer reward which these qualifiers relate - `adjudicationResults` object[] - `resourceType` 'CAMPAIGN' | 'PROGRAMME' | 'SCHEME' — EES Resource Type - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis - `success` boolean, nullable - `type` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' — Operation Type - `value` integer — Operation Amount (please note: value and balances attributes are mutually exclusive) - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - … - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable - `relatedAccounts` string[] - `targetAccountId` string, string — EES AIR Account ID - `totalMatchingUnits` integer, nullable — The minimum number of products required to trigger offer - `relatedContents` unknown - `payment` object[], nullable — Similar to standardPaymentEntity, except that any _tender_ offers used during adjustment, have an entry injected here, stipulating the tender amount to take off basket - `tenderType` string, string, required — Tender type - predefined by Eagle Eye, including a further type of _tenderCoupon_ - `amount` integer, required — Monetary amount of payment/tender in lowest unit of currency - `bin` string, string — The bin for the tender - `identifier` string, string — An identifying value of what was scanned, could be a token, barcode, gift-card - `accountId` string, string — The EE AIR Account ID (only populated when tender is owned by EE) - `analysedDateTime` string, ees-date-time — Basket Analysis Date-Time in ATOM format ## Response `200` EES AIR has successfully processed a Request - MessagesResponse - `reference` string, string, required — Unique Merchant's reference (unique for each operation request) - `print` object - `items` object[] - `type` string, string, required — The type of Message. - `position` integer, required — The position indicating where this Message should be placed. - `messageId` string, string — The Message Id (reference). - `accountId` string, string — The Account Id (reference). - `accounts` object[] - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `ENTITLEMENT_OF` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - `validFrom` string, date-time — The date the token lock is valid from. - `validTo` string, date-time — The date the token lock is valid to. - `enriched` union - CampaignAccountEnrichment - `enrichmentType` 'COUPON', required - `campaignName` string, string, required — Campaign Name - `campaignReference` string, string, required — Campaign Reference - `qualifier` object[], nullable, required - `token` string, string, nullable — Token - `reward` object, nullable, required - `offerId` string, string, nullable, required — Offer ID - `offerName` string, string, nullable, required — Offer Name - `posReference` string, string, nullable, required — Offer reference (Promo Id) - `custom` object, nullable — Configured custom form fields in key-value pair format, grouped by form - `restrictions` object - `limits` object - `period` object[] - … - `creditsPerPeriod` object[] - … - `rewardsPerPeriod` object[] - … - `redemptionWindows` object - `rolling` WindowEntity[], nullable - `startDay` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY', required — Window definition Start Day (Weekday name) - `startTime` string, time, required — Window definition Start Time (in 24h format) - `endDay` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY', required — Window definition End Day (Weekday name) - `endTime` string, time, required — Window definition End Time (in 24h format) - `exclusions` ExclusionWindowEntity[], nullable - `start` string, ees-date-time, required — Exclusion Window Start (ATOM format) - `end` string, string, required — Exclusion Window End (ATOM format) - ProgrammeAccountEnrichment - `enrichmentType` 'PROGRAMME', required - `programmeName` string, string, required — Programme Name - `programmeReference` string, string, required — Programme Reference - `token` string, string, nullable — Token - PointsAccountEnrichment - `enrichmentType` 'POINTS', required - `schemeName` string, string, required — Scheme Name - `schemeReference` string, string, required — Scheme Reference - `properties` object - `redemptionRates` object, nullable — Scheme Redemption Rates - `goodwill` object, nullable — Scheme Goodwill - `credit` object, nullable — Scheme Redemption Rates - `debit` object, nullable — Scheme Debit - `details` object, nullable — Scheme Details - `earnRates` object, nullable — Scheme Earn Rates - `baseEarn` object, nullable — Scheme Base Earn - `pointsExpiry` object, nullable - `validTo` string, date-time — Time at which the points expire. - `points` integer — Number of points. - StampAccountEnrichment - `enrichmentType` 'STAMP', required - `schemeName` string, string, required — Scheme Name - `schemeReference` string, string, required — Scheme Reference - `properties` object - ContinuityAccountEnrichment - `token` string, nullable — The account's token - `qualifier` object — The campaign's qualifications - `continuity` object - `totalTransactionCount` integer, nullable — The number of transactions required to qualify for this coupon. - `totalTransactionSpend` integer, nullable — The total spend amount required to qualify for this coupon. - `totalTransactionUnits` integer, nullable — Account override for totalTransactionUnits - Only valid if campaign uses totalTransactionUnits. - `reward` object, nullable - `offerId` string, string, nullable, required — Offer ID - `offerName` string, string, nullable, required — Offer Name - `posReference` string, string, nullable, required — Offer reference (Promo Id) - `custom` object, nullable — Configured custom form fields in key-value pair format, grouped by form - `restrictions` object - `limits` object - `period` object[] - … - `redemptionWindows` object - `rolling` WindowEntity[], nullable - `startDay` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY', required — Window definition Start Day (Weekday name) - `startTime` string, time, required — Window definition Start Time (in 24h format) - `endDay` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY', required — Window definition End Day (Weekday name) - `endTime` string, time, required — Window definition End Time (in 24h format) - `exclusions` ExclusionWindowEntity[], nullable - `start` string, ees-date-time, required — Exclusion Window Start (ATOM format) - `end` string, string, required — Exclusion Window End (ATOM format) - `enrichmentType` 'CONTINUITY', required - `campaignName` string, string, required — Campaign Name. - `campaignReference` string, string, required — Campaign Reference. - `messages` object[] ## Other responses - `400` — EES AIR refuse to process that particular Request as there is something wrong with the Request (e.g. Request Payload is unprocessable, Mandatory Request Parameter value is not provided, etc.) - `401` — EES AIR refuse to process that particular Request due to Authentication error(s). This could be caused by missing one or more of mandatory AUTH headers, invalid Hash calculation, invalid or inactive API Key used, etc. - `403` — EES AIR refuse to process that particular Request due to Authorisation error(s). Please note nothing is wrong with Authentication nor hash Calculation, it is simply due to lack of permission to perform that particular action (e.g. Issuance Partner attempts to Redeem a Token or Redemption Partner attempts to Issue a Token, etc.) - `404` — EES AIR refuse to process that particular Request as requested Resource could not be found or referenced Resource is not active. - `409` — EES AIR understands this request, but refuse to process it, due to present Conflict with the current state of the target resource or because performing this operation would lead to a Conflict within AIR. - `415` — EES AIR refuse to process that particular Request as requested `Mime-Type` is not supported (Currently only `application/json` is supported - `429` — EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded. - `500` — EES AIR is not able to process that particular Request due to Unexpected Server Error. - `503` — EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance) - `504` — EES AIR refuses to process that particular Request due to Networking Issues --- [API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)