/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::Call::GetCategory2CS

NAME

eBay::API::XML::Call::GetCategory2CS

DESCRIPTION

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetCategory2CS inherits from the eBay::API::XML::BaseCall class

Subroutines:

setAttributeSystemVersion()

A version of the mappings for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the categories for which the mappings have changed since the specified version. If not specified, all category-to-characteristics set mappings are returned. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS Title: Retrieving Category-to-Meta-Data Mappings

RequiredInput: No
#    Argument: 'xs:string'

setCategoryID()

ID of a category for which to retrieve mappings. If not specified, the call retrieves a map for all categories.

MaxLength: 10

RequiredInput: No
#    Argument: 'xs:string'

getAttributeSystemVersion()

Current version of the mappings for the site. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed.

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

getMappedCategoryArray()

Contains data about categories that are mapped to characteristics sets. Use this data to determine:<br> - The names and IDs of the characteristics sets<br> - The availability of the Pre-filled Item Information feature for listings in that category (i.e., whether the category is catalog-enabled)<br> - For catalog-enabled categories, the available product search methods<br> - The current version information for the complete mapping<br> - The version information for each characteristics set

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

getSiteWideCharacteristicSets()

A list of one or more characteristics sets mapped to the category, if any. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality.

Returned: Conditionally
Details: DetailLevel: ReturnAll
#    Returns: reference to an array  
                    of 'ns:SiteWideCharacteristicsType'

getUnmappedCategoryArray()

Contains data about categories (if any) whose characteristics set mappings have changed since the version specified in the request. When a characteristics set mapping changes, the data appears in both the UnmappedCategoryArray object (to indicate that the change occurred) and the MappedCategoryArray object.

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