Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetItemRequestType.h
Trading_GetItemRequestType.m

Overview

Returns item data such as title, description, price information, seller information, and so on, for the specified ItemID.  Also for Half.com.

@ingroup EBayAPIInterface

Tasks

  •   itemID

    Specifies the ItemID that uniquely identifies the item listing for which
    to retrieve the data.



    ItemID is a required input in most cases. SKU can be used instead in certain
    cases (see the description of SKU). If both ItemID and SKU are specified for
    items where the inventory tracking method is ItemID, ItemID takes precedence.

    property
  •   includeWatchCount

    Indicates if the caller wants to include watch count for that item in the
    response. You must be the seller of the item to retrieve the watch count.

    property
  •   includeCrossPromotion

    This flag should no longer be used as eBay Store Cross Promotions are no
    longer supported by the Trading API.



    Specifies whether or not to include cross-promotion information for
    the item in the call response.

    property
  •   includeItemSpecifics

    If true, the response returns the ItemSpecifics node
    (if the listing has custom Item Specifics).



    Item Specifics are well-known aspects of items in a given
    category. For example, items in a washer and dryer category
    might have an aspect like Type=Top-Loading; whereas
    items in a jewelry category might have an aspect like
    Gemstone=Amber.



    (This does not cause the response to include ID-based
    attributes. To also retrieve ID-based attributes,
    pass DetailLevel in the request with the value
    ItemReturnAttributes or ReturnAll.)

    property
  •   includeTaxTable

    If true, an associated tax table is returned in the response.
    If no tax table is associated with the item, then no
    tax table is returned, even if IncludeTaxTable is set to true.

    property
  •   sku

    Retrieves an item that was listed by the user identified
    in AuthToken and that is being tracked by this SKU.



    A SKU (stock keeping unit) is an identifier defined by a seller.
    Some sellers use SKUs to track complex flows of products
    and information on the client side.
    eBay preserves the SKU on the item, enabling you
    to obtain it before and after an order line item is created.
    (SKU is recommended as an alternative to
    ApplicationData.)



    In GetItem, SKU can only be used to retrieve one of your
    own items, where you listed the item by using AddFixedPriceItem
    or RelistFixedPriceItem,
    and you set Item.InventoryTrackingMethod to SKU at
    the time the item was listed. (These criteria are necessary to
    uniquely identify the listing by a SKU.)



    Either ItemID or SKU is required in the request.
    If both are passed, they must refer to the same item,
    and that item must have InventoryTrackingMethod set to SKU.

    property
  •   variationSKU

    Variation-level SKU that uniquely identifes a Variation within
    the listing identified by ItemID. Only applicable when the
    seller listed the item with Variation-level SKU (Variation.SKU)
    values. Retrieves all the usual Item fields, but limits the
    Variations content to the specified Variation.
    If not specified, the response includes all Variations.

    property
  •   variationSpecifics

    Name-value pairs that identify one or more Variations within the
    listing identified by ItemID. Only applicable when the seller
    listed the item with Variations. Retrieves all the usual Item
    fields, but limits the Variations content to the specified
    Variation(s). If the specified pairs do not match any Variation,
    eBay returns all Variations.



    To retrieve only one variation, specify the full set of
    name/value pairs that match all the name-value pairs of one
    Variation.



    To retrieve multiple variations (using a wildcard),
    specify one or more name/value pairs that partially match the
    desired variations. For example, if the listing contains
    Variations for shirts in different colors and sizes, specify
    Color as Red (and no other name/value pairs) to retrieve
    all the red shirts in all sizes (but no other colors).

    property
  •   transactionID

    A unique identifier for an order line item (transaction). An order line item is created
    when a buyer commits to purchasing an item.



    Since you can change active multiple-quantity fixed-price listings even
    after one of the items has been purchased, the TransactionID is
    associated with a snapshot of the item data at the time of the purchase.



    After one item in a multi-quantity listing has been sold, sellers can not
    change the values in the Title, Primary Category, Secondary Category,
    Listing Duration, and Listing Type fields. However, all other fields are
    editable.



    Specifying a TransactionID in the GetItem request allows you to retrieve
    a snapshot of the listing as it was when the order line item was created.

    property
  •   includeItemCompatibilityList

    This field is used to specify whether or not to retrieve Parts
    Compatiblity information. If true, any compatible applications associated
    with the item will be returned in the response (
    Item.ItemCompatibilityList
    ). If no compatible applications have
    been specified for the item, no item compatibilities will be returned.



    If false or not specified, the response will return a compatibility count
    (ItemCompatibilityCount) when parts
    compatibilities have been specified for the item.



    Parts Compatibility is supported in limited Parts & Accessories
    categories for the eBay US Motors (site ID 100) and eBay Germany (site ID
    77) sites only.

    property

