eBay::API::XML::Call::GetExpressWishList::GetExpressWishListRequestType(3)

NAME
eBay::API::XML::Call::GetExpressWishList::GetExpressWishListRequestType

DESCRIPTION
Enables users to retrieve and view eBay Express wish lists. Wish list is a feature currently available on the eBay Express web site. This call does not enable creation, modification, or removal of wish lists. Wish lists may be public or private. Private wish lists are available for viewing only by their owners. User ID is not returned in the response. Only one of the search input fields, (FirstName, LastName, UserID, and WishListID) is recognized in a request. When all search input fields are included in a request, WishListID takes precedence, followed by UserID, which is followed by FirstName and/or LastName. If none of the search input fields are used, the call returns the wish list of the requesting user.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::GetExpressWishList::GetExpressWishListRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

  setFirstName()
User first name. Can be used in combination with LastName. Will be ignored if either UserID or WishListID is included in the request.

  RequiredInput: No
#    Argument: 'xs:string'

  getFirstName()
# Returns: 'xs:string'

  setLastName()
User last name. Can be used in combination with FirstName. Will be ignored if either UserID or WishListID is included in the request.

  RequiredInput: No
#    Argument: 'xs:string'

  getLastName()
# Returns: 'xs:string'

  setPagination()
Contains the data that control the pagination of items or products in any returned wish list.

  RequiredInput: No
#    Argument: 'ns:PaginationType'

  getPagination()
# Returns: 'ns:PaginationType'

  setSortOrder()
Sort order for returned results. Default is CreationDateDescending, which returns the most recently added wish list items first.

  RequiredInput: No
#    Argument: 'ns:WishListSortCodeType'

  getSortOrder()
# Returns: 'ns:WishListSortCodeType'

  setUserID()
eBay user ID. Can be used as an alternative to WishListID or to the combination FirstName and LastName. If WishListID is used, UserID will be ignored. This value is not returned in the response.

  RequiredInput: No
#    Argument: 'xs:string'

  getUserID()
# Returns: 'xs:string'

  setWishListID()
Identifies an eBay Express wish list. When used in a request, UserID and FirstName and LastName are ignored.

  RequiredInput: No
#    Argument: 'xs:string'

  getWishListID()
# Returns: 'xs:string'