Table of Content

RewardItem Class

BrandName Property

CreateDateTime Property

ImageURL Property

PointRedemptionCatalogId Property

PointValue Property

ProductDescription Property

ProductId Property

ProductName Property

RetailerGUID Property

SortOrder Property

Status Property

InStorecard.Common.Entity Namespace

EventInstance Class

EventDate Property

EventReferenceTag Property

MasterValue Property

Object Property

RetailerEventId Property

Subject Property

Shopper Constructor

Address1 Property

Address2 Property

BulkEmail Property

BulkEmailSource Property

BulkEmailSourceDescription Property

CreateDateTime Property

EmailAddress Property

EmailFormat Property

EmailFrequency Property

EmailFrequencyUnit Property

Equals Method (obj)

FileImportId Property

FirstName Property

GetHashCode Method

LastName Property

LoyaltyLabCreateDateTime Property

LoyaltyMember Property

MailOptIn Property

MiddleInitial Property

MobilePhoneEmail Property

Origin Property

Password Property

PasswordLastChanged Property

PersonStatus Property

PhoneNumber Property

PhoneOptIn Property

ProfileCreateDateTime Property

ProfileUpdateDateTime Property

RetailerGUID Property

RetailerRegistered Property

RetailerShopperCreationDate Property

RetailerShopperId Property

ShopperId Property

SourceReference Property

Status Property

StatusUpdateDateTime Property

ToString Method

UserName Property

InStorecard.Database.BusinessProcess Namespace

RealtimeImportAwardProcessor Class

RealtimeImportAwardProcessor Constructor (data, transaction)

ImportData Method

LoyaltyAPI Namespace

ColumbiaAPI Class

ColumbiaAPI Constructor

CreateShopper Method (shopper, customAttributes, customEntities)

GetTransactionAwardDetailByShopper Method (shopperIdentifier, fromDate, toDate)

GetTransactionAwardDetailByTransactionId Method (shopperIdentifier, transactionId)

GetTransactionWithTendersByTransacionId Method (transactionId)

RewardCertificateValidateUpdate Method (RetailerShopperId, CertificateCode, TransactionValue, UpdateFlag)

ShopperSearch Method (loyaltyMemberOnly, retailerShopperId, emailAddress, phoneNumber, firstName, lastName, customAttributes)

CrateAndBarrelAPI Class

CrateAndBarrelAPI Constructor

CreateRewardRedemption Method (shopperId, sku, pointsRedeemed, comments)

GetShopperBalanceByBalanceType Method (emailAddress, balanceType)

DunkinAPI Class

AuthenticateUser Method (username, password)

ImportTransactionRealtime Method (transaction, ReturnShopperDetails, ReturnPriorRewardCodes, POSPrintStatusEnabled)

UpdateRewardCodeRedemption Method (codeText, IsRedeemed)

ValidateRewardCode Method (textCode)

AdjustShopperPointsCustomAttributes Method (shopperId, pointChange, pointType, description, customAttributeHead)

AdjustShopperPointsWithExpirationDateCustomAttributes Method (shopperId, pointChange, pointType, description, expirationDate, customAttributeHead)

AuthenticateUser Method (username, password)

CreateAndScoreShopper Method (shopper)

CreateRewardRedemptionTransactions Method (purchaseOrderLineItemRedemptionArray)

DonatePoints Method (donatingShopperId, receivingShopperId, numPoints, awardText, daysToExpire, customAttributes)

GetCustomAttribute Method (referenceType, referenceID, referenceTag)

GetCustomAttributes Method (referenceId, referenceType)

GetRewardProductPricePointAdjustments Method (retailerShopperId, sku)

GetShopperByRetailerID Method (retailerShopperID)

GetShopperOffers Method (shopperId)

GetShopperPromotions Method (retailerShopperId)

GetShopperRedemptionsByDate Method (shopperId, fromDate, toDate)

ImportTransactions Method (transactions)

UpdateCustomAttribute Method (referenceType, referenceID, referenceTag, CAValue)

UpdateCustomAttributes Method (customAttributeParameters)

UpdateCustomEntity Method (referenceTag, referenceType, referenceId, entities)

AuthenticateUser Method (username, password)

