Methodsbid On Item bid On Item ( userId , rewardId , distributionPolicyId , partnerId , bid , useAutomaticBidding , deliveryName , deliveryAddress ) : Promise < undefined > Parameters userId : string rewardId : string distributionPolicyId : string partnerId : string bid : number useAutomaticBidding : boolean deliveryName : string deliveryAddress : { city : string ; country : string ; street : string ; zip_code : string ; } city : string country : string street : string zip_ code : string Returns Promise < undefined > get Auction Status get Auction Status ( rewardId , distributionPolicyId , partnerId , userId ? ) : Promise < { bids : { bidderId : string ; byCurrentUser : undefined | boolean ; date : string ; fanPoints : number ; } [] ; currentHighestBid : number ; currentUserBid : undefined | number ; doesUserUseAutomaticBidding : boolean ; isAuctionOpen : boolean ; isUserHighestBidder : boolean ; maxAutomaticBid : undefined | number ; nextHigherBid : number ; } > Parameters rewardId : string distributionPolicyId : string partnerId : string Optional
userId : string Returns Promise < { bids : { bidderId : string ; byCurrentUser : undefined | boolean ; date : string ; fanPoints : number ; } [] ; currentHighestBid : number ; currentUserBid : undefined | number ; doesUserUseAutomaticBidding : boolean ; isAuctionOpen : boolean ; isUserHighestBidder : boolean ; maxAutomaticBid : undefined | number ; nextHigherBid : number ; } > get Lottery Status get Lottery Status ( rewardId , distributionPolicyId , partnerId , userId ? ) : Promise < { isLotteryOpen : boolean ; ticketsBoughtByUser : undefined | number ; totalTicketsSold : number ; } > Parameters rewardId : string distributionPolicyId : string partnerId : string Optional
userId : string Returns Promise < { isLotteryOpen : boolean ; ticketsBoughtByUser : undefined | number ; totalTicketsSold : number ; } > get Marketplace Item get Marketplace Item ( rewardId , distributionPolicyId , partnerId ) : Promise < { distributionPolicy : { auctionEndDate : string ; auctionStartDate : string ; auctionStatus : AuctionResultStatus ; currency : Currency ; currentHighestBid : undefined | number ; currentNumberOfBids : undefined | number ; distributionPolicyId : string ; distributionType : "ShopAuctionDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; minBid : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopLotteryDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; lotteryEndDate : string ; lotteryStartDate : string ; lotteryStatus : LotteryDrawStatus ; numTicketsToDraw : number ; ticketPrice : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopPurchaseDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; price : number ; } ; numAvailable : any ; partnerId : string ; product : { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } ; readableObjectId : undefined | string ; rewardId : string ; } > Parameters rewardId : string distributionPolicyId : string partnerId : string Returns Promise < { distributionPolicy : { auctionEndDate : string ; auctionStartDate : string ; auctionStatus : AuctionResultStatus ; currency : Currency ; currentHighestBid : undefined | number ; currentNumberOfBids : undefined | number ; distributionPolicyId : string ; distributionType : "ShopAuctionDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; minBid : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopLotteryDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; lotteryEndDate : string ; lotteryStartDate : string ; lotteryStatus : LotteryDrawStatus ; numTicketsToDraw : number ; ticketPrice : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopPurchaseDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; price : number ; } ; numAvailable : any ; partnerId : string ; product : { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } ; readableObjectId : undefined | string ; rewardId : string ; } > get Marketplace Items get Marketplace Items ( productCategory ? , limit ? , lastReturnedRewardId ? ) : Promise < { distributionPolicy : { auctionEndDate : string ; auctionStartDate : string ; auctionStatus : AuctionResultStatus ; currency : Currency ; currentHighestBid : undefined | number ; currentNumberOfBids : undefined | number ; distributionPolicyId : string ; distributionType : "ShopAuctionDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; minBid : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopLotteryDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; lotteryEndDate : string ; lotteryStartDate : string ; lotteryStatus : LotteryDrawStatus ; numTicketsToDraw : number ; ticketPrice : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopPurchaseDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; price : number ; } ; numAvailable : any ; partnerId : string ; product : { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } ; readableObjectId : undefined | string ; rewardId : string ; } [] > Parameters Optional
productCategory : ProductCategory Optional
limit : number Optional
lastReturnedRewardId : string Returns Promise < { distributionPolicy : { auctionEndDate : string ; auctionStartDate : string ; auctionStatus : AuctionResultStatus ; currency : Currency ; currentHighestBid : undefined | number ; currentNumberOfBids : undefined | number ; distributionPolicyId : string ; distributionType : "ShopAuctionDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; minBid : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopLotteryDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; lotteryEndDate : string ; lotteryStartDate : string ; lotteryStatus : LotteryDrawStatus ; numTicketsToDraw : number ; ticketPrice : number ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopPurchaseDistributionPolicy" ; featured : boolean ; isRecentlyAvailable : boolean ; price : number ; } ; numAvailable : any ; partnerId : string ; product : { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } ; readableObjectId : undefined | string ; rewardId : string ; } [] > get Obtained Products get Obtained Products ( userId , limit ? , earlierThan ? ) : Promise < { deliveryDetails : { deliveryAddress : undefined | { city : string ; country : string ; street : string ; zipCode : string ; } ; deliveryName : undefined | string ; } ; hasBeenUndone : boolean ; product : { amount : number ; deliveryDate : undefined | string ; deliveryStatus : DeliveryStatus ; description : string ; imageUrls : string [] ; lotteryProductDistributionPolicyId : string ; lotteryProductRewardId : string ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardId : string ; rewardType : "LotteryTicket" ; title : string ; } | { amount : number ; deliveryDate : undefined | string ; deliveryStatus : DeliveryStatus ; description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardId : string ; rewardType : "Product" ; title : string ; } ; purchaseDate : string ; transactionGroupId : string ; transactionNr : number ; } [] > Parameters userId : string Optional
limit : number Optional
earlierThan : string Returns Promise < { deliveryDetails : { deliveryAddress : undefined | { city : string ; country : string ; street : string ; zipCode : string ; } ; deliveryName : undefined | string ; } ; hasBeenUndone : boolean ; product : { amount : number ; deliveryDate : undefined | string ; deliveryStatus : DeliveryStatus ; description : string ; imageUrls : string [] ; lotteryProductDistributionPolicyId : string ; lotteryProductRewardId : string ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardId : string ; rewardType : "LotteryTicket" ; title : string ; } | { amount : number ; deliveryDate : undefined | string ; deliveryStatus : DeliveryStatus ; description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardId : string ; rewardType : "Product" ; title : string ; } ; purchaseDate : string ; transactionGroupId : string ; transactionNr : number ; } [] > get User Participations get User Participations ( userId ) : Promise < { auctions : { distributionPolicy : | { distributionType : "BasicDistributionPolicy" ; } | { distributionType : "PromotionDistributionPolicy" ; } | { auctionEndDate : string ; auctionStartDate : string ; auctionStatus : AuctionResultStatus ; currency : Currency ; currentHighestBid : undefined | number ; currentNumberOfBids : undefined | number ; distributionPolicyId : string ; distributionType : "ShopAuctionDistributionPolicy" ; isRecentlyAvailable : boolean ; minBid : number ; } | { distributionType : "ShopLotteryDistributionPolicy" ; } | { distributionType : "ShopPurchaseDistributionPolicy" ; } ; numAvailable : any ; partnerId : string ; product : | undefined | { rewardType : "FanPointsReward" ; } | { rewardType : "FanPointsVoucher" ; } | { rewardType : "Lootbox" ; } | { rewardType : "LotteryTicket" ; } | { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } | { rewardType : "StatusPointsReward" ; } ; readableObjectId : undefined | string ; rewardId : string ; } [] ; lotteries : { distributionPolicy : | { distributionType : "BasicDistributionPolicy" ; } | { distributionType : "PromotionDistributionPolicy" ; } | { distributionType : "ShopAuctionDistributionPolicy" ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopLotteryDistributionPolicy" ; isRecentlyAvailable : boolean ; lotteryEndDate : string ; lotteryStartDate : string ; lotteryStatus : LotteryDrawStatus ; numTicketsToDraw : number ; ticketPrice : number ; } | { distributionType : "ShopPurchaseDistributionPolicy" ; } ; numAvailable : any ; partnerId : string ; product : | undefined | { rewardType : "FanPointsReward" ; } | { rewardType : "FanPointsVoucher" ; } | { rewardType : "Lootbox" ; } | { rewardType : "LotteryTicket" ; } | { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } | { rewardType : "StatusPointsReward" ; } ; readableObjectId : undefined | string ; rewardId : string ; } [] ; } > Returns Promise < { auctions : { distributionPolicy : | { distributionType : "BasicDistributionPolicy" ; } | { distributionType : "PromotionDistributionPolicy" ; } | { auctionEndDate : string ; auctionStartDate : string ; auctionStatus : AuctionResultStatus ; currency : Currency ; currentHighestBid : undefined | number ; currentNumberOfBids : undefined | number ; distributionPolicyId : string ; distributionType : "ShopAuctionDistributionPolicy" ; isRecentlyAvailable : boolean ; minBid : number ; } | { distributionType : "ShopLotteryDistributionPolicy" ; } | { distributionType : "ShopPurchaseDistributionPolicy" ; } ; numAvailable : any ; partnerId : string ; product : | undefined | { rewardType : "FanPointsReward" ; } | { rewardType : "FanPointsVoucher" ; } | { rewardType : "Lootbox" ; } | { rewardType : "LotteryTicket" ; } | { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } | { rewardType : "StatusPointsReward" ; } ; readableObjectId : undefined | string ; rewardId : string ; } [] ; lotteries : { distributionPolicy : | { distributionType : "BasicDistributionPolicy" ; } | { distributionType : "PromotionDistributionPolicy" ; } | { distributionType : "ShopAuctionDistributionPolicy" ; } | { currency : Currency ; distributionPolicyId : string ; distributionType : "ShopLotteryDistributionPolicy" ; isRecentlyAvailable : boolean ; lotteryEndDate : string ; lotteryStartDate : string ; lotteryStatus : LotteryDrawStatus ; numTicketsToDraw : number ; ticketPrice : number ; } | { distributionType : "ShopPurchaseDistributionPolicy" ; } ; numAvailable : any ; partnerId : string ; product : | undefined | { rewardType : "FanPointsReward" ; } | { rewardType : "FanPointsVoucher" ; } | { rewardType : "Lootbox" ; } | { rewardType : "LotteryTicket" ; } | { description : string ; imageUrls : string [] ; partner : { branding : { logoColorUrl : undefined | string ; } ; name : string ; partnerId : string ; } ; productCategory : ProductCategory ; rewardType : "Product" ; title : string ; } | { rewardType : "StatusPointsReward" ; } ; readableObjectId : undefined | string ; rewardId : string ; } [] ; } > purchase Item purchase Item ( userId , rewardId , distributionPolicyId , partnerId , amount , deliveryName , deliveryAddress ) : Promise < undefined > Parameters userId : string rewardId : string distributionPolicyId : string partnerId : string amount : number deliveryName : string deliveryAddress : { city : string ; country : string ; street : string ; zip_code : string ; } city : string country : string street : string zip_ code : string Returns Promise < undefined > purchase Lottery Ticket purchase Lottery Ticket ( userId , rewardId , distributionPolicyId , partnerId , amount , deliveryName , deliveryAddress ) : Promise < undefined > Parameters userId : string rewardId : string distributionPolicyId : string partnerId : string amount : number deliveryName : string deliveryAddress : { city : string ; country : string ; street : string ; zip_code : string ; } city : string country : string street : string zip_ code : string Returns Promise < undefined >
This class allows you to display the items in the marketplace, to purchase items and lottery tickets and to place bids. Furthermore, it allows to retrieve purchases done by the user.