Shopping_GetSingleItemRequestType Class Reference
Inherits from | Shopping_AbstractRequestType : NSObject |
Declared in | Shopping_GetSingleItemRequestType.h Shopping_GetSingleItemRequestType.m |
Overview
Retrieves publicly available data for a single listing.
Use this call to retrieve most of the information that is visible
on a listing’s View Item page on the eBay Web site,
such as title, description, prices, basic seller and bidder information,
and other details about the listing.Also returns basic
shipping costs. For more shipping details, use GetShippingCosts.
@ingroup ShoppingInterface
Tasks
-
itemID
The item ID that uniquely identifies the item listing
for which to retrieve the data.
You can determine an item’s ID by calling findItemsAdvanced (<a
href=“http://www.developer.ebay.com/DevZone/finding/CallRef/index.html”
propertyFinding API) or from the eBay Web site.
-
variationSKU
Variation-level SKU that uniquely identifes a variation within
property
the listing identified by ItemID. Only applicable when the
seller included 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. -
variationSpecifics
Name-value pairs that identify one or more variations within the
property
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). -
includeSelector
Defines standard subsets of fields to return within the
response.
If you don’t specify this field, the call returns a default
set of fields (see the “Detail Controls” link below). If you specify this field, the additional
fields you retrieve can affect the call’s response time
(performance).
Applicable values:• Details
Include most available fields in the
response (except fields that significantly affect the call's
performance).• Description
Include the Description field in the response. (This can affect the call’s performance.)
• TextDescription
Include the text Description(no html tag) field in the response. (This can affect the call’s performance.)
• ShippingCosts
Include basic shipping costs in the
response. (Use GetShippingCosts to retrieve more
details.)• ItemSpecifics
Include ItemSpecifics in the response.
• Variations
Include Variations in the response.
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See “GetSingleItem Samples"
for an example of how to use this field.
See "Detail Controls” for a complete list of
fields that can be returned for each selector.
Properties
includeSelector
Defines standard subsets of fields to return within the
response.
If you don’t specify this field, the call returns a default
set of fields (see the “Detail Controls” link below). If you specify this field, the additional
fields you retrieve can affect the call’s response time
(performance).
Applicable values:
• Details
Include most available fields in the
response (except fields that significantly affect the call's
performance).
• Description
Include the Description field in the response. (This can affect the call’s performance.)
• TextDescription
Include the text Description(no html tag) field in the response. (This can affect the call’s performance.)
• ShippingCosts
Include basic shipping costs in the
response. (Use GetShippingCosts to retrieve more
details.)
• ItemSpecifics
Include ItemSpecifics in the response.
• Variations
Include Variations in the response.
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See “GetSingleItem Samples"
for an example of how to use this field.
See "Detail Controls” for a complete list of
fields that can be returned for each selector.
@property (nonatomic, retain) NSString *includeSelector
Discussion
Defines standard subsets of fields to return within the
response.
If you don’t specify this field, the call returns a default
set of fields (see the “Detail Controls” link below). If you specify this field, the additional
fields you retrieve can affect the call’s response time
(performance).
Applicable values:
• Details
Include most available fields in the
response (except fields that significantly affect the call's
performance).
• Description
Include the Description field in the response. (This can affect the call’s performance.)
• TextDescription
Include the text Description(no html tag) field in the response. (This can affect the call’s performance.)
• ShippingCosts
Include basic shipping costs in the
response. (Use GetShippingCosts to retrieve more
details.)
• ItemSpecifics
Include ItemSpecifics in the response.
• Variations
Include Variations in the response.
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See “GetSingleItem Samples"
for an example of how to use this field.
See "Detail Controls” for a complete list of
fields that can be returned for each selector.
type : NSString, wrapper for primitive string
Declared In
Shopping_GetSingleItemRequestType.h
itemID
The item ID that uniquely identifies the item listing
for which to retrieve the data.
You can determine an item’s ID by calling findItemsAdvanced (<a
href=“http://www.developer.ebay.com/DevZone/finding/CallRef/index.html”
Finding API) or from the eBay Web site.
@property (nonatomic, retain) NSString *itemID
Discussion
The item ID that uniquely identifies the item listing
for which to retrieve the data.
You can determine an item’s ID by calling findItemsAdvanced (<a
href=“http://www.developer.ebay.com/DevZone/finding/CallRef/index.html”
Finding API) or from the eBay Web site.
type : NSString, wrapper for primitive string
Declared In
Shopping_GetSingleItemRequestType.h
variationSKU
Variation-level SKU that uniquely identifes a variation within
the listing identified by ItemID. Only applicable when the
seller included 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 included 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
Shopping_GetSingleItemRequestType.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) Shopping_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 Shopping_NameValueListArrayType
Declared In
Shopping_GetSingleItemRequestType.h