CreateAndScoreShopper Method (shopper)

GetShopperByAlias Method (aliasParams)

GetShopperForKohlsIVR Method (input)

ImportTransaction Method (transactions)

LoyaltyAPI Class

AddRewardProductToCatalog Method (rewardProductId, rewardCatalogId)

AddShopperToProgram Method (shopperId, programId)

AddShopperToTier Method (shopperId, programId)

AddTransaction Method (shopperid, orderItem)

AdjustShopperPoints Method (shopperId, pointChange, pointType, description)

AdjustShopperPointsCustomAttributes Method (shopperId, pointChange, pointType, description, customAttributeHead)

AdjustShopperPointsWithExpirationDate Method (shopperId, pointChange, pointType, description, expirationDate)

AdjustShopperPointsWithExpirationDateCustomAttributes Method (shopperId, pointChange, pointType, description, expirationDate, customAttributeHead)

AdjustShopperPointsWithRedemptionCustomAttributeCheck Method (shopperId, pointChange, pointType, description, customAttributeHead, redemptionCustomAttributeReferenceTag, redemptionCustomattributeValue, caMustExist)

AssociatePurchase Method (loyaltyLabPurchaseId, externalPurchaseId)

ChangePointStateByExternalId Method (externalPurchaseId, newState)

ChangePointStateByLoyaltyLabId Method (loyaltyLabPurchaseId, newState)

CreateAndScoreShopper Method (shopper)

CreateEventInstance Method (eventinstance)

CreateRegisteredCard Method (card)

CreateRewardProduct Method (rewardProduct)

CreateRewardRedemption Method (shopperId, sku, pointsRedeemed, comments)

CreateRewardRedemptionByPointGroup Method (shopperId, sku, pointsRedeemed, comments, pointGroupRefTag)

CreateRewardRedemptionByPointGroupAndCustomAttributes Method (shopperId, sku, pointsRedeemed, comments, pointGroupRefTag, customAttributeParameters)

CreateShopper Method (shopper)

CreateShopperWithCard Method (shopper, card)

CreateUnregisteredShopper Method (shopper)

EnrollShopper Method (shopper)

GetCodesForShopper Method (shopperId)

GetCodesWithSkuForShopper Method (shopperId)

GetCSRAuthenticationToken Method (email)

GetCurrentPointPrice Method (sku, basePrice, effectiveDate, retailerShopperId)

GetCurrentPointPrices Method (productsToPrice)

GetCustomAttribute Method (referenceType, referenceID, referenceTag)

GetCustomEntitiesByReferenceTag Method (referenceTag, referenceType, referenceId)

GetCustomQuestionsForShopper Method (channel, shopperId)

GetEventDefinitions Method

GetPlcAvailablePointsByDate Method (shopperId, fromDate, toDate)

GetPlcAvailablePointsByDateByPointGroup Method (shopperId, fromDate, toDate, pointGroupRefTag)

GetPointPrices Method (RetailerShopperId, ProductsToPrice)

GetProductBySKU Method (sku)

GetProfilesByShopperId Method (shopperId)

GetPurchaseAwardForReturns Method (loyaltyId, returnTransactions)

GetReferedFriends Method (shopperId)

GetReferenceObjectFromUniqueCustomEntity Method (referenceTag, referenceType, entity)

GetReferenceObjectsFromSearchableCustomEntity Method (referenceTag, referenceType, entity)

GetRegisteredCard Method (registeredCardId)

GetRewardCatalogById Method (rewardCatalogId)

GetRewardCatalogByRetailerCatalogId Method (retailerRewardCatalogId)

GetRewardCatalogsByRewardProductId Method (rewardProductId)

GetRewardProductById Method (rewardProductId)

GetRewardProductByUniqueSKU Method (sku)

GetRewards Method

GetShopper Method (shopperId)

GetShopperAuthenticationToken Method (shopperEmail)

GetShopperAuthenticationTokenByRetailerID Method (retailerShopperID)

GetShopperByEmail Method (email)

GetShopperByID Method (shopperId)

GetShopperByMergedVictimID Method (shopperID)

GetShopperByRegisteredCard Method (loyaltyCardNum, lastName)

