--- title: "Settle" method: POST path: "/connect/wallet/settle" tags: ["Wallet"] --- # Settle `POST /connect/wallet/settle` ## Request - Base URL: `https://pos.uk.eagleeye.com/2.0` - URL: `https://pos.uk.eagleeye.com/2.0/connect/wallet/settle` - Auth: API key in header `X-EES-AUTH-CLIENT-ID` and API key in header `X-EES-AUTH-HASH` This API endpoint allows the calling application to record in AIR a Consumer Transaction, by recording all Account's operations (like Coupon Redemption, Stored Value Credit/Debit amount, Loyalty Points Earn/Spend or Stamp received). Please note each operation on an Account will create an Account Transaction while overarching Wallet Transaction would link a Consumer's Transaction to individual AIR Account Transactions. ## Headers - `Accept-Encoding` '''' | ''gzip'' | ''deflate'' | ''gzip,deflate'' | ''deflate,gzip'' - `Connection` 'keep-alive' | 'close' - `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 - `X-POSCONNECT-TRANSACTION-DATETIME` string, eesDateTime ## Request body - object: please note: at least one of the following Request attributes `operations` and `accountTransactions` has to be provided - `mode` 'ACTIVE' | 'PASSIVE' | 'RECALL': Mode of operation - `walletId` string, string, nullable: If passed, the EES Wallet ID to associate the wallet transaction to. Optional - `identity` object, nullable: Identifies a customer, whether scanned or typed. Optional for cases where a identity is unknown. Without an identity, no identity will be set on the wallet transaction - `identityValue` string, string: Identity Value - `operations` object[]: Please note: `balances` and `amount` are mutually exclusive Request Parameters. The account, to perform the operation on, must be identified by either a `token` or an `accountId` / `walletId` combination. - `walletId` string, string: EES AIR Wallet ID - `accountId` string, string: EES AIR Wallet Account ID - `resourceId` string, string: The ID of the resource in AIR to operate upon. For open offers, this is the AIR campaignId. This field is required if the "operationType" is "createRedeem". - `resourceType` 'CAMPAIGN': The AIR Resource Type against which the operation is taking an action. If the "operationType" field is "createRedeem" this field is required - `token` string, string: Token value belonging to an account - `operationType` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' | 'stamp' | 'createRedeem', required: Operation Type - `amount` integer: Amount to be credited / debited / earned / spend / stamped - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `meta` object, nullable: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `accountTransactions` object[]: This optional Request attribute allows the calling application to instruct EES AIR to include into delayed Wallet Transaction some Account Transaction performed in real time (e.g. to reduce fraud risk) - `accountTransactionId` string, string, required: Account Transaction ID - `walletTransactions` object[]: This optional Request attribute allows the calling application to instruct EES AIR to complete the stated operation against a previously created wallet transaction - `reference` string, string, required: The reference for the transaction to operate upon - `walletId` string, string, required: The walletId in which the wallet transaction resides. Provides an element of protection that the correct wallet transaction is being operated upon. - `operationType` 'SETTLE', nullable: The operation to perform against the wallet transaction - SETTLE: Mark this wallet transaction as settled - `link` boolean, required: Flag to determine if the wallet transaction should be linked as a child of the settle transaction - `overrides` object[], nullable: Overrides to be used instead of the previous spend wallet transaction's. - `accountId` string, string, required: The id of the account the points are being spent from. - `balances` object, required: The balances to override. - `current` integer, required: The current balance to override the spend transaction with. - `lifetime_spend` integer, required: The lifetime_spend balance to override the spend transaction with. - `lifetime_spend_value` integer, required: The lifetime_spend_value balance to override the spend transaction with. - `reference` string, string, required: Merchant Reference (please note this reference has to be unique) - `location` LocationEntity - `incomingIdentifier` string, string, required: Optional Outlet Incoming Identifier allowing to override location arisen from used API Key of where this transaction has happened - `parentIncomingIdentifier` string, string: Outlet's Parent unit Incoming Identifier allowing to uniquely identify an Outlet override arisen from used API Key location where this transaction has happened. Please note this optional JSON attribute should be used in case incoming identifiers are not unique within a Client's Hierarchy - `basket` EnrichedBasketEntity - `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 - `reporting` ReportingEntity, nullable - `byOutlet` object[], nullable: Reporting values of coupon redemptions and scheme base earn by outlet - `resultsType` 'ADJUDICATION' | 'ADJUSTMENT', string: Shows whether the results are from Adjudication or Adjustment - `redemptionPartnerIncomingIdentifier` string, string, nullable: Product's Redemption Partner's Incoming Identifier - `outletIncomingIdentifier` string, string, nullable: Incoming Identifier for Outlet - `resourceId` string, string: EES AIR Campaign or Scheme Id - `type` 'REDEEM' | 'EARN', string - `value` integer: Value of transaction - `accountTransactionId` string, string: Account Transaction Id - `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. - `expectedPoints` object[]: Indicates the intended base earn and credits for any Scheme (during fulfil flow), along with whether these points will go into the `pending` bucket. N.B. Even if all coupons are not redeemed and threshold is not met, points will still go `pending`. - `schemeId` string, string: Scheme ID which the points relate to. - `earn` integer: Total value of base earn points. - `credit` integer: Total value of points to be credited. - `isPending` boolean: Indicated whether the points will be put into `pending`. - `adjustmentRules` AdjustmentRulesBasketEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this basket by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this basket by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the transaction is not eligible for any additional basket level discounts. - `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) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `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 - `targetedWalletId` string, string, nullable: EES AIR Wallet 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. - `totalOverallMatchingSpend` integer: The monetary value this product contributes towards the offer's overall qualification across valid Redemption Partners. - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `isRefundable` boolean: Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean: Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `relatedWalletId` string, string, nullable: EES AIR Wallet ID. - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet ID. - `totalMatchingUnits` integer, nullable: The minimum number of products required to trigger offer - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `rewardType` 'standard' | 'boltOn', nullable: Indicates whether a `credit` type was a standard reward or is a bolt on. All other operations will have be `null`, when present. - `results` EnrichedBasketSummaryResultsEntity - `pointsByScheme` object[], nullable - `points` ResultsPointsEntity - `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. - `points` ResultsPointsEntity - `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. - `tiers` object - `points` integer: The total amount of tier membership points for this transaction. - `transactions` integer: The total number of tier transactions to be awarded for this transaction. - `spend` integer: The total amount of spend to credit for this transaction. - `tierMembershipResults` object[], nullable - `tierMembershipId` string: The ID of the tierMembership. - `type` 'credit' - `balances` object - `points` integer: The number of tier membership points awarded to this membership in this transaction. - `transactions` integer: The number of tier membership transactions completed. - `spend` integer: The total spend counting towards tier membership. - `success` boolean, nullable: If this has been successfully settled (always null in open response). - `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 - `redemptionPartnerIncomingIdentifier` string, string, nullable: Allows a product belonging to another redemption partner to be adjudicated alongside the calling. Must be provided if `outletIncomingIdentifier` is used. - `outletIncomingIdentifier` string, string: The outlet the product should be adjudicated against. Belongs directly to the product's `redemptionPartnerIncomingIdentifier`. (For Future Use) - `groupReference` string[]: The group reference passed in for the item, used to process the item as part of any groups with the given reference. - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' | 'EACH': The metric in which the item is measure (nullable) - `itemUnitCount` integer: Item Quantity - `itemFulfilmentCount` integer, 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: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `adjustmentRules` AdjustmentRulesItemEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the item is not eligible for any additional product level discounts however it is still included in the qualification of any basket level discounts. - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN': EES Resource Type - `resourceId` string, string: EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `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 - `targetedWalletId` string, string, nullable: EES AIR Wallet 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. - `totalOverallMatchingSpend` integer: The monetary value this product contributes towards the offer's overall qualification across valid Redemption Partners. - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `isRefundable` boolean: Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean: Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `relatedWalletId` string, string, nullable: EES AIR Wallet ID. - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet ID. - `totalMatchingUnits` integer, nullable: The minimum number of products required to trigger offer - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `rewardType` 'standard' | 'boltOn', nullable: Indicates whether a `credit` type was a standard reward or is a bolt on. All other operations will have be `null`, when present. - `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` integer: Item Quantity - `itemFulfilmentCount` integer, 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: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `adjustmentRules` AdjustmentRulesItemEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the item is not eligible for any additional product level discounts however it is still included in the qualification of any basket level discounts. - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN': EES Resource Type - `resourceId` string, string: EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `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 - `targetedWalletId` string, string, nullable: EES AIR Wallet 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. - `totalOverallMatchingSpend` integer: The monetary value this product contributes towards the offer's overall qualification across valid Redemption Partners. - `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 accounts of type CONTINUITY. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type POINTS and STAMP. If current is not provided on creation, this will be set to 0. - `usable` integer: The usable balance. Applicable only to accounts of type POINTS. If usable is not provided on creation, this will be set to 0. - `locked` integer: The locked balance. Applicable only to accounts of type POINTS. If locked is 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 lifetime is not provided on creation, this will be set to 0. - `totalUnits` integer: The total units purchased balance. Applicable only to accounts of type CONTINUITY. - `isRefundable` boolean: Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean: Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `relatedWalletId` string, string, nullable: EES AIR Wallet ID. - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet ID. - `totalMatchingUnits` integer, nullable: The minimum number of products required to trigger offer - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `rewardType` 'standard' | 'boltOn', nullable: Indicates whether a `credit` type was a standard reward or is a bolt on. All other operations will have be `null`, when present. - `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 - `type` 'ENRICHED', required - `options` object, nullable: details TBC - `walletTransactionOverride` WalletTransactionOverrideEntity: Contains key-value pairs that are used to override some default transaction values. If the value or the key is not configured for the unit or invalid then it will fallback to the default. - `type` string, string: Wallet transaction type - `meta` object, nullable: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `transactionDetails` object, nullable: Key-Value object that will appear in the transaction details of any account transaction created as part of this request.
Please note: In case the same key is defined in the property accountTransactionDetails on unit config, the Unit accountTransactionDetails will overwrite the value of the same key defined on this entry.
Key Name and Value length should be less then 255. ## Response `200` EES AIR has successfully processed a Request - TiersEnabledWalletAndAccountTransactionResponse - `walletTransactions` WalletTransactionNoBasketTypeEntity[], nullable, required: Wallet Transaction(s) created as a result of this settle transaction. - `walletTransactionId` string, required: Wallet Transaction ID - `parentWalletTransactionId` string, nullable, required: Parent Wallet Transaction ID - `walletId` string, nullable, required: Wallet ID - `reference` string, nullable, required: Calling party's reference to this transaction - `identityId` string, nullable, required: The Identity ID responsible for this transaction. - `identity` WalletIdentityEntity - `identityId` string, required: EES AIR Wallet Identity ID - `walletId` string, required: EES AIR Wallet ID - `type` string, required: Type of the Identity, list of possible enum values could be defined per Client as part of the Onboarding process. - `friendlyName` string, required: Wallet Identity friendly name - `value` string, required: Wallet Identity value - `safeValue` string, required: Identity Safe Value (e.g. "original value salted and hashed") - safeValue could be than used in external systems like analytics, referencing original identity, provide uniqueness within a retailer, but without exposing sensitive information like card number. - `secret` string, required: Wallet Identity secret - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `state` string, required: Wallet Identity state, list of possible values could be defined and set-up per Client during Onboarding process. - `status` 'ACTIVE' | 'DELETED' | 'SUSPENDED' | 'LOST' | 'STOLEN' | 'INACTIVE', required: Identity status - `dateCreated` string, date-time, required: Date this identity was created - `lastUpdated` string, date-time, required: Date this identity was last updated - `mobileWallet` string, required: A url that can be used to add this identity to a mobile wallet (like Apple Wallet and Google Pay) - `type` string, nullable, required: Transaction Type, defined per retailer - `status` 'ACTIVE' | 'SETTLED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' | 'PURGED' | 'FULFILLING' | 'FULFILLED', required: Transaction status - `meta` MetaEntity, required: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `state` string, nullable, required: Transaction state - `transactionDateTime` string, date-time, required: Transaction date-time in ATOM format. - `transactionDateTimeOffset` string, string: The offset of the date-time from UTC in format "+00:00". - `expiryDate` string, date-time, nullable, required: Transaction Expiry Timestamp (date-time in ATOM format), when transaction should expiry and automatically be settled. - `accounts` object[], required - `accountId` string, required: Account ID - `accountTransactionId` string, required: Account Transaction ID - `channel` string, required: Channel used for Transaction creation or update - `location` LocationResponseEntity, required - `storeId` string, string: The Incoming Identifier of the Outlet. - `storeParentId` string, string: The Incoming Identifier of the Outlet's Parent Unit. - `dateCreated` string, date-time, required: Date this Wallet Transaction was created - `lastUpdated` string, date-time, required: Date this Wallet Transaction was last updated - `basket` union, required - StandardBasketNoTypeEntity - `summary` StandardBasketSummaryEntity - `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` AdjustmentRulesBasketEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this basket by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this basket by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the transaction is not eligible for any additional basket level discounts. - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN': EES Resource Type - `resourceId` string, string: EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `redemptionChannel` string, string: The redemption channel used for this request - `contents` object[], nullable - `sku` string, string: Item SKU. Either `sku` or `upc` should be provided to identify the product. - `upc` string, string: Item UPC. Either `sku` or `upc` should be provided to identify the product. - `description` string, string: Product Name - `redemptionPartnerIncomingIdentifier` string, string, nullable: Allows a product belonging to another redemption partner to be adjudicated alongside the calling. Must be provided if `outletIncomingIdentifier` is used. - `outletIncomingIdentifier` string, string: The outlet the product should be adjudicated against. Belongs directly to the product's `redemptionPartnerIncomingIdentifier`. (For Future Use) - `groupReference` string[]: Allows passing in group reference for the item. This reference will be used to process the item as part of any groups with the given reference. - `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` integer: Item Quantity - `itemUnitDiscount` integer: Discount per Item - `totalUnitCost` integer: Total cost for this item - `totalUnitCostAfterDiscount` integer, required: Total cost for this item after discount (please note this does not take into account whole basket discounts). This attribute is mandatory for every basket content item. - `taxRate` number, float: Tax Rate (Percentage) - `taxAmount` integer: Tax Amount for that item, denominated to a smallest currency unit - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN': EES Resource Type - `resourceId` string, string: EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `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. - `offerPoints` boolean: Determines if the item is eligible for points reward Campaigns. If false this item will not qualify for rewards points however, it remains eligible to qualify for Base Earn Points, as well as both Basket and Product-Level Discounts. - `meta` MetaEntity: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `adjustmentRules` AdjustmentRulesItemEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the item is not eligible for any additional product level discounts however it is still included in the qualification of any basket level discounts. - `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` integer: 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 - … - `meta` MetaEntity: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `adjustmentRules` AdjustmentRulesItemEntity - … - `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 - EnrichedBasketNoTypeEntity - `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 - `reporting` ReportingEntity, nullable - `byOutlet` object[], nullable: Reporting values of coupon redemptions and scheme base earn by outlet - … - `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. - `expectedPoints` object[]: Indicates the intended base earn and credits for any Scheme (during fulfil flow), along with whether these points will go into the `pending` bucket. N.B. Even if all coupons are not redeemed and threshold is not met, points will still go `pending`. - `schemeId` string, string: Scheme ID which the points relate to. - `earn` integer: Total value of base earn points. - `credit` integer: Total value of points to be credited. - `isPending` boolean: Indicated whether the points will be put into `pending`. - `adjustmentRules` AdjustmentRulesBasketEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this basket by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this basket by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the transaction is not eligible for any additional basket level discounts. - `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) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `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[] - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet 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. - `totalOverallMatchingSpend` integer: The monetary value this product contributes towards the offer's overall qualification across valid Redemption Partners. - `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 - `relatedAccountIds` string[] - `relatedWalletId` string, string, nullable: EES AIR Wallet ID. - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet ID. - `totalMatchingUnits` integer, nullable: The minimum number of products required to trigger offer - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `rewardType` 'standard' | 'boltOn', nullable: Indicates whether a `credit` type was a standard reward or is a bolt on. All other operations will have be `null`, when present. - `results` EnrichedBasketSummaryResultsEntity - `pointsByScheme` object[], nullable - … - `points` ResultsPointsEntity - … - `tiers` object - … - `tierMembershipResults` object[], nullable - `tierMembershipId` string: The ID of the tierMembership. - `type` 'credit' - `balances` object - … - `success` boolean, nullable: If this has been successfully settled (always null in open response). - `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 - `redemptionPartnerIncomingIdentifier` string, string, nullable: Allows a product belonging to another redemption partner to be adjudicated alongside the calling. Must be provided if `outletIncomingIdentifier` is used. - `outletIncomingIdentifier` string, string: The outlet the product should be adjudicated against. Belongs directly to the product's `redemptionPartnerIncomingIdentifier`. (For Future Use) - `groupReference` string[]: The group reference passed in for the item, used to process the item as part of any groups with the given reference. - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' | 'EACH': The metric in which the item is measure (nullable) - `itemUnitCount` integer: Item Quantity - `itemFulfilmentCount` integer, 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: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `adjustmentRules` AdjustmentRulesItemEntity - `externalAdjustment` boolean: Whether a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `externalAdjustmentReason` string: An external reason why a discount has already been applied to this item by a POS before calling EE.
This is purely for information and no action is taken with the data. - `ignore` boolean: If set to true the item is not eligible for any additional product level discounts however it is still included in the qualification of any basket level discounts. - `adjustmentResults` object[] - `resourceType` 'CAMPAIGN': EES Resource Type - `resourceId` string, string: EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID) - `resourceReference` string, string: The EES AIR Resource Reference (Campaign Reference) relating to this adjustment result. Only included for external adjustment results. - `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 - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `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[] - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet 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. - `totalOverallMatchingSpend` integer: The monetary value this product contributes towards the offer's overall qualification across valid Redemption Partners. - `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. - … - `isRefundable` boolean: Boolean Flag indicating if this offer should be refundable - `isUnredeemable` boolean: Boolean Flag indicating if this offer should be Unredeemable - `relatedAccountIds` string[] - `relatedWalletId` string, string, nullable: EES AIR Wallet ID. - `targetedAccountId` string, string: EES AIR Account ID - `targetedWalletId` string, string, nullable: EES AIR Wallet ID. - `totalMatchingUnits` integer, nullable: The minimum number of products required to trigger offer - `totalRewardUnits` integer, nullable: The number of units the reward applies to within this item. - `rewardType` 'standard' | 'boltOn', nullable: Indicates whether a `credit` type was a standard reward or is a bolt on. All other operations will have be `null`, when present. - `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` integer: Item Quantity - `itemFulfilmentCount` integer, 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 - … - `meta` MetaEntity: Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters - `adjustmentRules` AdjustmentRulesItemEntity - … - `adjustmentResults` object[] - … - `tenderResults` object[] - … - `bounceBackResults` object[] - … - `qualifiesResults` object[]: If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it. - … - `adjudicationResults` object[] - … - `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 - `accountTransactions` AccountTransactionEntity[], nullable, required - `accountTransactionId` string, required: The account transaction ID. - `accountId` string, required: The account id related to this transaction. - `parentAccountTransactionId` string, nullable, required: The parent account transaction. - `event` 'CREATE' | 'REDEEM' | 'LOCK' | 'UNLOCK' | 'UNREDEEM' | 'VERIFY' | 'ACTIVATE' | 'INACTIVATE' | 'REACTIVATE' | 'LOAD' | 'CREDIT' | 'DEBIT' | 'BALANCE' | 'INVALIDATE' | 'BLOCK' | 'UNBLOCK' | 'RESEND' | 'STOLEN' | 'CANCEL' | 'VOID' | 'REISSUE' | 'REFUND' | 'TRANSFER' | 'TRANSFER_IN' | 'TOPUP' | 'AUTOTOPUP' | 'STAMP' | 'SPEND', required: The type of transaction. - `value` integer, required: The value related to this Account Transaction. Typically, if an account transaction like credit was executed with a value, then this value will be stored here. For Continuity, however, this value should always be 0, and the same for Coupon (since there is no value for a coupon). - `source` string, required: The source of this transaction e.g. from a client (1), or triggered automatically (2) from within EES AIR (e.g. auto-top-up or the incrementation of Quest balances). - `transactionDetails` object, nullable, required: An simple object of key value pairs representing the transaction details. - `balancesBefore` AccountTransactionBalancesHistoryEntity, required: The object of balances to show for either before or after the account transaction. 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 STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer: The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer: The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer: The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type Continuity. - `balancesAfter` AccountTransactionBalancesHistoryEntity, required: The object of balances to show for either before or after the account transaction. 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 STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer: The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer: The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer: The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer: The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer: The transaction counter. Applicable only to accounts of type Continuity. - `properties` object, nullable, required: Properties related to the account transaction. - `dateCreated` string, date-time, required: Date-time (ATOM format) this account transaction was created - `lastUpdated` string, date-time, required: Date-time (ATOM format) this account transaction was last updated - `tierMembershipTransactions` TierMembershipTransactionEntity[], nullable: Tier Membership Transaction(s) created as a result of this transaction. - `tierMembershipTransactionId` string, required: The ID of the tier membership Transaction. - `tierMembershipId` string, required: The ID of the tier membership related to this transaction. - `transactionType` 'CREDIT' | 'DEBIT' | 'ADJUSTMENT' | 'MOVE' | 'RESET', required: The type of this tier membership transaction. - `parentTierMembershipTransactionId` string, nullable, required: The ID of any TierMembershipTransaction this is the child of. - `walletTransactionId` string, required: The ID of the walletTransaction that contains this transaction. - `dateCreated` string, date-time, required: Time the transaction was created. - `lastUpdated` string, date-time, required: Time the transaction was updated. - `actions` object[], required - `balanceType` 'POINTS' | 'TRANSACTIONS' | 'SPEND': The type of balance to be changed. - `amount` integer: The amount to change the balance by. - `balanceBefore` integer: The balance before this transaction takes place. - `balanceAfter` integer: The balance after this transaction takes place. ## Other responses - `207`: EES AIR has processed a partially successful Request - `400`: EES AIR Refuse to process that particular Request as there is something wrong with the Request (e.g. missing Mandatory Request parameter or Mandatory Request Payload attribute is missing, Request payload is unprocessable, etc) - `401`: EES AIR Refuse to process that particular Request due to Authentication error. This could be caused by missing mandatory AUTH header(s), invalid Hash calculation, invalid or inactive API Key used, etc. - `403`: EES AIR Refuse to process that particular Request due to Request Authorization error(s). This indicates that used API Key has not got required permissions to perform this operation. - `404`: EES AIR Refuse to process that particular Request as requested/referenced resource could not be found. - `409`: EES AIR understands this request, but refuses 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 is not able to understand that request due to not supported `Content-Type` value. - `429`: EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded. - `500`: EES AIR refuses 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.dev/eagleeye/apis/pos-connect-api.md) - [All operations](https://skmtc.dev/eagleeye/apis/pos-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeye/apis/pos-connect-api/revisions/8b1db944024c?raw)