NAME

eBay::API::XML::DataType::ItemListCustomizationType

DESCRIPTION

Defines how a list of items should be returned.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::ItemListCustomizationType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setDurationInDays()

Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. Valid for WonList, DeletedFromWonList, LostList, DeletedFromLostList, SoldList, DeletedFromSoldList, UnsoldList, DeletedFromUnsoldList, BestOfferList, BuyingReminders, and SellingReminders.

Max: 60 Min: 0

  Calls: GetMyeBayBuying
  RequiredInput: No
  Context: BestOfferList
           LostList
           DeletedFromLostList
           WonList
           DeletedFromWonList

  Calls: GetMyeBaySelling
  RequiredInput: No
  Context: SoldList
           DeletedFromSoldList
           DeletedFromUnsoldList
           UnsoldList

# Argument: 'xs:int'

getDurationInDays()

# Returns: 'xs:int'

setInclude()

Returns the list using the default settings.

  Calls: GetMyeBayBuying
  RequiredInput: No
  Context: BestOfferList

# Argument: 'xs:boolean'

isInclude()

# Returns: 'xs:boolean'

setIncludeNotes()

Specifies whether to include Item.PrivateNotes and Item.eBayNotes in the response. Valid for WatchList, BidList, WonList, DeletedFromWonList, LostList, DeletedFromLostList, ScheduledList, ActiveList, SoldList, and UnsoldList.

  Calls: GetMyeBayBuying
  RequiredInput: No
  Context: BestOfferList
           BidList
           LostList
           WatchList
           WonList
           DeletedFromWonList
           DeletedFromLostList

  Calls: GetMyeBaySelling
  RequiredInput: No
  Context: BidList
           SoldList
           UnsoldList
           DeletedFromSoldList
           DeletedFromUnsoldList
           ScheduledList
           ActiveList

# Argument: 'xs:boolean'

isIncludeNotes()

# Returns: 'xs:boolean'

setListingType()

Specifies the listing type of items in the returned list. In GetMyeBaySelling, valid only for ActiveList.

  Calls: GetMyeBayBuying
  RequiredInput: No
  OnlyTheseValues: Auction, FixedPriceItem, StoresFixedPrice,
                                                        AdType
  Context: BestOfferList

  Calls: GetMyeBaySelling
  RequiredInput: No
  OnlyTheseValues: Auction, FixedPriceItem, StoresFixedPrice,
                                                        AdType
  Context: ActiveList

# Argument: 'ns:ListingTypeCodeType'

getListingType()

# Returns: 'ns:ListingTypeCodeType'

setPagination()

Specifies how to create virtual pages in the returned list. Valid for BidList, WonList, LostList, ScheduledList, ActiveList, SoldList, DeleteFromSoldList, UnsoldList, DeleteFromUnsoldList, and GetItemsAwaitingFeedback. Default for EntriesPerPage with GetMyeBayBuying is 200.

  Calls: GetMyeBaySelling
  RequiredInput: No
  Context: BidList
           ActiveList
           ScheduledList
           SoldList
           UnsoldList
           DeleteFromSoldList
           DeleteFromUnsoldList

  Calls: GetMyeBayBuying
  RequiredInput: No
  Context: BestOfferList
           BidList
           LostList
           DeletedFromLostList
           WonList
           DeletedFromWonList

# Argument: 'ns:PaginationType'

getPagination()

# Returns: 'ns:PaginationType'

setSort()

Specifies how the items returned should be sorted. Valid for BestOfferList, BidList, LostList, DeleteFromLostList, WatchList, WonList, and DeleteFromWonList for GetMyeBayBuying. Valid for BidList, ScheduledList, ActiveList, SoldList, DeletedFromSoldList, UnsoldList, and DeletedFromUnsoldList for GetMyeBaySelling. Also valid for GetItemsAwaitingFeedback.

  Calls: GetMyeBayBuying
  RequiredInput: No
  Context: BestOfferList
           BidList
           DeletedFromLostList
           DeletedFromWonList
           LostList
           WatchList
           WonList

  Calls: GetMyeBaySelling
  RequiredInput: No
  Context: BidList
           ScheduledList
           ActiveList
           SoldList
           DeletedFromSoldList
           UnsoldList
           DeletedFromUnsoldList

  Calls: GetItemsAwaitingFeedback
  RequiredInput: No

# Argument: 'ns:ItemSortTypeCodeType'

getSort()

# Returns: 'ns:ItemSortTypeCodeType'