GetShopperByRetailerID Method (retailerShopperID)

GetShopperByUserName Method (userName)

GetShopperOffers Method (shopperId)

GetShopperOffersExtended Method (shopperId)

GetShopperPointBalance Method (shopperId)

GetShopperPointBalanceByBalanceType Method (shopperId, balanceType)

GetShopperPointBalanceByDate Method (shopperId, fromDate, toDate)

GetShopperPointBalanceByPointGroup Method (shopperId, pointGroupRefTag)

GetShopperPointBalanceByPointState Method (retailerShopperId, state)

GetShopperPointBalanceByRetailerID Method (retailerShopperId)

GetShopperPointsExpiring Method (shopperId, fromDate, toDate, pointType)

GetShopperPrograms Method (shopperid)

GetShopperRedemptionsByDate Method (shopperId, fromDate, toDate)

GetShopperRedemptionsByLoyaltyProgramId Method (retailerShopperId, fromDate, toDate)

GetShopperRedemptionsByShopperId Method (shopperId, fromDate, toDate)

GetShopperRedemptionsOrderItemsByDate Method (shopperId, fromDate, toDate)

GetShopperRegisteredCards Method (shopperId)

GetShoppersByPhoneNumber Method (phoneNumber)

GetShoppersByPhoneNumberFragment Method (fragment, containsSearch)

GetShoppersByRegisteredCard Method (loyaltyCardNum, lastName)

GetShopperTransactionsWithCompleteProductInfo Method (shopperid)

GetStores Method (pageIndex, pageSize)

GetTierPrograms Method

GetTotalPointsEarnedByEmailAddress Method (emailAddress, fromDate, toDate)

GetTotalPointsEarnedByLoyaltyCardNumber Method (loyaltyCardNumber, fromDate, toDate)

GetTotalPointsEarnedByRetailerShopperId Method (retailerShopperId, fromDate, toDate)

GetTotalPointsEarnedByShopperId Method (shopperId, fromDate, toDate)

GetTransactions Method (shopperid)

GetTransactionsByDate Method (shopperid, startDate, endDate)

GetTransactionsWithTenders Method (shopperid)

ImportTransaction Method (transaction)

ImportTransactions Method (transactions)

MergeAccounts Method (fromShopperId, toShopperId, description, note)

MergeShoppers Method (fromShopperId, toShopperId, description, note)

PointsPurchase Method (sku, basePrice, effectiveDate, retailerShopperId, newPointState)

PointsPurchaseWithPointGroup Method (sku, basePrice, effectiveDate, retailerShopperId, newPointState, pointGroupRefTag)

ProcessInImportTransaction Method (retailerGuid, transaction, shopper)

RedeemOffer Method (offerId, shopperId)

RedeemReward Method (pointRedemptionCatalogId, shopperId)

RedeemShopperRewardCerificate Method (shopperIdentifier, rewardNumber)

ReferFriend Method (referred_email, referring_email)

RemoveRewardProductFromCatalog Method (rewardProductId, rewardCatalogId)

ReversePurchaseAwardForReturns Method (loyaltyId, returnTransactions, amount)

ScoreShopper Method (shopperId)

SendCommunicationToEmailAddress Method (emailAddress, communicationID, forceEmailSend)

SendCommunicationToEmailAddresses Method (emailAddresses, communicationID, forceEmailSend)

SendCommunicationToShopper Method (retailerShopperID, communicationID, forceEmailSend)

SendCommunicationToShoppers Method (retailerShopperIDs, communicationID, forceEmailSend)

SendShopperPassword Method (email)

ShopperCreation Method (retailerGuid, bCheckShopperIdentifierExists, bCreateShopperIfNotExists, sIdentifierValue, bValidShopperIdentifierValue, shopper)

ShopperSignIn Method (emailAddress, password)

UnEnrollShopper Method (shopperId)

UpdateCustomAttribute Method (referenceType, referenceID, referenceTag, CAValue)

UpdateCustomAttributes Method (customAttributeParameters)

UpdateCustomEntity Method (referenceTag, referenceType, referenceId, entities)

UpdateCustomQuestionForShopper Method (shopperId, answerSet, channel)

