Copyright	(c) Christopher Reichert 2014
License	AllRightsReserved
Maintainer	Christopher Reichert <creichert@reichertbrothers.com>
Stability	experimental
Portability	GNU/Linux, FreeBSD
Safe Haskell	None
Language	Haskell2010

Web.Ebay

Contents

Functions
Ebay API types.

Description

Haskell SDK for Ebay Finding API

Synopsis

searchWithVerb :: MonadIO m => EbayConfig -> FindVerb -> Search -> Manager -> m (Maybe SearchResponse)
simpleSearchWithVerb :: EbayConfig -> SearchRequest -> IO (Maybe SearchResponse)
defaultEbayConfig :: EbayConfig
data Search = Search {
- searchKeywords :: !Text
- searchOutputSelector :: Maybe OutputSelector
- searchSortOrder :: Maybe SortOrder
- searchItemFilter :: ![ItemFilter]
- searchAffiliateInfo :: Maybe AffiliateInfo
- searchProductId :: Maybe ProductId
}
data SearchRequest = SearchRequest {
- verb :: !FindVerb
- payload :: Search
}
data SearchResponse = SearchResponse FindVerb SearchResult
data SearchResult = SearchResult {
- searchResultCount :: Text
- searchResultItems :: [SearchItem]
}
data SearchItem = SearchItem {
- searchItemId :: !Text
- searchItemTitle :: !Text
- searchItemSubtitle :: !(Maybe Text)
- searchItemTopRatedListing :: !Bool
- searchItemViewItemUrl :: !Text
- searchItemGalleryUrl :: !(Maybe Text)
- searchItemGalleryPlusPictureUrl :: !(Maybe Text)
- searchItemPictureLargeUrl :: !(Maybe Text)
- searchItemCondition :: Condition
- searchItemSellingStatus :: SellingStatus
- searchItemListingInfo :: Maybe ListingInfo
}
data SellingStatus = SellingStatus {
- sellingStatusConvertedCurrentPrice :: !Double
- sellingStatusCurrentPrice :: !Double
- sellingStatusBidCount :: !(Maybe Text)
- sellingStatusState :: SellingState
}
data SortOrder
- = EndTimeSoonest
- | BestMatch
- | BidCountFewest
- | BidCountMost
- | CountryAscending
- | CountryDescending
- | CurrentPriceHighest
- | DistanceNearest
- | PricePlusShipingHighest
- | PricePlusShippingLowest
- | StartTimeNewest
data FindVerb
- = FindCompletedItems
- | FindItemsAdvanced
- | FindItemsByImage
- | FindItemsByKeywords
- | FindItemsByProduct
- | FindItemsIneBayStores
- | GetHistograms
- | GetSearchKeywordsRecommendation
- | GetVersion
data EbayConfig = EbayConfig {
- ebDomain :: !Text
- ebUri :: !Text
- ebHttps :: !Bool
- ebSiteId :: !Text
- ebResponseEncoding :: !Encoding
- ebRequestEncoding :: !Encoding
- ebAppId :: !Text
- ebVersion :: !Text
- ebService :: !Text
- ebDocUrl :: !Text
- ebDebug :: !Bool
}
data SellingState
- = Active
- | Canceled
- | Ended
- | EndedWithSales
- | EndedWithoutSales
newtype ItemFilter = ItemFilter (Text, Text)
data Condition = Condition Text Text
data ListingInfo = ListingInfo {
- listingInfoBestOfferEnabled :: !Bool
- listingInfoBuyItNowAvailable :: !Bool
- listingInfoBuyItNowPrice :: !(Maybe Text)
- listingInfoConvertedBuyItNowPrice :: !(Maybe Text)
- listingInfoEndTime :: !UTCTime
- listingInfoGift :: !Bool
- listingInfoType :: ListingType
- listingInfoStartTime :: !UTCTime
}
data OutputSelector
- = AspectHistogram
- | CategoryHistogram
- | ConditionHistogram
- | GalleryInfoOutput
- | PictureURLLarge
- | PictureURLSuperSize
- | SellerInfo
- | StoreInfo
- | UnitPriceInfo
data ProductId
- = EAN Integer
- | ISBN Integer
- | UPC Integer
- | ReferenceId String
data GalleryInfo = GalleryInfo {
- galleryInfoUrls :: ![Text]
}
data AffiliateInfo = AffiliateInfo {
- networkId :: !Int
- trackingId :: !Int
- customId :: !(Maybe Int)
}

Functions

searchWithVerb #

Arguments

:: MonadIO m
=> EbayConfig	api configuration
-> FindVerb	action to run
-> Search	search request
-> Manager	http connection manager
-> m (Maybe SearchResponse)