Properties

includeCrossPromotion

This flag should no longer be used as eBay Store Cross Promotions are no
longer supported by the Trading API.



Specifies whether or not to include cross-promotion information for
the item in the call response.

@property (nonatomic, retain) NSNumber *includeCrossPromotion

Discussion

This flag should no longer be used as eBay Store Cross Promotions are no
longer supported by the Trading API.



Specifies whether or not to include cross-promotion information for
the item in the call response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetItemRequestType.h

includeItemCompatibilityList

This field is used to specify whether or not to retrieve Parts
Compatiblity information. If true, any compatible applications associated
with the item will be returned in the response (
Item.ItemCompatibilityList
). If no compatible applications have
been specified for the item, no item compatibilities will be returned.



If false or not specified, the response will return a compatibility count
(ItemCompatibilityCount) when parts
compatibilities have been specified for the item.



Parts Compatibility is supported in limited Parts & Accessories
categories for the eBay US Motors (site ID 100) and eBay Germany (site ID
77) sites only.

@property (nonatomic, retain) NSNumber *includeItemCompatibilityList

Discussion

This field is used to specify whether or not to retrieve Parts
Compatiblity information. If true, any compatible applications associated
with the item will be returned in the response (
Item.ItemCompatibilityList
). If no compatible applications have
been specified for the item, no item compatibilities will be returned.



If false or not specified, the response will return a compatibility count
(ItemCompatibilityCount) when parts
compatibilities have been specified for the item.



Parts Compatibility is supported in limited Parts & Accessories
categories for the eBay US Motors (site ID 100) and eBay Germany (site ID
77) sites only.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetItemRequestType.h

includeItemSpecifics

If true, the response returns the ItemSpecifics node
(if the listing has custom Item Specifics).



Item Specifics are well-known aspects of items in a given
category. For example, items in a washer and dryer category
might have an aspect like Type=Top-Loading; whereas
items in a jewelry category might have an aspect like
Gemstone=Amber.



(This does not cause the response to include ID-based
attributes. To also retrieve ID-based attributes,
pass DetailLevel in the request with the value
ItemReturnAttributes or ReturnAll.)

@property (nonatomic, retain) NSNumber *includeItemSpecifics

Discussion

If true, the response returns the ItemSpecifics node
(if the listing has custom Item Specifics).



Item Specifics are well-known aspects of items in a given
category. For example, items in a washer and dryer category
might have an aspect like Type=Top-Loading; whereas
items in a jewelry category might have an aspect like
Gemstone=Amber.



(This does not cause the response to include ID-based
attributes. To also retrieve ID-based attributes,
pass DetailLevel in the request with the value
ItemReturnAttributes or ReturnAll.)

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetItemRequestType.h

includeTaxTable

If true, an associated tax table is returned in the response.
If no tax table is associated with the item, then no
tax table is returned, even if IncludeTaxTable is set to true.

@property (nonatomic, retain) NSNumber *includeTaxTable

Discussion

If true, an associated tax table is returned in the response.
If no tax table is associated with the item, then no
tax table is returned, even if IncludeTaxTable is set to true.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetItemRequestType.h

includeWatchCount

Indicates if the caller wants to include watch count for that item in the
response. You must be the seller of the item to retrieve the watch count.

@property (nonatomic, retain) NSNumber *includeWatchCount

Discussion

Indicates if the caller wants to include watch count for that item in the
response. You must be the seller of the item to retrieve the watch count.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetItemRequestType.h

itemID

Specifies the ItemID that uniquely identifies the item listing for which
to retrieve the data.



ItemID is a required input in most cases. SKU can be used instead in certain
cases (see the description of SKU). If both ItemID and SKU are specified for
items where the inventory tracking method is ItemID, ItemID takes precedence.

@property (nonatomic, retain) NSString *itemID

Discussion

Specifies the ItemID that uniquely identifies the item listing for which
to retrieve the data.



ItemID is a required input in most cases. SKU can be used instead in certain
cases (see the description of SKU). If both ItemID and SKU are specified for
items where the inventory tracking method is ItemID, ItemID takes precedence.

type : NSString, wrapper for primitive string

Declared In

Trading_GetItemRequestType.h

sku

Retrieves an item that was listed by the user identified
in AuthToken and that is being tracked by this SKU.



A SKU (stock keeping unit) is an identifier defined by a seller.
Some sellers use SKUs to track complex flows of products
and information on the client side.
eBay preserves the SKU on the item, enabling you
to obtain it before and after an order line item is created.
(SKU is recommended as an alternative to
ApplicationData.)



In GetItem, SKU can only be used to retrieve one of your
own items, where you listed the item by using AddFixedPriceItem
or RelistFixedPriceItem,
and you set Item.InventoryTrackingMethod to SKU at
the time the item was listed. (These criteria are necessary to
uniquely identify the listing by a SKU.)