UpdateRewardProduct Method (rewardProduct)

UpdateShopper Method (shopper)

UpdateShopperOfferStatus Method (shopperId, status)

UpdateShopperPointsBalanceWithCustomAttributes Method (shopperId, points, description, customAttributeHeads, pointTypeId, expirationDateTime)

ValidShopperIdentifier Method (shopperIdentifier)

AuthenticateUser Method (username, password)

CreateAndScoreShopper Method (shopper)

CreateRewardRedemption Method (shopperId, sku, pointsRedeemed, comments, transactionDate, retailerStoreId)

GetCustomAttribute Method (referenceType, referenceID, referenceTag)

GetPointsToExpire Method (shopperId)

GetPurchaseAmountToNextTier Method (shopperIdentifier)

GetShopperByRetailerID Method (retailerShopperID)

GetShopperOrderHeadersRedemptionsByDate Method (shopperIdentifier, fromDate, toDate, retailerStoreId)

GetShopperPointBalanceByRetailerID Method (retailerShopperId)

GetShopperPrograms Method (shopperid)

GetShopperRedemptionsOrderItemsByDate Method (shopperId, fromDate, toDate)

UpdateCustomAttributes Method (customAttributeParameters)

UpdateShopper Method (shopper)

PGskiiAPI Class

PGskiiAPI Constructor

AdjustShopperPoints Method (shopperId, pointChange, pointTypeName, description, LastOrderItemDateTime)

AuthenticateUser Method (username, password)

CreateAndScoreShopper Method (shopper, attributes)

CreateRewardRedemption Method (shopperId, sku, quantity, pointsRedeemed, comments, transactionDate, retailerStoreId)

GetPointsToExpire Method (shopperId)

GetShopperRedemptionsOrderItemsByDate Method (shopperId, fromDate, toDate)

GetTierExpirationDate Method (shopperIdentifier)

UpdateShopper Method (shopper)

TheNorthFaceAPI Class

AuthenticateUser Method (username, password)

ConstructShopper Method (shopper, crmMemberId, customAttributes)

ConstructShopperExtended Method (shopper, crmMemberId, birthDay, enrollmentType, enrollmentDate)

GetShopperTransAwardInfoByDate Method (shopperIdentifier, fromDate, toDate)

GetTNFShopperByVarious Method (retailerShopperId, crmMemberId, ecomAccountId, emailAddress, phoneNumber, firstName, lastName, zipCode)

GetTransactions Method (shopperid)

GetTransactionsByDate Method (shopperid, startDate, endDate)

UpdateCustomAttributes Method (customAttributeParameters)

ThriventAPI Class

ThriventAPI Constructor

RedeemPointsByPointGroupAPIExtended Method (shopperId, sku, pointsRedeemed, comments, pointGroupRefTag, customAttributeParams)

USCCAPI Constructor

CreateRewardRedemption Method (shopperId, sku, pointsRedeemed, comments, campaignId, callEmailAPI, callSmsAPI, callCaresAPI, smsCampaignId, monthsAccelerated, isCtnRequired, category, selectedCTN, productName, orderId)

GetRewardsHistory Method (shopperId, fromDate, toDate)

LoyaltyAPILibrary Namespace

AuthenticationResult Class

AuthenticationResult Constructor

Authenticated Property

DecryptedToken Property

ICSUserID Property

RetailerGuid Property

BaseAuthenticatedService Class

BaseAuthenticatedService Constructor

AuthenticationResult Property

SessionMinuteTimeout Property

SoapAuthenticationException Class

SoapAuthenticationException Constructor (caller)

SoapCustomAPIException Class

SoapCustomAPIException Constructor

SoapCustomAPIException Constructor (caller, errorCode)

SoapCustomAPIException Constructor (caller, errorCode, message)

SoapCustomAPIException Constructor (caller, message)

SoapInputAuthorizationException Class

SoapInputAuthorizationException Constructor (caller)

SoapInternalAPIException Class

SoapInternalAPIException Constructor

SoapInternalAPIException Constructor (caller)

SoapInternalAPIException Constructor (caller, isDbError)

SoapOutputAuthorizationException Class

SoapOutputAuthorizationException Constructor (caller)