|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetItemCall
public class GetItemCall
Wrapper class of the GetItem call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
ItemID
- Specifies the ItemID that uniquely identifies the item listing for which
to retrieve the data.
IncludeWatchCount
- The seller can include this field and set its value to true
if that seller wants to see how many prospective bidders/buyers currently have the item added to their Watch Lists. The Watch count is returned in the WatchCount field in the response.
IncludeCrossPromotion
- This field is deprecated.
IncludeItemSpecifics
- If this field is included and set to true
, the call response includes the ItemSpecifics container
if Item Specifics are defined for the listing.true
will also return the UnitInfo container if applicable. The UnitInfo container will provide information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the UnitType and UnitQuantity values and the item's listed price to calculate and display the per-unit price on eBay EU sites.
IncludeTaxTable
- The seller will include this field and set its value to true if the seller wishes to view the defined sales tax rates for the various jurisdictions in the country (generally, states and provinces). Information for each defined sales tax rate will be returned in the TaxTable container in the response.
Even if this field is included and set to true
, no TaxTable container will be returned If no sales tax rates are defined for any tax jurisdiction in the seller's sales tax table.
Sales tax tables are only available for eBay US, eBay Canada, and eBay India. Sales tax rates can be added/modified in My eBay, through the SetTaxTable and GetTaxTable calls of the Trading API, or through the Sales Tax calls of the Account API.
Input 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.
Input 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.
Input 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).
Input property: TransactionID
- A unique identifier for an order line item. 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.
Input property: IncludeItemCompatibilityList
- This field is used to specify whether or not to retrieve Parts
Compatiblity information for a motor part or accessory listing. If this field is included and set to true
, the Item.ItemCompatibilityList container will be returned if a Parts Compatibility list exists for the listing. A Parts Compatibility list is a list of motor vehicles that are compatible with the listed motor part or accesory item. If a Parts Compatibility list does not exist for the listing, this field will have no effect if it is included, regardless of its value (true
or false
).
If this field is included and set to false
or omitted, but a Parts Compatibility list does exist for the listing, the Item.ItemCompatibilityList container will not be returned, but the Item.ItemCompatibilityCount field will be returned, and this field will simply indicate the quantity of motor vehicles that are compatible with the the listed motor part or accesory item.
Parts Compatibility lists are only applicable to motor parts and accessory categories on the sites that support eBay Motors - US, CA, UK, and DE.
Output property: ReturnedItem
- This container consists of detailed information about the retrieved listing. The amount of information that is returned is partially controlled by the filters that are set in the call request.
- Version:
- 1.0
- Author:
- Ron Murphy
Field Summary
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
Constructor Summary
GetItemCall()
Constructor.
GetItemCall(ApiContext apiContext)
Constructor.
Method Summary
java.lang.Boolean
getIncludeCrossPromotion()
Gets the GetItemRequestType.includeCrossPromotion.
java.lang.Boolean
getIncludeItemCompatibilityList()
Gets the GetItemRequestType.includeItemCompatibilityList.
java.lang.Boolean
getIncludeItemSpecifics()
Gets the GetItemRequestType.includeItemSpecifics.
java.lang.Boolean
getIncludeTaxTable()
Gets the GetItemRequestType.includeTaxTable.
java.lang.Boolean
getIncludeWatchCount()
Gets the GetItemRequestType.includeWatchCount.
ItemType
getItem()
Returns item data (title, description, price information, seller information, and so on)
for the specified item ID.
ItemType
getItem(java.lang.String itemID)
Executing the API call.
java.lang.String
getItemID()
Gets the GetItemRequestType.itemID.
ItemType
getReturnedItem()
Valid after executing the API.
java.lang.String
getSKU()
Gets the GetItemRequestType.sKU.
java.lang.String
getTransactionID()
Gets the GetItemRequestType.transactionID.
java.lang.String
getVariationSKU()
Gets the GetItemRequestType.variationSKU.
NameValueListArrayType
getVariationSpecifics()
Gets the GetItemRequestType.variationSpecifics.
void
setIncludeCrossPromotion(java.lang.Boolean includeCrossPromotion)
Sets the GetItemRequestType.includeCrossPromotion.
void
setIncludeItemCompatibilityList(java.lang.Boolean includeItemCompatibilityList)
Sets the GetItemRequestType.includeItemCompatibilityList.
void
setIncludeItemSpecifics(java.lang.Boolean includeItemSpecifics)
Sets the GetItemRequestType.includeItemSpecifics.
void
setIncludeTaxTable(java.lang.Boolean includeTaxTable)
Sets the GetItemRequestType.includeTaxTable.
void
setIncludeWatchCount(java.lang.Boolean includeWatchCount)
Sets the GetItemRequestType.includeWatchCount.
void
setItemID(java.lang.String itemID)
Sets the GetItemRequestType.itemID.
void
setSKU(java.lang.String sKU)
Sets the GetItemRequestType.sKU.
void
setTransactionID(java.lang.String transactionID)
Sets the GetItemRequestType.transactionID.
void
setVariationSKU(java.lang.String variationSKU)
Sets the GetItemRequestType.variationSKU.
void
setVariationSpecifics(NameValueListArrayType variationSpecifics)
Sets the GetItemRequestType.variationSpecifics.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructor Detail
GetItemCall
public GetItemCall()
- Constructor.
GetItemCall
public GetItemCall(ApiContext apiContext)
- Constructor.
- Parameters:
apiContext
- The ApiContext object to be used to make the call.
Method Detail
getItem
public ItemType getItem()
throws ApiException,
SdkException,
java.lang.Exception
- Returns item data (title, description, price information, seller information, and so on)
for the specified item ID.
- Returns:
- The ItemType object.
- Throws:
ApiException
SdkException
java.lang.Exception
getIncludeCrossPromotion
public java.lang.Boolean getIncludeCrossPromotion()
- Gets the GetItemRequestType.includeCrossPromotion.
- Returns:
- Boolean
setIncludeCrossPromotion
public void setIncludeCrossPromotion(java.lang.Boolean includeCrossPromotion)
- Sets the GetItemRequestType.includeCrossPromotion.
- Parameters:
includeCrossPromotion
- Boolean
getIncludeItemCompatibilityList
public java.lang.Boolean getIncludeItemCompatibilityList()
- Gets the GetItemRequestType.includeItemCompatibilityList.
- Returns:
- Boolean
setIncludeItemCompatibilityList
public void setIncludeItemCompatibilityList(java.lang.Boolean includeItemCompatibilityList)
- Sets the GetItemRequestType.includeItemCompatibilityList.
- Parameters:
includeItemCompatibilityList
- Boolean
getIncludeItemSpecifics
public java.lang.Boolean getIncludeItemSpecifics()
- Gets the GetItemRequestType.includeItemSpecifics.
- Returns:
- Boolean
setIncludeItemSpecifics
public void setIncludeItemSpecifics(java.lang.Boolean includeItemSpecifics)
- Sets the GetItemRequestType.includeItemSpecifics.
- Parameters:
includeItemSpecifics
- Boolean
getIncludeTaxTable
public java.lang.Boolean getIncludeTaxTable()
- Gets the GetItemRequestType.includeTaxTable.
- Returns:
- Boolean
setIncludeTaxTable
public void setIncludeTaxTable(java.lang.Boolean includeTaxTable)
- Sets the GetItemRequestType.includeTaxTable.
- Parameters:
includeTaxTable
- Boolean
getIncludeWatchCount
public java.lang.Boolean getIncludeWatchCount()
- Gets the GetItemRequestType.includeWatchCount.
- Returns:
- Boolean
setIncludeWatchCount
public void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
- Sets the GetItemRequestType.includeWatchCount.
- Parameters:
includeWatchCount
- Boolean
getItemID
public java.lang.String getItemID()
- Gets the GetItemRequestType.itemID.
- Returns:
- String
setItemID
public void setItemID(java.lang.String itemID)
- Sets the GetItemRequestType.itemID.
- Parameters:
itemID
- String
getSKU
public java.lang.String getSKU()
- Gets the GetItemRequestType.sKU.
- Returns:
- String
setSKU
public void setSKU(java.lang.String sKU)
- Sets the GetItemRequestType.sKU.
- Parameters:
sKU
- String
getTransactionID
public java.lang.String getTransactionID()
- Gets the GetItemRequestType.transactionID.
- Returns:
- String
setTransactionID
public void setTransactionID(java.lang.String transactionID)
- Sets the GetItemRequestType.transactionID.
- Parameters:
transactionID
- String
getVariationSKU
public java.lang.String getVariationSKU()
- Gets the GetItemRequestType.variationSKU.
- Returns:
- String
setVariationSKU
public void setVariationSKU(java.lang.String variationSKU)
- Sets the GetItemRequestType.variationSKU.
- Parameters:
variationSKU
- String
getVariationSpecifics
public NameValueListArrayType getVariationSpecifics()
- Gets the GetItemRequestType.variationSpecifics.
- Returns:
- NameValueListArrayType
setVariationSpecifics
public void setVariationSpecifics(NameValueListArrayType variationSpecifics)
- Sets the GetItemRequestType.variationSpecifics.
- Parameters:
variationSpecifics
- NameValueListArrayType
getItem
public ItemType getItem(java.lang.String itemID)
throws ApiException,
SdkException,
java.lang.Exception
- Executing the API call.
- Parameters:
itemID
- eBay itemID that uniquely identifies the item.
- Returns:
- The ItemType object if the call succeeded.
- Throws:
ApiException
SdkException
java.lang.Exception
getReturnedItem
public ItemType getReturnedItem()
- Valid after executing the API.
Gets the returned GetItemResponseType.returnedItem.
- Returns:
- ItemType
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Changes since
the last release
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.