Changes since
the last release

com.ebay.sdk.call
Class GetItemCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetItemCall

public class GetItemCall
extends ApiCall

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.


Input property: 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.
Input 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.
Input property: IncludeCrossPromotion - This field is deprecated.
Input 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.

Including this field set to true also returns the UnitInfo node, which enables European Union sellers to provide the required price-per-unit information so buyers can accurately compare prices for certain types of products.
Input 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.
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 (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.
Input 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 Motors (US) site (site ID 100) only.
Output property: ReturnedItem - ItemType object that contains the data for the specified item.

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
 Boolean getIncludeCrossPromotion()
          Gets the GetItemRequestType.includeCrossPromotion.
 Boolean getIncludeItemCompatibilityList()
          Gets the GetItemRequestType.includeItemCompatibilityList.
 Boolean getIncludeItemSpecifics()
          Gets the GetItemRequestType.includeItemSpecifics.
 Boolean getIncludeTaxTable()
          Gets the GetItemRequestType.includeTaxTable.
 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(String itemID)
          Executing the API call.
 String getItemID()
          Gets the GetItemRequestType.itemID.
 ItemType getReturnedItem()
          Valid after executing the API.
 String getSKU()
          Gets the GetItemRequestType.sKU.
 String getTransactionID()
          Gets the GetItemRequestType.transactionID.
 String getVariationSKU()
          Gets the GetItemRequestType.variationSKU.
 NameValueListArrayType getVariationSpecifics()
          Gets the GetItemRequestType.variationSpecifics.
 void setIncludeCrossPromotion(Boolean includeCrossPromotion)
          Sets the GetItemRequestType.includeCrossPromotion.
 void setIncludeItemCompatibilityList(Boolean includeItemCompatibilityList)
          Sets the GetItemRequestType.includeItemCompatibilityList.
 void setIncludeItemSpecifics(Boolean includeItemSpecifics)
          Sets the GetItemRequestType.includeItemSpecifics.
 void setIncludeTaxTable(Boolean includeTaxTable)
          Sets the GetItemRequestType.includeTaxTable.
 void setIncludeWatchCount(Boolean includeWatchCount)
          Sets the GetItemRequestType.includeWatchCount.
 void setItemID(String itemID)
          Sets the GetItemRequestType.itemID.
 void setSKU(String sKU)
          Sets the GetItemRequestType.sKU.
 void setTransactionID(String transactionID)
          Sets the GetItemRequestType.transactionID.
 void setVariationSKU(String variationSKU)
          Sets the GetItemRequestType.variationSKU.
 void setVariationSpecifics(NameValueListArrayType variationSpecifics)
          Sets the GetItemRequestType.variationSpecifics.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
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,
                        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
Exception

getIncludeCrossPromotion

public Boolean getIncludeCrossPromotion()
Gets the GetItemRequestType.includeCrossPromotion.

Returns:
Boolean

setIncludeCrossPromotion

public void setIncludeCrossPromotion(Boolean includeCrossPromotion)
Sets the GetItemRequestType.includeCrossPromotion.

Parameters:
includeCrossPromotion - Boolean

getIncludeItemCompatibilityList

public Boolean getIncludeItemCompatibilityList()
Gets the GetItemRequestType.includeItemCompatibilityList.

Returns:
Boolean

setIncludeItemCompatibilityList

public void setIncludeItemCompatibilityList(Boolean includeItemCompatibilityList)
Sets the GetItemRequestType.includeItemCompatibilityList.

Parameters:
includeItemCompatibilityList - Boolean

getIncludeItemSpecifics

public Boolean getIncludeItemSpecifics()
Gets the GetItemRequestType.includeItemSpecifics.

Returns:
Boolean

setIncludeItemSpecifics

public void setIncludeItemSpecifics(Boolean includeItemSpecifics)
Sets the GetItemRequestType.includeItemSpecifics.

Parameters:
includeItemSpecifics - Boolean

getIncludeTaxTable

public Boolean getIncludeTaxTable()
Gets the GetItemRequestType.includeTaxTable.

Returns:
Boolean

setIncludeTaxTable

public void setIncludeTaxTable(Boolean includeTaxTable)
Sets the GetItemRequestType.includeTaxTable.

Parameters:
includeTaxTable - Boolean

getIncludeWatchCount

public Boolean getIncludeWatchCount()
Gets the GetItemRequestType.includeWatchCount.

Returns:
Boolean

setIncludeWatchCount

public void setIncludeWatchCount(Boolean includeWatchCount)
Sets the GetItemRequestType.includeWatchCount.

Parameters:
includeWatchCount - Boolean

getItemID

public String getItemID()
Gets the GetItemRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the GetItemRequestType.itemID.

Parameters:
itemID - String

getSKU

public String getSKU()
Gets the GetItemRequestType.sKU.

Returns:
String

setSKU

public void setSKU(String sKU)
Sets the GetItemRequestType.sKU.

Parameters:
sKU - String

getTransactionID

public String getTransactionID()
Gets the GetItemRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(String transactionID)
Sets the GetItemRequestType.transactionID.

Parameters:
transactionID - String

getVariationSKU

public String getVariationSKU()
Gets the GetItemRequestType.variationSKU.

Returns:
String

setVariationSKU

public void setVariationSKU(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(String itemID)
                 throws ApiException,
                        SdkException,
                        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
Exception

getReturnedItem

public ItemType getReturnedItem()
Valid after executing the API. Gets the returned GetItemResponseType.returnedItem.

Returns:
ItemType

Changes since
the last release

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.