Inherits from NSObject
Conforms to PicoBindable
Declared in Trading_CategoryType.h
Trading_CategoryType.m

Overview

     Container for data on one listing category.

@ingroup EBayAPIInterface

Tasks

  •   bestOfferEnabled

    If true, the category supports Best Offers.
    If not present, the category does not support Best Offers.
    Will not be returned if false.

         property
  •   autoPayEnabled

    If true, indicates that the category supports immediate payment.
    If not present, the category does not support
    immediate payment. Will not be returned if false.

         property
  •   b2BVATEnabled

    If true, the category supports business-to-business (B2B) VAT
    listings. Applicable to the eBay Germany (DE), Austria (AT),
    and Switzerland CH) sites only. If not present,
    the category does not support this feature. Will not be returned if false.

         property
  •   catalogEnabled

    If true, the category supports catalog product details. Not returned if false.

         property
  •   categoryID

    Distinct numeric ID for a category on eBay.
    In GetItem and related calls, see CategoryName for the text name of
    the category. Use GetCategories to look up the category parent ID.



    For GetItem, Half.com items return the Half.com category ID
    in PrimaryCategory. This ID is not necessarily returned in
    GetCategories.

         property
  •   categoryLevel

    The level where the category fits in the 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 site’s category hierarchy.

         property
  •   categoryName

    Display name of the category as it would appear on
    the eBay Web site.
    In GetItem, this is a fully qualified category name
    (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).



    In GetItem, always returned for eBay.com listings.
    Not returned in PrimaryCategory for Half.com listings.

         property
  •   categoryParentID

    Category ID identifying a category that is an ancestor of
    the category indicated in CategoryID.
    For GetCategories, returns the same value as CategoryID
    if the CategoryLevel is 1.
    For GetSuggestedCategories, multiple CategoryParentID fields
    can be returned in sequence, starting with the root category
    and ending with the category that is the direct parent of
    the category specified in CategoryID.
    Use these parent fields and the CategoryID field to build
    the fully qualified category browse path or “breadcrumbs"
    (e.g., 58058:3516:3517).

         property
  •   categoryParentName

    Display name of the category indicated in CategoryParentID.
    For GetSuggestedCategories, multiple CategoryParentName fields
    can be returned in sequence, starting with the root category
    and ending with the category that
    is the direct parent of the category specified in CategoryName.
    Use these parent fields and the CategoryName field to build the
    fully qualified category browse path or “breadcrumbs"
    (e.g., Computers & Networking > Technology Books > Certification).

         property
  •   productSearchPageAvailable

    No longer applicable to any category.

         property
  •   productFinderIDs

    No longer applicable to any category.

         property
  •   characteristicsSets

    No longer applicable to any category.

         property
  •   expired

    If true, indicates a category that has expired and
    to which items may not be listed. Will not be returned if false.

         property
  •   intlAutosFixedCat

    If true, indicates that the category is a fixed-fee category. Use this
    information to identify categories are not eligible for eBay Stores Inventory
    format listings. You cannot list eBay Store Inventory format listings in
    fixed-fee categories on international sites. Output only. Will not be returned if false.

         property
  •   leafCategory

    If true, indicates that the category indicated in CategoryID is a leaf category,
    in which items may be listed (if the category is not also expired or virtual). Will not be returned if false.

         property
  •   virtual

    If true, indicates the category indicated in CategoryID is a
    virtual category, to which items may not be listed. Will not be returned if false.

         property
  •   numOfItems

    No longer applicable to any category.

         property
  •   sellerGuaranteeEligible

    No longer supported.

         property
  •   orpa

    Indicates whether the category (and its subcategories)
    allows or disallows listing with a reserve price,
    depending on the prevailing site configuration indicated by
    ReservePriceAllowed.
    ORPA (override reserve price allowed) indicates when the category
    is an exception to the site’s ReservePriceAllowed policy.



    If ORPA is true, the category overrides (toggles or reverses) the
    site’s ReservePriceAllowed setting. In other words:

    - If ReservePriceAllowed is true, reserve price is not allowed in this category.

    - If ReservePriceAllowed is false, reserve price is allowed in this category.


    If ORPA is not present, there is no override.
    That is, the category’s setting is the same as the site’s ReservePriceAllowed setting.


    This field will not be returned in the response if false.
    This toggling logic is designed to reduce the size of the GetCategories
    response by only returning ORPA when the category’s policy is different
    from the site’s policy. (If ORPA is true for a category, you can assume
    its subcategories inherit the same setting unless otherwise specified.)

         property
  •   orra

    Indicates whether the category (and its subcategories) allows
    or disallows reducing a listing’s reserve price,
    depending on the prevailing site configuration indicated by ReduceReserveAllowed.
    ORRA (override reduce reserve allowed) indicates when the category is an exception
    to the site’s ReduceReserveAllowed policy.


    If ORRA is true, the category overrides (toggles or reverses) the
    site’s ReduceReserveAllowed setting. In other words:

    - If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category.

    - If ReduceReserveAllowed is false (because it is not present in the response), reserve price reduction is allowed in this category.


    If ORRA is not present, there is no override. Will not be returned in the response if false.
    That is, the category’s setting is the same as the site’s ReduceReserveAllowed setting.



    This toggling logic is designed to reduce the size of the GetCategories
    response by only returning ORRA when the category’s policy is different
    from the site’s policy. (If ORRA is true for a category, you can assume
    its subcategories inherit the same setting unless otherwise specified.)

         property
  •   lsd

    “Lot Size Disabled (LSD)” indicates that Item.LotSize is not permitted when you list in this category.
    If true, indicates that lot sizes are disabled in the specified category. Will not be returned if false.

         property
  •   keywords

    The list of keywords returned.

         property
  •   any

    (public property)

         property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_CategoryType.h