Either ItemID or SKU is required in the request.
If both are passed, they must refer to the same item,
and that item must have InventoryTrackingMethod set to SKU.

@property (nonatomic, retain) NSString *sku

Discussion

Retrieves an item that was listed by the user identified
in AuthToken and that is being tracked by this SKU.



A SKU (stock keeping unit) is an identifier defined by a seller.
Some sellers use SKUs to track complex flows of products
and information on the client side.
eBay preserves the SKU on the item, enabling you
to obtain it before and after an order line item is created.
(SKU is recommended as an alternative to
ApplicationData.)



In GetItem, SKU can only be used to retrieve one of your
own items, where you listed the item by using AddFixedPriceItem
or RelistFixedPriceItem,
and you set Item.InventoryTrackingMethod to SKU at
the time the item was listed. (These criteria are necessary to
uniquely identify the listing by a SKU.)



Either ItemID or SKU is required in the request.
If both are passed, they must refer to the same item,
and that item must have InventoryTrackingMethod set to SKU.

type : NSString, wrapper for primitive string

Declared In

Trading_GetItemRequestType.h

transactionID

A unique identifier for an order line item (transaction). An order line item is created
when a buyer commits to purchasing an item.



Since you can change active multiple-quantity fixed-price listings even
after one of the items has been purchased, the TransactionID is
associated with a snapshot of the item data at the time of the purchase.



After one item in a multi-quantity listing has been sold, sellers can not
change the values in the Title, Primary Category, Secondary Category,
Listing Duration, and Listing Type fields. However, all other fields are
editable.



Specifying a TransactionID in the GetItem request allows you to retrieve
a snapshot of the listing as it was when the order line item was created.

@property (nonatomic, retain) NSString *transactionID

Discussion

A unique identifier for an order line item (transaction). An order line item is created
when a buyer commits to purchasing an item.



Since you can change active multiple-quantity fixed-price listings even
after one of the items has been purchased, the TransactionID is
associated with a snapshot of the item data at the time of the purchase.



After one item in a multi-quantity listing has been sold, sellers can not
change the values in the Title, Primary Category, Secondary Category,
Listing Duration, and Listing Type fields. However, all other fields are
editable.



Specifying a TransactionID in the GetItem request allows you to retrieve
a snapshot of the listing as it was when the order line item was created.

type : NSString, wrapper for primitive string

Declared In

Trading_GetItemRequestType.h

variationSKU

Variation-level SKU that uniquely identifes a Variation within
the listing identified by ItemID. Only applicable when the
seller listed the item with Variation-level SKU (Variation.SKU)
values. Retrieves all the usual Item fields, but limits the
Variations content to the specified Variation.
If not specified, the response includes all Variations.

@property (nonatomic, retain) NSString *variationSKU

Discussion

Variation-level SKU that uniquely identifes a Variation within
the listing identified by ItemID. Only applicable when the
seller listed the item with Variation-level SKU (Variation.SKU)
values. Retrieves all the usual Item fields, but limits the
Variations content to the specified Variation.
If not specified, the response includes all Variations.

type : NSString, wrapper for primitive string

Declared In

Trading_GetItemRequestType.h

variationSpecifics

Name-value pairs that identify one or more Variations within the
listing identified by ItemID. Only applicable when the seller
listed the item with Variations. Retrieves all the usual Item
fields, but limits the Variations content to the specified
Variation(s). If the specified pairs do not match any Variation,
eBay returns all Variations.



To retrieve only one variation, specify the full set of
name/value pairs that match all the name-value pairs of one
Variation.



To retrieve multiple variations (using a wildcard),
specify one or more name/value pairs that partially match the
desired variations. For example, if the listing contains
Variations for shirts in different colors and sizes, specify
Color as Red (and no other name/value pairs) to retrieve
all the red shirts in all sizes (but no other colors).

@property (nonatomic, retain) Trading_NameValueListArrayType *variationSpecifics

Discussion

Name-value pairs that identify one or more Variations within the
listing identified by ItemID. Only applicable when the seller
listed the item with Variations. Retrieves all the usual Item
fields, but limits the Variations content to the specified
Variation(s). If the specified pairs do not match any Variation,
eBay returns all Variations.



To retrieve only one variation, specify the full set of
name/value pairs that match all the name-value pairs of one
Variation.



To retrieve multiple variations (using a wildcard),
specify one or more name/value pairs that partially match the
desired variations. For example, if the listing contains
Variations for shirts in different colors and sizes, specify
Color as Red (and no other name/value pairs) to retrieve
all the red shirts in all sizes (but no other colors).

type : class Trading_NameValueListArrayType

Declared In

Trading_GetItemRequestType.h