Runs an eBay Finding API search

simpleSearchWithVerb :: EbayConfig -> SearchRequest -> IO (Maybe SearchResponse) #

defaultEbayConfig :: EbayConfig #

Default Ebay configuration for working with the finding API in a sandbox.

Ebay API types.

data Search #

Generic search query for ebay api.

Constructors

Search
Fields searchKeywords :: !Text searchOutputSelector :: Maybe OutputSelector searchSortOrder :: Maybe SortOrder searchItemFilter :: ![ItemFilter] searchAffiliateInfo :: Maybe AffiliateInfo searchProductId :: Maybe ProductId

Instances

Show Search #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> Search -> ShowS # show :: Search -> String # showList :: [Search] -> ShowS #
ToJSON Search #
Instance details Defined in Web.Ebay Methods toJSON :: Search -> Value # toEncoding :: Search -> Encoding # toJSONList :: [Search] -> Value # toEncodingList :: [Search] -> Encoding #

data SearchRequest #

Ebay Finding API search request.

Constructors

SearchRequest
Fields verb :: !FindVerb specify the type of search payload :: Search body of the search (xml or json)

Instances

Show SearchRequest #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SearchRequest -> ShowS # show :: SearchRequest -> String # showList :: [SearchRequest] -> ShowS #
ToJSON SearchRequest #
Instance details Defined in Web.Ebay Methods toJSON :: SearchRequest -> Value # toEncoding :: SearchRequest -> Encoding # toJSONList :: [SearchRequest] -> Value # toEncodingList :: [SearchRequest] -> Encoding #

data SearchResponse #

Represents a Response from the eBay finding api

TODO: Search responses technically have a list of SearchResult

Constructors

SearchResponse FindVerb SearchResult

Instances

Show SearchResponse #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SearchResponse -> ShowS # show :: SearchResponse -> String # showList :: [SearchResponse] -> ShowS #
FromJSON SearchResponse #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser SearchResponse # parseJSONList :: Value -> Parser [SearchResponse] #

data SearchResult #

Constructors

SearchResult
Fields searchResultCount :: Text searchResultItems :: [SearchItem]

Instances

Show SearchResult #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SearchResult -> ShowS # show :: SearchResult -> String # showList :: [SearchResult] -> ShowS #
FromJSON SearchResult #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser SearchResult # parseJSONList :: Value -> Parser [SearchResult] #

data SearchItem #

A single ebay listing item

Note that some fields have not yet been implemented from the ebay api documentation.

Constructors

SearchItem

Fields

searchItemId :: !Text
searchItemTitle :: !Text
searchItemSubtitle :: !(Maybe Text)
searchItemTopRatedListing :: !Bool
searchItemViewItemUrl :: !Text
searchItemGalleryUrl :: !(Maybe Text)
searchItemGalleryPlusPictureUrl :: !(Maybe Text)
searchItemPictureLargeUrl :: !(Maybe Text)
searchItemCondition :: Condition
searchItemSellingStatus :: SellingStatus
searchItemListingInfo :: Maybe ListingInfo

Instances

Show SearchItem #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SearchItem -> ShowS # show :: SearchItem -> String # showList :: [SearchItem] -> ShowS #
FromJSON SearchItem #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser SearchItem # parseJSONList :: Value -> Parser [SearchItem] #

data SellingStatus #

Constructors

SellingStatus
Fields sellingStatusConvertedCurrentPrice :: !Double sellingStatusCurrentPrice :: !Double sellingStatusBidCount :: !(Maybe Text) sellingStatusState :: SellingState

Instances

Show SellingStatus #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SellingStatus -> ShowS # show :: SellingStatus -> String # showList :: [SellingStatus] -> ShowS #
FromJSON SellingStatus #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser SellingStatus # parseJSONList :: Value -> Parser [SellingStatus] #

data SortOrder #

Constructors

EndTimeSoonest
BestMatch
BidCountFewest
BidCountMost
CountryAscending
CountryDescending
CurrentPriceHighest
DistanceNearest
PricePlusShipingHighest
PricePlusShippingLowest
StartTimeNewest

Instances