autoPayEnabled

If true, indicates that the category supports immediate payment.
If not present, the category does not support
immediate payment. Will not be returned if false.

@property (nonatomic, retain) NSNumber *autoPayEnabled

Discussion

If true, indicates that the category supports immediate payment.
If not present, the category does not support
immediate payment. Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

b2BVATEnabled

If true, the category supports business-to-business (B2B) VAT
listings. Applicable to the eBay Germany (DE), Austria (AT),
and Switzerland CH) sites only. If not present,
the category does not support this feature. Will not be returned if false.

@property (nonatomic, retain) NSNumber *b2BVATEnabled

Discussion

If true, the category supports business-to-business (B2B) VAT
listings. Applicable to the eBay Germany (DE), Austria (AT),
and Switzerland CH) sites only. If not present,
the category does not support this feature. Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

bestOfferEnabled

If true, the category supports Best Offers.
If not present, the category does not support Best Offers.
Will not be returned if false.

@property (nonatomic, retain) NSNumber *bestOfferEnabled

Discussion

If true, the category supports Best Offers.
If not present, the category does not support Best Offers.
Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

catalogEnabled

If true, the category supports catalog product details. Not returned if false.

@property (nonatomic, retain) NSNumber *catalogEnabled

Discussion

If true, the category supports catalog product details. Not returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

categoryID

Distinct numeric ID for a category on eBay.
In GetItem and related calls, see CategoryName for the text name of
the category. Use GetCategories to look up the category parent ID.



For GetItem, Half.com items return the Half.com category ID
in PrimaryCategory. This ID is not necessarily returned in
GetCategories.

@property (nonatomic, retain) NSString *categoryID

Discussion

Distinct numeric ID for a category on eBay.
In GetItem and related calls, see CategoryName for the text name of
the category. Use GetCategories to look up the category parent ID.



For GetItem, Half.com items return the Half.com category ID
in PrimaryCategory. This ID is not necessarily returned in
GetCategories.

type : NSString, wrapper for primitive string

Declared In

Trading_CategoryType.h

categoryLevel

The level where the category fits in the 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 site’s category hierarchy.

@property (nonatomic, retain) NSNumber *categoryLevel

Discussion

The level where the category fits in the 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 site’s category hierarchy.

type : NSNumber, wrapper for primitive int

Declared In

Trading_CategoryType.h

categoryName

Display name of the category as it would appear on
the eBay Web site.
In GetItem, this is a fully qualified category name
(e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).



In GetItem, always returned for eBay.com listings.
Not returned in PrimaryCategory for Half.com listings.

@property (nonatomic, retain) NSString *categoryName

Discussion

Display name of the category as it would appear on
the eBay Web site.
In GetItem, this is a fully qualified category name
(e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).



In GetItem, always returned for eBay.com listings.
Not returned in PrimaryCategory for Half.com listings.

type : NSString, wrapper for primitive string

Declared In

Trading_CategoryType.h

categoryParentID

