Changes since
the last release

com.ebay.sdk.call
Class GetSellerEventsCall

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

public class GetSellerEventsCall
extends ApiCall

Wrapper class of the GetSellerEvents 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: UserID - eBay user ID for the seller whose events are to be returned. If not specified, retrieves events for the user identified by the authentication token passed in the request.

Note: Since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about their own listings and bidders who know the user IDs of their sellers will be able to make this API call successfully.
Input property: StartTimeFilter - Helper wrapper to set GetSellerEventsRequestType StartTimeFrom, StartTimeTo: TimeFrom sets GetSellerEventsRequestType.StartTimeFrom: Describes the earliest (oldest) time to use in a time range filter based on item start time. Must be specified if StartTimeTo is specified.

Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified.

If you do not specify the corresponding To filter, it is set to the time you make the call.

For better results, the time period you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.

Include a 2-minute, overlapping buffer between requests. For example, if StartTimeTo was 6:58 in a prior request, the current request should use 6:56 in StartTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). TimeTo sets GetSellerEventsRequestType.StartTimeTo: Describes the latest (most recent) date to use in a time range filter based on item start time. If you specify the corresponding From filter, but you do not include StartTimeTo, the StartTimeTo is set to the time you make the call.
Input property: EndTimeFilter - Helper wrapper to set GetSellerEventsRequestType EndTimeFrom, EndTimeTo: TimeFrom sets GetSellerEventsRequestType.EndTimeFrom: Describes the earliest (oldest) date to use in a time range filter based on item end time. Must be specified if EndTimeTo is specified.

Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the corresponding To filter, it is set to the time you make the call.

For better results, the time range you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.

Include a 2-minute, overlapping buffer between requests. For example, if EndTimeTo was 6:58 in a prior request, the current request should use 6:56 in EndTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). TimeTo sets GetSellerEventsRequestType.EndTimeTo: Describes the latest (most recent) date to use in a time range filter based on item end time.

If you specify the corresponding From filter, but you do not include EndTimeTo, then EndTimeTo is set to the time you make the call.
Input property: ModTimeFilter - Helper wrapper to set GetSellerEventsRequestType ModTimeFrom, ModTimeTo: TimeFrom sets GetSellerEventsRequestType.ModTimeFrom: Describes the earliest (oldest) date to use in a time range filter based on item modification time. Must be specified if ModTimeTo is specified. Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the corresponding To filter, it is set to the time you make the call.

Include a 2-minute, overlapping buffer between requests. For example, if ModTimeTo was 6:58 in a prior request, the current request should use 6:56 in ModTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).

For better results, the time range you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.

If an unexpected item is returned (including an old item or an unchanged active item), please ignore the item. Although a maintenance process may have triggered a change in the modification time, item characteristics are unchanged. TimeTo sets GetSellerEventsRequestType.ModTimeTo: Describes the latest (most recent) date and time to use in a time range filter based on the time an item's record was modified. If you specify the corresponding From filter, but you do not include ModTimeTo , then ModTimeTo is set to the time you make the call. Include a 2-minute buffer between the current time and the ModTimeTo filter.
Input property: IncludeNewItem - If true, response includes only items that have been modified within the ModTime range. If false, response includes all items.
Input property: 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 an item added to their Watch Lists. The Watch count is returned in the WatchCount field for each item in the response.
Input property: IncludeVariationSpecifics - Specifies whether to force the response to include variation specifics for multiple-variation listings.

If false (or not specified), eBay keeps the response as small as possible by not returning Variation.VariationSpecifics. It only returns Variation.SKU as an identifier (along with the variation price and other selling details). If the variation has no SKU, then Variation.VariationSpecifics is returned as the variation's unique identifier.

If true, Variation.VariationSpecifics is returned. (Variation.SKU is also returned, if the variation has a SKU.) This may be useful for applications that don't track variations by SKU.

Ignored when HideVariations is set to true.

Note: If the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once. For example, you may need to use shorter time ranges in the StartTimeFrom, EndTimeFrom, or ModTimeFrom filters.
Input property: HideVariations - Specifies whether to force the response to hide variation details for multiple-variation listings.

If false (or not specified), eBay returns variation details (if any). In this case, the amount of detail can be controlled by using IncludeVariationSpecifics.

If true, variation details are not returned (and IncludeVariationSpecifics has no effect). This may be useful for applications that use other calls, notifications, alerts, or reports to track price and quantity details.
Output property: TimeTo - Indicates the latest (most recent) date for any date-based filtering specified as input. Specifically, this field contains the value you specified in the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time.
Output property: ReturnedSellerEvents - Collection of items whose last modified time matches the filters specified in the request. Returns empty if no items were modified within the time range of the request.

If 1 to 2999 items are returned, then the results are complete. If 3000 or more items are returned, it usually means additional items exist within the time range you requested, but they were not all returned.

To retrieve complete results, use a smaller time range in the request so that fewer than 3000 are returned per response.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSellerEventsCall()
          Constructor.
GetSellerEventsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 TimeFilter getEndTimeFilter()
          Gets the GetSellerEventsRequestType.endTimeFilter.
 java.lang.Boolean getHideVariations()
          Gets the GetSellerEventsRequestType.hideVariations.
 boolean getIncludeNewItem()
          Gets the GetSellerEventsRequestType.includeNewItem.
 java.lang.Boolean getIncludeVariationSpecifics()
          Gets the GetSellerEventsRequestType.includeVariationSpecifics.
 java.lang.Boolean getIncludeWatchCount()
          Gets the GetSellerEventsRequestType.includeWatchCount.
 TimeFilter getModTimeFilter()
          Gets the GetSellerEventsRequestType.modTimeFilter.
 ItemType[] getReturnedSellerEvents()
          Valid after executing the API.
 ItemType[] getSellerEvents()
          Retrieves price changes, item revisions, description revisions, and other changes that have occurred within the last 48 hours related to a seller's eBay listings.
 TimeFilter getStartTimeFilter()
          Gets the GetSellerEventsRequestType.startTimeFilter.
 java.util.Calendar getTimeTo()
          Valid after executing the API.
 java.lang.String getUserID()
          Gets the GetSellerEventsRequestType.userID.
 void setEndTimeFilter(TimeFilter endTimeFilter)
          Sets the GetSellerEventsRequestType.endTimeFilter.
 void setHideVariations(java.lang.Boolean hideVariations)
          Sets the GetSellerEventsRequestType.hideVariations.
 void setIncludeNewItem(boolean includeNewItem)
          Sets the GetSellerEventsRequestType.includeNewItem.
 void setIncludeVariationSpecifics(java.lang.Boolean includeVariationSpecifics)
          Sets the GetSellerEventsRequestType.includeVariationSpecifics.
 void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
          Sets the GetSellerEventsRequestType.includeWatchCount.
 void setModTimeFilter(TimeFilter modTimeFilter)
          Sets the GetSellerEventsRequestType.modTimeFilter.
 void setStartTimeFilter(TimeFilter startTimeFilter)
          Sets the GetSellerEventsRequestType.startTimeFilter.
 void setUserID(java.lang.String userID)
          Sets the GetSellerEventsRequestType.userID.
 
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

GetSellerEventsCall

public GetSellerEventsCall()
Constructor.


GetSellerEventsCall

public GetSellerEventsCall(ApiContext apiContext)
Constructor.

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

getSellerEvents

public ItemType[] getSellerEvents()
                           throws ApiException,
                                  SdkException,
                                  java.lang.Exception
Retrieves price changes, item revisions, description revisions, and other changes that have occurred within the last 48 hours related to a seller's eBay listings.

Returns:
The ItemType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getEndTimeFilter

public TimeFilter getEndTimeFilter()
Gets the GetSellerEventsRequestType.endTimeFilter.

Returns:
TimeFilter

setEndTimeFilter

public void setEndTimeFilter(TimeFilter endTimeFilter)
Sets the GetSellerEventsRequestType.endTimeFilter.

Parameters:
endTimeFilter - TimeFilter

getHideVariations

public java.lang.Boolean getHideVariations()
Gets the GetSellerEventsRequestType.hideVariations.

Returns:
Boolean

setHideVariations

public void setHideVariations(java.lang.Boolean hideVariations)
Sets the GetSellerEventsRequestType.hideVariations.

Parameters:
hideVariations - Boolean

getIncludeNewItem

public boolean getIncludeNewItem()
Gets the GetSellerEventsRequestType.includeNewItem.

Returns:
boolean

setIncludeNewItem

public void setIncludeNewItem(boolean includeNewItem)
Sets the GetSellerEventsRequestType.includeNewItem.

Parameters:
includeNewItem - boolean

getIncludeVariationSpecifics

public java.lang.Boolean getIncludeVariationSpecifics()
Gets the GetSellerEventsRequestType.includeVariationSpecifics.

Returns:
Boolean

setIncludeVariationSpecifics

public void setIncludeVariationSpecifics(java.lang.Boolean includeVariationSpecifics)
Sets the GetSellerEventsRequestType.includeVariationSpecifics.

Parameters:
includeVariationSpecifics - Boolean

getIncludeWatchCount

public java.lang.Boolean getIncludeWatchCount()
Gets the GetSellerEventsRequestType.includeWatchCount.

Returns:
Boolean

setIncludeWatchCount

public void setIncludeWatchCount(java.lang.Boolean includeWatchCount)
Sets the GetSellerEventsRequestType.includeWatchCount.

Parameters:
includeWatchCount - Boolean

getModTimeFilter

public TimeFilter getModTimeFilter()
Gets the GetSellerEventsRequestType.modTimeFilter.

Returns:
TimeFilter

setModTimeFilter

public void setModTimeFilter(TimeFilter modTimeFilter)
Sets the GetSellerEventsRequestType.modTimeFilter.

Parameters:
modTimeFilter - TimeFilter

getStartTimeFilter

public TimeFilter getStartTimeFilter()
Gets the GetSellerEventsRequestType.startTimeFilter.

Returns:
TimeFilter

setStartTimeFilter

public void setStartTimeFilter(TimeFilter startTimeFilter)
Sets the GetSellerEventsRequestType.startTimeFilter.

Parameters:
startTimeFilter - TimeFilter

getUserID

public java.lang.String getUserID()
Gets the GetSellerEventsRequestType.userID.

Returns:
String

setUserID

public void setUserID(java.lang.String userID)
Sets the GetSellerEventsRequestType.userID.

Parameters:
userID - String

getReturnedSellerEvents

public ItemType[] getReturnedSellerEvents()
Valid after executing the API. Gets the returned GetSellerEventsResponseType.returnedSellerEvents.

Returns:
ItemType[]

getTimeTo

public java.util.Calendar getTimeTo()
Valid after executing the API. Gets the returned GetSellerEventsResponseType.timeTo.

Returns:
Calendar

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.