Show SortOrder #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SortOrder -> ShowS # show :: SortOrder -> String # showList :: [SortOrder] -> ShowS #
Generic SortOrder #
Instance details Defined in Web.Ebay Associated Types type Rep SortOrder :: Type -> Type # Methods from :: SortOrder -> Rep SortOrder x # to :: Rep SortOrder x -> SortOrder #
ToJSON SortOrder #
Instance details Defined in Web.Ebay Methods toJSON :: SortOrder -> Value # toEncoding :: SortOrder -> Encoding # toJSONList :: [SortOrder] -> Value # toEncodingList :: [SortOrder] -> Encoding #
type Rep SortOrder #
Instance details Defined in Web.Ebay type Rep SortOrder = D1 (MetaData "SortOrder" "Web.Ebay" "hsebaysdk-0.4.0.0-HMKDmjJj47zJ45hUalHf0F" False) (((C1 (MetaCons "EndTimeSoonest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "BestMatch" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "BidCountFewest" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "BidCountMost" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CountryAscending" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "CountryDescending" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CurrentPriceHighest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DistanceNearest" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "PricePlusShipingHighest" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "PricePlusShippingLowest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "StartTimeNewest" PrefixI False) (U1 :: Type -> Type)))))

data FindVerb #

Support verbs in finding api

verb jargon taken from eBay docs.

Constructors

FindCompletedItems
FindItemsAdvanced
FindItemsByImage
FindItemsByKeywords
FindItemsByProduct
FindItemsIneBayStores
GetHistograms
GetSearchKeywordsRecommendation
GetVersion

Instances

Show FindVerb #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> FindVerb -> ShowS # show :: FindVerb -> String # showList :: [FindVerb] -> ShowS #

data EbayConfig #

Ebay api configuration.

Constructors

EbayConfig

Fields