Category ID identifying a category that is an ancestor of
the category indicated in CategoryID.
For GetCategories, returns the same value as CategoryID
if the CategoryLevel is 1.
For GetSuggestedCategories, multiple CategoryParentID fields
can be returned in sequence, starting with the root category
and ending with the category that is the direct parent of
the category specified in CategoryID.
Use these parent fields and the CategoryID field to build
the fully qualified category browse path or “breadcrumbs"
(e.g., 58058:3516:3517).

@property (nonatomic, retain) NSMutableArray *categoryParentID

Discussion

Category ID identifying a category that is an ancestor of
the category indicated in CategoryID.
For GetCategories, returns the same value as CategoryID
if the CategoryLevel is 1.
For GetSuggestedCategories, multiple CategoryParentID fields
can be returned in sequence, starting with the root category
and ending with the category that is the direct parent of
the category specified in CategoryID.
Use these parent fields and the CategoryID field to build
the fully qualified category browse path or “breadcrumbs"
(e.g., 58058:3516:3517).

entry type : NSString, wrapper for primitive string

Declared In

Trading_CategoryType.h

categoryParentName

Display name of the category indicated in CategoryParentID.
For GetSuggestedCategories, multiple CategoryParentName fields
can be returned in sequence, starting with the root category
and ending with the category that
is the direct parent of the category specified in CategoryName.
Use these parent fields and the CategoryName field to build the
fully qualified category browse path or “breadcrumbs"
(e.g., Computers & Networking > Technology Books > Certification).

@property (nonatomic, retain) NSMutableArray *categoryParentName

Discussion

Display name of the category indicated in CategoryParentID.
For GetSuggestedCategories, multiple CategoryParentName fields
can be returned in sequence, starting with the root category
and ending with the category that
is the direct parent of the category specified in CategoryName.
Use these parent fields and the CategoryName field to build the
fully qualified category browse path or “breadcrumbs"
(e.g., Computers & Networking > Technology Books > Certification).

entry type : NSString, wrapper for primitive string

Declared In

Trading_CategoryType.h

characteristicsSets

No longer applicable to any category.

@property (nonatomic, retain) NSMutableArray *characteristicsSets

Discussion

No longer applicable to any category.

entry type : class Trading_CharacteristicsSetType

Declared In

Trading_CategoryType.h

expired

If true, indicates a category that has expired and
to which items may not be listed. Will not be returned if false.

@property (nonatomic, retain) NSNumber *expired

Discussion

If true, indicates a category that has expired and
to which items may not be listed. Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

intlAutosFixedCat

If true, indicates that the category is a fixed-fee category. Use this
information to identify categories are not eligible for eBay Stores Inventory
format listings. You cannot list eBay Store Inventory format listings in
fixed-fee categories on international sites. Output only. Will not be returned if false.

@property (nonatomic, retain) NSNumber *intlAutosFixedCat

Discussion

If true, indicates that the category is a fixed-fee category. Use this
information to identify categories are not eligible for eBay Stores Inventory
format listings. You cannot list eBay Store Inventory format listings in
fixed-fee categories on international sites. Output only. Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

keywords

The list of keywords returned.

@property (nonatomic, retain) NSString *keywords

Discussion

The list of keywords returned.

type : NSString, wrapper for primitive string

Declared In

Trading_CategoryType.h

leafCategory

If true, indicates that the category indicated in CategoryID is a leaf category,
in which items may be listed (if the category is not also expired or virtual). Will not be returned if false.

@property (nonatomic, retain) NSNumber *leafCategory

Discussion

If true, indicates that the category indicated in CategoryID is a leaf category,
in which items may be listed (if the category is not also expired or virtual). Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

lsd

“Lot Size Disabled (LSD)” indicates that Item.LotSize is not permitted when you list in this category.
If true, indicates that lot sizes are disabled in the specified category. Will not be returned if false.

@property (nonatomic, retain) NSNumber *lsd

Discussion

“Lot Size Disabled (LSD)” indicates that Item.LotSize is not permitted when you list in this category.
If true, indicates that lot sizes are disabled in the specified category. Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

numOfItems

No longer applicable to any category.

@property (nonatomic, retain) NSNumber *numOfItems

Discussion

No longer applicable to any category.

type : NSNumber, wrapper for primitive int

Declared In

Trading_CategoryType.h

orpa

Indicates whether the category (and its subcategories)
allows or disallows listing with a reserve price,
depending on the prevailing site configuration indicated by
ReservePriceAllowed.
ORPA (override reserve price allowed) indicates when the category
is an exception to the site’s ReservePriceAllowed policy.



