NAME

eBay::API::XML::Call::GetCategories::GetCategoriesResponseType

DESCRIPTION

Contains the category data for the eBay site specified as input. The category data is contained in a CategoryArrayType object, within which are zero, one, or multiple CategoryType objects. Each CategoryType object contains the detail data for one category. Other fields tell how many categories are returned in a call, when the category hierarchy was last updated, and the version of the category hierarchy (all three of which can differ from one eBay site to the next).

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetCategories::GetCategoriesResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

setCategoryArray()

List of the returned categories. The category array contains one CategoryType object for each returned category. Returns empty if no detail level is specified.

# Argument: 'ns:CategoryArrayType'

getCategoryArray()

  Returned: Always
  Details: DetailLevel: ReturnAll
#    Returns: 'ns:CategoryArrayType'

setCategoryCount()

Indicates the number of categories returned (i.e., the number of CategoryType objects in CategoryArray).

# Argument: 'xs:int'

getCategoryCount()

  Returned: Always
  Details: DetailLevel: ReturnAll
#    Returns: 'xs:int'

setCategoryVersion()

Indicates the version of the category hierarchy on the specified eBay site.

# Argument: 'xs:string'

getCategoryVersion()

  Returned: Always
  Details: DetailLevel: ReturnAll, none
#    Returns: 'xs:string'

setMinimumReservePrice()

Indicates the lowest possible reserve price allowed for any item listed in any category on the site. You can use the fields returned by GetCategoryFeatures to determine if a different Minimum Reserve Price is defined for the category you want to use.

# Argument: 'xs:double'

getMinimumReservePrice()

  Returned: Always
  Details: DetailLevel: ReturnAll, none
#    Returns: 'xs:double'

setReduceReserveAllowed()

If true, ReduceReserveAllowed indicates that all categories on the site allow the seller to reduce an item's reserve price. If false, this field is not returned in the response and all categories on the site do not normally allow sellers to reduce an item's reserve price. The Category.ORRA (override reduce reserve price) field can override (or toggle) the reserve price reduction setting for a given category. For example, if ReduceReserveAllowed is false and Category.ORRA is true, the category overrides the site setting and supports reducing reserve prices. If ReduceReserveAllowed is true and Category.ORRA is true, the category overrides the site setting and does does not support reducing reserve prices.

# Argument: 'xs:boolean'

isReduceReserveAllowed()

  Returned: Always
  Details: DetailLevel: ReturnAll, none
#    Returns: 'xs:boolean'

setReservePriceAllowed()

If true, ReservePriceAllowed indicates that all categories on the site allow the seller to specify a reserve price for an item. If false, this field is not returned in the response and all categories on the site do not normally allow sellers to specify reserve prices. The Category.ORPA (override reserve price allowed) field can override (or toggle) the reserve price allowed setting for a given category. For example, if ReservePriceAllowed is false and Category.ORPA is true, the category overrides the site setting and supports reserve prices. If ReservePriceAllowed is true and Category.ORPA is true, the category overrides the site setting and does does not support reserve prices.

# Argument: 'xs:boolean'

isReservePriceAllowed()

  Returned: Always
  Details: DetailLevel: ReturnAll, none
#    Returns: 'xs:boolean'

setUpdateTime()

Indicates the last date and time that eBay modified the category hierarchy for the specified eBay site.

# Argument: 'xs:dateTime'

getUpdateTime()

  Returned: Always
  Details: DetailLevel: ReturnAll, none
#    Returns: 'xs:dateTime'