hsebaysdk-0.3.1.0: Haskell eBay SDK

Copyright(c) Christopher Reichert, 2014
LicenseAllRightsReserved
MaintainerChristopher Reichert <creichert@reichertbrothers.com>
Stabilityexperimental
PortabilityGNU/Linux, FreeBSD
Safe HaskellNone
LanguageHaskell2010

Web.Ebay

Contents

Description

Haskell SDK for Ebay Finding API

Synopsis

Functions

searchWithVerb Source

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

defaultEbayConfig :: EbayConfig Source

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

Ebay API types.

data SearchRequest Source

Ebay Finding API search request.

Constructors

SearchRequest 

Fields

verb :: !FindVerb

specify the type of search

payload :: Search

body of the search (xml or json)

data SearchResponse Source

Represents a Response from the eBay finding api

TODO: Search responses technically have a list of SearchResult

data EbayConfig Source

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

data Condition Source

Condition is made up of condition id condition display name

Constructors

Condition Text Text 

data GalleryInfo Source

Constructors

GalleryInfo 

Fields

galleryInfoUrls :: ![Text]
 

data AffiliateInfo Source

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.