eBay Trading APIVersion 1039

CategoryType

Container for data on one listing category. Many of the CategoryType fields are only returned in the GetCategories response. Add/Revise/Relist calls only use the CategoryID field to specify which eBay category in which to list the item.

Types that use CategoryType:

Calls that use CategoryType:

Fields



AutoPayEnabled ( boolean ) [0..1]
If this field is returned as true, the corresponding category supports immediate payment for listings. PayPal must be an accepted payment method for a listing for the seller to required immediate payment from the buyer. If this field is not present, the category does not immediate payment. This field is not returned when false.
See the Field Index to learn which calls use AutoPayEnabled.

B2BVATEnabled ( boolean ) [0..1]
If this field is returned as true, the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not B2B VAT listings. This field is not returned when false. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only.
See the Field Index to learn which calls use B2BVATEnabled.

BestOfferEnabled ( boolean ) [0..1]
If this field is returned as true, the corresponding category supports Best Offers. If this field is not present, the category does not support Best Offers. This field is not returned when false.
See the Field Index to learn which calls use BestOfferEnabled.

CatalogEnabled ( boolean ) [0..1]
Not used by any call.

If this field is deprecated..
See the Field Index to learn which calls use CatalogEnabled.

CategoryID ( string ) [0..1]
This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used.
See the Field Index to learn which calls use CategoryID.

CategoryLevel ( int ) [0..1]
This integer value indicates the level where the category fits in the eBay site's category hierarchy. For example, if this field has a value of 2, then the category is two levels below the root category in the eBay site's category hierarchy.
See the Field Index to learn which calls use CategoryLevel.

CategoryName ( string ) [0..1]
This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
See the Field Index to learn which calls use CategoryName.

CategoryParentID ( string ) [0..*]
This string value is the Category ID of the primary category's (indicated in the CategoryID field) parent category. The number of CategoryParentID values that are returned will depend on the LevelLimit value that is set (in GetCategories) and on how far up the primary category is in the eBay category hierarchy. CategoryParentID values are returned in correct sequence, starting from the root category and ending with the category that is the direct parent of the primary category specified in CategoryID. The CategoryID and CategoryParentID values will be the same if the LevelLimit value is set to 1.
See the Field Index to learn which calls use CategoryParentID.

CategoryParentName ( string ) [0..*]
This string value is the display name of the category indicated in the corresponding CategoryParentID field. If multiple parent categories are retrieved in the GetSuggestedCategories call, the matching CategoryParentID and CategoryParentName can be found by following the sequence in which these fields are returned. The primary category's ancestors are returned in sequence beginning with the root category all the way down to the primary category's direct parent category.

The CategoryParentName fields and the CategoryName field can be used to build the fully-qualified category name and/or "breadcrumbs" browse path. (e.g., Computers & Networking > Technology Books > Certification).
See the Field Index to learn which calls use CategoryParentName.

CharacteristicsSets ( CharacteristicsSetType ) [0..*]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use CharacteristicsSets.

Expired ( boolean ) [0..1]
If this field is returned as true, the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. This field is not returned when false.
See the Field Index to learn which calls use Expired.

IntlAutosFixedCat ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use IntlAutosFixedCat.

Keywords ( string ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use Keywords.

LeafCategory ( boolean ) [0..1]
If this field is returned as true, the corresponding category is an eBay leaf category, a category in which items may be listed. This field is not returned when false.
See the Field Index to learn which calls use LeafCategory.

LSD ( boolean ) [0..1]
If this field is returned as true, the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. 'LSD' is an acronym for 'Lot Size Disabled'. 'Lot Size' refers to the LotSize field in the Add/Revise/Relisting calls that is conditionally required if the seller is creating a lot listing. The LSD field is not returned when false.
See the Field Index to learn which calls use LSD.

NumOfItems ( int ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use NumOfItems.

ORPA ( boolean ) [0..1]
If this field is returned as true, the corresponding category is an exception to the eBay site's standard Reserve Price policy on auction listings. For example, if the site's default setting is to allow setting a Reserve Price, but ORPA is returned as true, this particular category does not support setting a Reserve Price. Or, if the site's default setting is not to allow setting a Reserve Price, but ORPA is returned as true, this particular category is the exception to that rule and does support setting a Reserve Price. If ORPA is true for the corresponding category, you can generally assume that the category's subcategories inherit the same setting. 'ORPA' is an acronym for 'Override Reserve Price Allowed'.

This field is not returned when false.
See the Field Index to learn which calls use ORPA.

ORRA ( boolean ) [0..1]
If this field is returned as true, the corresponding category is an exception to the eBay site's standard Reduce Reserve Price (on active auction listing) policy. For example, if the site's default setting is to allow reducing a Reserve Price for the active auction listing, but ORRA is returned as true, this particular category does not support reducing a Reserve Price. Or, if the site's default setting is not to allow reducting a Reserve Price, but ORRA is returned as true, this particular category is the exception to that rule and does support reducing a Reserve Price. If ORRA is true for the corresponding category, you can generally assume that the category's subcategories inherit the same setting. 'ORRA' is an acronym for 'Override Reduce Reserve Allowed'.

This field is not returned when false.
See the Field Index to learn which calls use ORRA.

ProductFinderIDs ( ExtendedProductFinderIDType ) [0..*]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use ProductFinderIDs.

ProductSearchPageAvailable ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use ProductSearchPageAvailable.

SellerGuaranteeEligible ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use SellerGuaranteeEligible.

Virtual ( boolean ) [0..1]
If this field is returned as true, the corresponding category is an eBay virtual category, a category in which items may not be listed. This field is not returned when false.
See the Field Index to learn which calls use Virtual.