Changes since
the last release

com.ebay.sdk.call
Class GetBestOffersCall

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

public class GetBestOffersCall
extends ApiCall

Wrapper class of the GetBestOffers 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 - The unique identifier of an eBay listing. If an ItemID is used by itself in the call request, all Best Offers in all states are retrieved for this listing. However, the seller can also combine ItemID and a BestOfferStatus value if that seller only wants to see Best Offers in a specific state. If a BestOfferID field is included in the call request, any ItemID value will be ignored since eBay will only search for and return the Best Offer identified in the BestOfferID field.
Input property: BestOfferID - The unique identifier of a Best Offer. An identifier for a Best Offer is automatically created by eBay once a prospective buyer makes a Best Offer on a Best Offer-enabled listing. If a BestOfferID value is supplied in the call request, any ItemID or BestOfferStatus values will be ignored. Only the Best Offer identified by the BestOfferID value will be returned.
Input property: BestOfferStatus - This field can be used if the seller wants to retrieve Best Offers in a specific state. The typical use case for this field is when the seller wants to retrieve Best Offers in all states for a specific listing. In fact, the All value can only be used if an ItemID value is also supplied in the call request. If a BestOfferID field is included in the call request, any BestOfferStatus value will be ignored since eBay will only search for and return the Best Offer identified in the BestOfferID field.
Input property: Pagination - This container can be used if the seller is expecting that the GetBestOffers call will retrieve a large number of results, so that seller wishes to view just a subset (one page of multiple pages) of those results at a time. See this container's child fields for more information on how pagination is used.
Output property: ReturnedBestOffers - All Best Offers for the item according to the filter or Best Offer ID (or both) used in the input. The buyer and seller messages are returned only if the detail level is defined. Includes the buyer and seller message only if the ReturnAll detail level is used. Only returned if Best Offers have been made.
Output property: ReturnedItem - This container consists of several details about the listing for which a Best Offer has been made, including the Item ID, the current price of the item (not the Best Offer price), and the time that the listing is scheduled to end.
Output property: ReturnedItemBestOffersArray - A collection of details about the Best Offers received for a specific item. Empty if there are no Best Offers.
Output property: ReturnedPageNumber - This integer value indicates the current page number of Best Offers that is currently being shown. This value will be the same value passed into the Pagination.PageNumber field in the request.
Output property: ReturnedPaginationResult - Provides information about the data returned, including the number of pages and the number of entries.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetBestOffersCall()
          Constructor.
GetBestOffersCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getBestOfferID()
          Gets the GetBestOffersRequestType.bestOfferID.
 void getBestOffers()
          This is the base request type of the GetBestOffers call.
 BestOfferStatusCodeType getBestOfferStatus()
          Gets the GetBestOffersRequestType.bestOfferStatus.
 java.lang.String getItemID()
          Gets the GetBestOffersRequestType.itemID.
 PaginationType getPagination()
          Gets the GetBestOffersRequestType.pagination.
 BestOfferType[] getReturnedBestOffers()
          Valid after executing the API.
 ItemType getReturnedItem()
          Valid after executing the API.
 ItemBestOffersArrayType getReturnedItemBestOffersArray()
          Valid after executing the API.
 java.lang.Integer getReturnedPageNumber()
          Valid after executing the API.
 PaginationResultType getReturnedPaginationResult()
          Valid after executing the API.
 void setBestOfferID(java.lang.String bestOfferID)
          Sets the GetBestOffersRequestType.bestOfferID.
 void setBestOfferStatus(BestOfferStatusCodeType bestOfferStatus)
          Sets the GetBestOffersRequestType.bestOfferStatus.
 void setItemID(java.lang.String itemID)
          Sets the GetBestOffersRequestType.itemID.
 void setPagination(PaginationType pagination)
          Sets the GetBestOffersRequestType.pagination.
 
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, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, 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

GetBestOffersCall

public GetBestOffersCall()
Constructor.


GetBestOffersCall

public GetBestOffersCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getBestOffers

public void getBestOffers()
                   throws ApiException,
                          SdkException,
                          java.lang.Exception
This is the base request type of the GetBestOffers call. Depending on the input parameters that are used, this call can be used by a seller to retrieve all active Best Offers, all Best Offers on a specific listing, a specific Best Offer for a specific listing, or Best Offers in a specific state.

Note: The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing.

Throws:
ApiException
SdkException
java.lang.Exception

getBestOfferID

public java.lang.String getBestOfferID()
Gets the GetBestOffersRequestType.bestOfferID.

Returns:
String

setBestOfferID

public void setBestOfferID(java.lang.String bestOfferID)
Sets the GetBestOffersRequestType.bestOfferID.

Parameters:
bestOfferID - String

getBestOfferStatus

public BestOfferStatusCodeType getBestOfferStatus()
Gets the GetBestOffersRequestType.bestOfferStatus.

Returns:
BestOfferStatusCodeType

setBestOfferStatus

public void setBestOfferStatus(BestOfferStatusCodeType bestOfferStatus)
Sets the GetBestOffersRequestType.bestOfferStatus.

Parameters:
bestOfferStatus - BestOfferStatusCodeType

getItemID

public java.lang.String getItemID()
Gets the GetBestOffersRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetBestOffersRequestType.itemID.

Parameters:
itemID - String

getPagination

public PaginationType getPagination()
Gets the GetBestOffersRequestType.pagination.

Returns:
PaginationType

setPagination

public void setPagination(PaginationType pagination)
Sets the GetBestOffersRequestType.pagination.

Parameters:
pagination - PaginationType

getReturnedBestOffers

public BestOfferType[] getReturnedBestOffers()
Valid after executing the API. Gets the returned GetBestOffersResponseType.returnedBestOffers.

Returns:
BestOfferType[]

getReturnedItem

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

Returns:
ItemType

getReturnedItemBestOffersArray

public ItemBestOffersArrayType getReturnedItemBestOffersArray()
Valid after executing the API. Gets the returned GetBestOffersResponseType.returnedItemBestOffersArray.

Returns:
ItemBestOffersArrayType

getReturnedPageNumber

public java.lang.Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetBestOffersResponseType.returnedPageNumber.

Returns:
Integer

getReturnedPaginationResult

public PaginationResultType getReturnedPaginationResult()
Valid after executing the API. Gets the returned GetBestOffersResponseType.returnedPaginationResult.

Returns:
PaginationResultType

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.