ebDomain :: !Text
ebay api domain configuration Sandbox: svcs.sandbox.ebay.com Production: svcs.ebay.com
ebUri :: !Text
ebay api domain configuration
ebHttps :: !Bool
use https defaults to False.
ebSiteId :: !Text
EBay API Site Id. Default is `EBAY-US'.
ebResponseEncoding :: !Encoding
Specify the response encoding.
ebRequestEncoding :: !Encoding
Specify the request encoding.
ebAppId :: !Text
ebVersion :: !Text
ebService :: !Text
eBay API service. Currently, this library only supports the Finding API and this value is always FindingApi
ebDocUrl :: !Text
ebDebug :: !Bool
Enable debugging

Instances

Show EbayConfig #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> EbayConfig -> ShowS # show :: EbayConfig -> String # showList :: [EbayConfig] -> ShowS #

data SellingState #

Constructors

Active
Canceled
Ended
EndedWithSales
EndedWithoutSales

Instances

Eq SellingState #
Instance details Defined in Web.Ebay Methods (==) :: SellingState -> SellingState -> Bool # (/=) :: SellingState -> SellingState -> Bool #
Show SellingState #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> SellingState -> ShowS # show :: SellingState -> String # showList :: [SellingState] -> ShowS #
Generic SellingState #
Instance details Defined in Web.Ebay Associated Types type Rep SellingState :: Type -> Type # Methods from :: SellingState -> Rep SellingState x # to :: Rep SellingState x -> SellingState #
FromJSON SellingState #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser SellingState # parseJSONList :: Value -> Parser [SellingState] #
type Rep SellingState #
Instance details Defined in Web.Ebay type Rep SellingState = D1 (MetaData "SellingState" "Web.Ebay" "hsebaysdk-0.4.0.0-HMKDmjJj47zJ45hUalHf0F" False) ((C1 (MetaCons "Active" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Canceled" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Ended" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "EndedWithSales" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "EndedWithoutSales" PrefixI False) (U1 :: Type -> Type))))

newtype ItemFilter #

Constructors

ItemFilter (Text, Text)

Instances

Show ItemFilter #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> ItemFilter -> ShowS # show :: ItemFilter -> String # showList :: [ItemFilter] -> ShowS #
ToJSON ItemFilter #
Instance details Defined in Web.Ebay Methods toJSON :: ItemFilter -> Value # toEncoding :: ItemFilter -> Encoding # toJSONList :: [ItemFilter] -> Value # toEncodingList :: [ItemFilter] -> Encoding #

data Condition #

Condition is made up of condition id condition display name

Constructors

Condition Text Text

Instances

Show Condition #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> Condition -> ShowS # show :: Condition -> String # showList :: [Condition] -> ShowS #
FromJSON Condition #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser Condition # parseJSONList :: Value -> Parser [Condition] #

data ListingInfo #

Constructors

ListingInfo
Fields listingInfoBestOfferEnabled :: !Bool listingInfoBuyItNowAvailable :: !Bool listingInfoBuyItNowPrice :: !(Maybe Text) listingInfoConvertedBuyItNowPrice :: !(Maybe Text) listingInfoEndTime :: !UTCTime listingInfoGift :: !Bool listingInfoType :: ListingType listingInfoStartTime :: !UTCTime

Instances

Show ListingInfo #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> ListingInfo -> ShowS # show :: ListingInfo -> String # showList :: [ListingInfo] -> ShowS #
FromJSON ListingInfo #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser ListingInfo # parseJSONList :: Value -> Parser [ListingInfo] #

data OutputSelector #

Constructors

AspectHistogram
CategoryHistogram
ConditionHistogram
GalleryInfoOutput
PictureURLLarge
PictureURLSuperSize
SellerInfo
StoreInfo
UnitPriceInfo

Instances

Read OutputSelector #
Instance details Defined in Web.Ebay Methods readsPrec :: Int -> ReadS OutputSelector # readList :: ReadS [OutputSelector] # readPrec :: ReadPrec OutputSelector # readListPrec :: ReadPrec [OutputSelector] #
Show OutputSelector #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> OutputSelector -> ShowS # show :: OutputSelector -> String # showList :: [OutputSelector] -> ShowS #
Generic OutputSelector #
Instance details Defined in Web.Ebay Associated Types type Rep OutputSelector :: Type -> Type # Methods from :: OutputSelector -> Rep OutputSelector x # to :: Rep OutputSelector x -> OutputSelector #
ToJSON OutputSelector #
Instance details Defined in Web.Ebay Methods toJSON :: OutputSelector -> Value # toEncoding :: OutputSelector -> Encoding # toJSONList :: [OutputSelector] -> Value # toEncodingList :: [OutputSelector] -> Encoding #
FromJSON OutputSelector #
Instance details Defined in Web.Ebay Methods parseJSON :: Value -> Parser OutputSelector # parseJSONList :: Value -> Parser [OutputSelector] #
type Rep OutputSelector #
Instance details Defined in Web.Ebay type Rep OutputSelector = D1 (MetaData "OutputSelector" "Web.Ebay" "hsebaysdk-0.4.0.0-HMKDmjJj47zJ45hUalHf0F" False) (((C1 (MetaCons "AspectHistogram" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CategoryHistogram" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "ConditionHistogram" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GalleryInfoOutput" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "PictureURLLarge" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "PictureURLSuperSize" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "SellerInfo" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "StoreInfo" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UnitPriceInfo" PrefixI False) (U1 :: Type -> Type)))))

data ProductId #

Constructors

EAN Integer
ISBN Integer
UPC Integer
ReferenceId String

Instances

Show ProductId #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> ProductId -> ShowS # show :: ProductId -> String # showList :: [ProductId] -> ShowS #
ToJSON ProductId #
Instance details Defined in Web.Ebay Methods toJSON :: ProductId -> Value # toEncoding :: ProductId -> Encoding # toJSONList :: [ProductId] -> Value # toEncodingList :: [ProductId] -> Encoding #

data GalleryInfo #

Constructors

GalleryInfo
Fields galleryInfoUrls :: ![Text]

Instances

Show GalleryInfo #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> GalleryInfo -> ShowS # show :: GalleryInfo -> String # showList :: [GalleryInfo] -> ShowS #

data AffiliateInfo #

Constructors

AffiliateInfo

Fields

networkId :: !Int
The networkId specifies the third party who is your tracking partner. When specifying affiliate details, this field is required. Not all partners are valid for all sites.
trackingId :: !Int
The trackingId specifies an ID to identify you to your tracking partner. The value you specify is obtained from your tracking partner. For eBay Partner Network, the trackingId is the Campaign ID ("campid") provided by eBay Partner Network. A Campaign ID is a 10-digit, unique number to be used for associating traffic. A Campaign ID is valid across all programs to which you have been accepted.
customId :: !(Maybe Int)
The customId need not be specified. You can define a customId (up to 256 characters) if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide a customId, it will be contained in the tracking URL returned by eBay Partner Network.

Instances

Eq AffiliateInfo #
Instance details Defined in Web.Ebay Methods (==) :: AffiliateInfo -> AffiliateInfo -> Bool # (/=) :: AffiliateInfo -> AffiliateInfo -> Bool #
Read AffiliateInfo #
Instance details Defined in Web.Ebay Methods readsPrec :: Int -> ReadS AffiliateInfo # readList :: ReadS [AffiliateInfo] # readPrec :: ReadPrec AffiliateInfo # readListPrec :: ReadPrec [AffiliateInfo] #
Show AffiliateInfo #
Instance details Defined in Web.Ebay Methods showsPrec :: Int -> AffiliateInfo -> ShowS # show :: AffiliateInfo -> String # showList :: [AffiliateInfo] -> ShowS #
ToJSON AffiliateInfo #
Instance details Defined in Web.Ebay Methods toJSON :: AffiliateInfo -> Value # toEncoding :: AffiliateInfo -> Encoding # toJSONList :: [AffiliateInfo] -> Value # toEncodingList :: [AffiliateInfo] -> Encoding #