If ORPA is true, the category overrides (toggles or reverses) the
site’s ReservePriceAllowed setting. In other words:

- If ReservePriceAllowed is true, reserve price is not allowed in this category.

- If ReservePriceAllowed is false, reserve price is allowed in this category.


If ORPA is not present, there is no override.
That is, the category’s setting is the same as the site’s ReservePriceAllowed setting.


This field will not be returned in the response if false.
This toggling logic is designed to reduce the size of the GetCategories
response by only returning ORPA when the category’s policy is different
from the site’s policy. (If ORPA is true for a category, you can assume
its subcategories inherit the same setting unless otherwise specified.)

@property (nonatomic, retain) NSNumber *orpa

Discussion

Indicates whether the category (and its subcategories)
allows or disallows listing with a reserve price,
depending on the prevailing site configuration indicated by
ReservePriceAllowed.
ORPA (override reserve price allowed) indicates when the category
is an exception to the site’s ReservePriceAllowed policy.



If ORPA is true, the category overrides (toggles or reverses) the
site’s ReservePriceAllowed setting. In other words:

- If ReservePriceAllowed is true, reserve price is not allowed in this category.

- If ReservePriceAllowed is false, reserve price is allowed in this category.


If ORPA is not present, there is no override.
That is, the category’s setting is the same as the site’s ReservePriceAllowed setting.


This field will not be returned in the response if false.
This toggling logic is designed to reduce the size of the GetCategories
response by only returning ORPA when the category’s policy is different
from the site’s policy. (If ORPA is true for a category, you can assume
its subcategories inherit the same setting unless otherwise specified.)

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

orra

Indicates whether the category (and its subcategories) allows
or disallows reducing a listing’s reserve price,
depending on the prevailing site configuration indicated by ReduceReserveAllowed.
ORRA (override reduce reserve allowed) indicates when the category is an exception
to the site’s ReduceReserveAllowed policy.


If ORRA is true, the category overrides (toggles or reverses) the
site’s ReduceReserveAllowed setting. In other words:

- If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category.

- If ReduceReserveAllowed is false (because it is not present in the response), reserve price reduction is allowed in this category.


If ORRA is not present, there is no override. Will not be returned in the response if false.
That is, the category’s setting is the same as the site’s ReduceReserveAllowed setting.



This toggling logic is designed to reduce the size of the GetCategories
response by only returning ORRA when the category’s policy is different
from the site’s policy. (If ORRA is true for a category, you can assume
its subcategories inherit the same setting unless otherwise specified.)

@property (nonatomic, retain) NSNumber *orra

Discussion

Indicates whether the category (and its subcategories) allows
or disallows reducing a listing’s reserve price,
depending on the prevailing site configuration indicated by ReduceReserveAllowed.
ORRA (override reduce reserve allowed) indicates when the category is an exception
to the site’s ReduceReserveAllowed policy.


If ORRA is true, the category overrides (toggles or reverses) the
site’s ReduceReserveAllowed setting. In other words:

- If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category.

- If ReduceReserveAllowed is false (because it is not present in the response), reserve price reduction is allowed in this category.


If ORRA is not present, there is no override. Will not be returned in the response if false.
That is, the category’s setting is the same as the site’s ReduceReserveAllowed setting.



This toggling logic is designed to reduce the size of the GetCategories
response by only returning ORRA when the category’s policy is different
from the site’s policy. (If ORRA is true for a category, you can assume
its subcategories inherit the same setting unless otherwise specified.)

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

productFinderIDs

No longer applicable to any category.

@property (nonatomic, retain) NSMutableArray *productFinderIDs

Discussion

No longer applicable to any category.

entry type : class Trading_ExtendedProductFinderIDType

Declared In

Trading_CategoryType.h

productSearchPageAvailable

No longer applicable to any category.

@property (nonatomic, retain) NSNumber *productSearchPageAvailable

Discussion

No longer applicable to any category.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

sellerGuaranteeEligible

No longer supported.

@property (nonatomic, retain) NSNumber *sellerGuaranteeEligible

Discussion

No longer supported.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h

virtual

If true, indicates the category indicated in CategoryID is a
virtual category, to which items may not be listed. Will not be returned if false.

@property (nonatomic, retain) NSNumber *virtual

Discussion

If true, indicates the category indicated in CategoryID is a
virtual category, to which items may not be listed. Will not be returned if false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CategoryType.h